Skip to content

Commit

Permalink
DOCS-3403: Add necessary args to module reload CLI doc (#3914)
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT authored Jan 27, 2025
1 parent 66cd9cb commit 32ff298
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/dev/tools/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -716,8 +716,11 @@ viam module upload --version=1.0.0 --platform=darwin/arm64 packaged-module.tar.g
| `--binary` | The binary for the module to run. The binary has to work on the OS or processor of the device. | `update-models` | **Required** |
| `--count` | Number of cloud builds to list, defaults to displaying all builds | `build list` | Optional |
| `--force` | Skip local validation of the packaged module, which may result in an unusable module if the contents of the packaged module are not correct | `upload` | Optional |
| `--id` | The build ID to list or show logs for, as returned from `build start` | `build list`, `build logs` | Optional |
| `--home` | Specify home directory for a remote machine where `$HOME` is not the default `/root`. | `reload` | Optional |
| `--id` | The build ID to list or show logs for, as returned from `build start`. | `build list`, `build logs`, `reload` | Optional |
| `--local` | Use if the target machine is localhost, to run the entrypoint directly rather than transferring a bundle. | `reload` | Optional |
| `--module` | The path to the [`meta.json` file](#the-metajson-file) for the custom module, if not in the current directory | `update`, `upload`, `build` | Optional |
| `--part-id` | Part ID of the machine part. Required if running on a remote device. | `reload` | Optional |
| `--resource-subtype` | The API to implement with the modular resource. For example, `motor`. We recommend _not_ using this option and instead following the prompts after running the command. | `generate` | Optional |
| `--resource-type` | Whether the new resource is a component or a service. For example, `component`. We recommend _not_ using this option and instead following the prompts. | `generate` | Optional |
| `--local-only` | Create a meta.json file for local use, but don't create the module on the backend (default: `false`). | `create` | Optional |
Expand Down

0 comments on commit 32ff298

Please sign in to comment.