Skip to content

Document --annotation flag for viam module reload #5012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shannonbradshaw wants to merge 2 commits into
base: main
Choose a base branch
from
+16 −6
Open

Document --annotation flag for viam module reload #5012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5211500
Add --annotation flag to viam module reload docs
claude Apr 24, 2026
07a366b
Address Copilot review: add --module flag to reload and reload-local …
claude Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions docs/build-modules/module-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,14 +495,23 @@ are set to the target platform. See [Environment variables](#environment-variabl
| `viam module reload --part-id <id>` | Build in cloud; machine downloads the package directly. |
| `viam module restart --part-id <id>` | Restart a running module without rebuilding. |

`reload` flags: `--part-id` (target machine part), `--path` (root of git
repo to build), `--annotation` (text note describing the purpose of this
reload build), `--module` (path to `meta.json`), `--model-name` (add a
resource to config with this model triple), `--resource-name` (name the
resource instance), `--id` (module ID), `--cloud-config` (path to
`viam.json`, alternative to `--part-id`), `--workdir` (subdirectory
containing `meta.json`), `--local` (run entrypoint directly on localhost).

`reload-local` flags: `--part-id` (target machine part), `--no-build` (skip
build), `--local` (run entrypoint directly on localhost instead of bundling),
`--model-name` (add a resource to config with this model triple),
`--name` (name the added resource), `--resource-name` (name the resource
instance), `--id` (module ID, alternative to `--name`),
`--cloud-config` (path to `viam.json`, alternative to `--part-id`),
`--workdir` (subdirectory containing `meta.json`), `--home-dir` (remote
user's home directory), `--no-progress` (hide transfer progress).
`--module` (path to `meta.json`), `--model-name` (add a resource to config
with this model triple), `--name` (name the added resource),
`--resource-name` (name the resource instance), `--id` (module ID,
alternative to `--name`), `--cloud-config` (path to `viam.json`, alternative
to `--part-id`), `--workdir` (subdirectory containing `meta.json`),
`--home-dir` (remote user's home directory), `--no-progress` (hide transfer
progress).

## Environment variables

Expand Down
1 change: 1 addition & 0 deletions docs/cli/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -870,6 +870,7 @@ viam module local-app-testing --app-url http://localhost:3000
<!-- prettier-ignore -->
| Argument | Description | Applicable commands | Required? |
| -------- | ----------- | ------------------- | --------- |
| `--annotation` | A text note describing the purpose of this reload build. Stored alongside the reload metadata in the machine config. | `reload` | Optional |
| `--binary` | The module executable to run (binary or script). Must work on the OS or processor of the device. If omitted, the CLI uses the entrypoint defined in <file>meta.json</file>. | `update-models` | Optional |
| `--count` | Number of cloud builds to list, defaults to displaying all builds | `build list` | Optional |
| `--cloud-config` | The location of the <FILE>viam.json</FILE> file which contains the machine ID to lookup the part-id. Alternative to `--part-id`. Default: `/etc/viam.json` | `reload`, `reload-local`, `restart` | Optional |
Expand Down
Loading