|
| 1 | +# Command-Line Help for `movement-aptos` |
| 2 | + |
| 3 | +This document contains the help content for the `movement-aptos` command-line program. |
| 4 | + |
| 5 | +**Command Overview:** |
| 6 | + |
| 7 | +* [`movement-aptos`↴](#movement-aptos) |
| 8 | +* [`movement-aptos markdown`↴](#movement-aptos-markdown) |
| 9 | +* [`movement-aptos markdown generate`↴](#movement-aptos-markdown-generate) |
| 10 | +* [`movement-aptos markdown file`↴](#movement-aptos-markdown-file) |
| 11 | +* [`movement-aptos markdown print`↴](#movement-aptos-markdown-print) |
| 12 | +* [`movement-aptos markdown workspace`↴](#movement-aptos-markdown-workspace) |
| 13 | +* [`movement-aptos run`↴](#movement-aptos-run) |
| 14 | +* [`movement-aptos run where`↴](#movement-aptos-run-where) |
| 15 | +* [`movement-aptos run using`↴](#movement-aptos-run-using) |
| 16 | + |
| 17 | +## `movement-aptos` |
| 18 | + |
| 19 | +The `movement-to-aptos` CLI |
| 20 | + |
| 21 | +**Usage:** `movement-aptos [COMMAND]` |
| 22 | + |
| 23 | +###### **Subcommands:** |
| 24 | + |
| 25 | +* `markdown` — Generates markdown for the CLI |
| 26 | +* `run` — Run the movement |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | +## `movement-aptos markdown` |
| 31 | + |
| 32 | +Generates markdown for the CLI |
| 33 | + |
| 34 | +**Usage:** `movement-aptos markdown <COMMAND>` |
| 35 | + |
| 36 | +###### **Subcommands:** |
| 37 | + |
| 38 | +* `generate` — Generate and update the documentation |
| 39 | +* `file` — Print the documentation to a file (providing the file path) |
| 40 | +* `print` — Print the documentation in the shell |
| 41 | +* `workspace` — Generate the documentation for the workspace |
| 42 | + |
| 43 | + |
| 44 | + |
| 45 | +## `movement-aptos markdown generate` |
| 46 | + |
| 47 | +Generate and update the documentation |
| 48 | + |
| 49 | +**Usage:** `movement-aptos markdown generate [OPTIONS]` |
| 50 | + |
| 51 | +###### **Options:** |
| 52 | + |
| 53 | +* `--file <FILE>` — Override the default docs location |
| 54 | + |
| 55 | + |
| 56 | + |
| 57 | +## `movement-aptos markdown file` |
| 58 | + |
| 59 | +Print the documentation to a file (providing the file path) |
| 60 | + |
| 61 | +**Usage:** `movement-aptos markdown file --file <FILE>` |
| 62 | + |
| 63 | +###### **Options:** |
| 64 | + |
| 65 | +* `--file <FILE>` — the file to write out to |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +## `movement-aptos markdown print` |
| 70 | + |
| 71 | +Print the documentation in the shell |
| 72 | + |
| 73 | +**Usage:** `movement-aptos markdown print` |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | +## `movement-aptos markdown workspace` |
| 78 | + |
| 79 | +Generate the documentation for the workspace |
| 80 | + |
| 81 | +**Usage:** `movement-aptos markdown workspace --relative-path <RELATIVE_PATH>` |
| 82 | + |
| 83 | +###### **Options:** |
| 84 | + |
| 85 | +* `--relative-path <RELATIVE_PATH>` — The file to write out to, relative to the crate root |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | +## `movement-aptos run` |
| 90 | + |
| 91 | +Run the movement |
| 92 | + |
| 93 | +**Usage:** `movement-aptos run <COMMAND>` |
| 94 | + |
| 95 | +###### **Subcommands:** |
| 96 | + |
| 97 | +* `where` — Run run with all parameters passed explicitly as CLI flags. See Orfile documentation for more details: <https://github.com/movementlabsxyz/orfile> |
| 98 | +* `using` — Run run with parameters from environment variables, config files, and CLI flags. See Orfile documentation for more details: <https://github.com/movementlabsxyz/orfile> |
| 99 | + |
| 100 | + |
| 101 | + |
| 102 | +## `movement-aptos run where` |
| 103 | + |
| 104 | +Run run with all parameters passed explicitly as CLI flags. See Orfile documentation for more details: <https://github.com/movementlabsxyz/orfile> |
| 105 | + |
| 106 | +**Usage:** `movement-aptos run where [OPTIONS] --node-config <NODE_CONFIG>` |
| 107 | + |
| 108 | +###### **Options:** |
| 109 | + |
| 110 | +* `--node-config <NODE_CONFIG>` — The node config to use |
| 111 | +* `--log-file <LOG_FILE>` — The log file to use |
| 112 | + |
| 113 | + |
| 114 | + |
| 115 | +## `movement-aptos run using` |
| 116 | + |
| 117 | +Run run with parameters from environment variables, config files, and CLI flags. See Orfile documentation for more details: <https://github.com/movementlabsxyz/orfile> |
| 118 | + |
| 119 | +**Usage:** `movement-aptos run using [OPTIONS] [EXTRA_ARGS]...` |
| 120 | + |
| 121 | +###### **Arguments:** |
| 122 | + |
| 123 | +* `<EXTRA_ARGS>` — Extra arguments to be passed to the CLI |
| 124 | + |
| 125 | +###### **Options:** |
| 126 | + |
| 127 | +* `--config-path <CONFIG_PATH>` — Path to the config file for run |
| 128 | + |
| 129 | + |
| 130 | + |
| 131 | +<hr/> |
| 132 | + |
| 133 | +<small><i> |
| 134 | + This document was generated automatically by |
| 135 | + <a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>. |
| 136 | +</i></small> |
0 commit comments