From a854f507610816f94984a092a9270fea9b35d679 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Fri, 24 Jan 2025 15:52:18 -0800 Subject: [PATCH 1/3] DOCS-3403: Add necessary args to module reload CLI doc --- docs/dev/tools/cli.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/dev/tools/cli.md b/docs/dev/tools/cli.md index f539f02d39..2f1ae3323a 100644 --- a/docs/dev/tools/cli.md +++ b/docs/dev/tools/cli.md @@ -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 | From cb9595ed836141610de80293c549b40e252f24c7 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Fri, 24 Jan 2025 15:54:43 -0800 Subject: [PATCH 2/3] fix punctuation --- docs/dev/tools/cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dev/tools/cli.md b/docs/dev/tools/cli.md index 2f1ae3323a..a42ae10eb5 100644 --- a/docs/dev/tools/cli.md +++ b/docs/dev/tools/cli.md @@ -717,7 +717,7 @@ viam module upload --version=1.0.0 --platform=darwin/arm64 packaged-module.tar.g | `--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 | | `--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 | +| `--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 | From 8226fa3f1185325232893f3c33e8cf76e5302a4d Mon Sep 17 00:00:00 2001 From: JessamyT <75634662+JessamyT@users.noreply.github.com> Date: Mon, 27 Jan 2025 09:07:54 -0800 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> --- docs/dev/tools/cli.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/dev/tools/cli.md b/docs/dev/tools/cli.md index a42ae10eb5..086757ec94 100644 --- a/docs/dev/tools/cli.md +++ b/docs/dev/tools/cli.md @@ -716,9 +716,9 @@ 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 | -| `--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 | +| `--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 |