From 521150089db4db75f7fdb0c266dbd6179a5e8469 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 24 Apr 2026 09:17:45 +0000 Subject: [PATCH 1/2] Add --annotation flag to viam module reload docs The reload command gained an --annotation flag (rdk#5951, app#11729) that lets users describe the purpose of a reload build. The annotation is stored alongside the reload metadata in the machine config. https://claude.ai/code/session_01LW3uGKyHAqLD9xsZYQ296m --- docs/build-modules/module-reference.md | 8 ++++++++ docs/cli/reference.md | 1 + 2 files changed, 9 insertions(+) diff --git a/docs/build-modules/module-reference.md b/docs/build-modules/module-reference.md index 317a88294d..b181a7c364 100644 --- a/docs/build-modules/module-reference.md +++ b/docs/build-modules/module-reference.md @@ -495,6 +495,14 @@ are set to the target platform. See [Environment variables](#environment-variabl | `viam module reload --part-id ` | Build in cloud; machine downloads the package directly. | | `viam module restart --part-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), `--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), diff --git a/docs/cli/reference.md b/docs/cli/reference.md index b5da1175ff..3ec1ad9e12 100644 --- a/docs/cli/reference.md +++ b/docs/cli/reference.md @@ -870,6 +870,7 @@ viam module local-app-testing --app-url http://localhost:3000 | 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 meta.json. | `update-models` | Optional | | `--count` | Number of cloud builds to list, defaults to displaying all builds | `build list` | Optional | | `--cloud-config` | The location of the viam.json file which contains the machine ID to lookup the part-id. Alternative to `--part-id`. Default: `/etc/viam.json` | `reload`, `reload-local`, `restart` | Optional | From 07a366b9e3ec5f4f62cc2b104588973b73dfefc4 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 24 Apr 2026 09:23:03 +0000 Subject: [PATCH 2/2] Address Copilot review: add --module flag to reload and reload-local listings https://claude.ai/code/session_01LW3uGKyHAqLD9xsZYQ296m --- docs/build-modules/module-reference.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/build-modules/module-reference.md b/docs/build-modules/module-reference.md index b181a7c364..e1ca6edaac 100644 --- a/docs/build-modules/module-reference.md +++ b/docs/build-modules/module-reference.md @@ -497,20 +497,21 @@ are set to the target platform. See [Environment variables](#environment-variabl `reload` flags: `--part-id` (target machine part), `--path` (root of git repo to build), `--annotation` (text note describing the purpose of this -reload build), `--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 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