Skip to content

Commit 6f392eb

Browse files
authored
RSDK-12430 - documentation fixes (viamrobotics#5685)
1 parent c82312f commit 6f392eb

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

cli/app.go

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3527,7 +3527,10 @@ This won't work unless you have an existing installation of our GitHub app on yo
35273527
# Specify a component/service model (and optionally a name) to add to the config along with
35283528
# the module (the API is automatically looked up from meta.json)
35293529
# By default, no resources are added when a module is reloaded
3530-
viam module reload --model-name acme:module-name:mybase --name my-resource`,
3530+
viam module reload --model-name acme:module-name:mybase --name my-resource
3531+
3532+
# Trigger a reload build of a module located in a different directory than the current workdir
3533+
viam module reload --module-name part-id UUID --path /path/to/module/dir/`,
35313534
Flags: []cli.Flag{
35323535
&cli.StringFlag{
35333536
Name: generalFlagPartID,
@@ -3536,7 +3539,7 @@ This won't work unless you have an existing installation of our GitHub app on yo
35363539
},
35373540
&cli.StringFlag{
35383541
Name: moduleFlagPath,
3539-
Usage: "path to a meta.json. used for module ID. can be overridden with --id or --name",
3542+
Usage: "relative path to a meta.json from workdir (default: ./). used for module ID. can be overridden with --id or --name",
35403543
Value: "meta.json",
35413544
},
35423545
&cli.BoolFlag{
@@ -3574,7 +3577,7 @@ This won't work unless you have an existing installation of our GitHub app on yo
35743577
},
35753578
&cli.StringFlag{
35763579
Name: generalFlagPath,
3577-
Usage: "The path to the root of the git repo to build",
3580+
Usage: "The path to the root of the module's git repo to build",
35783581
DefaultText: ".",
35793582
},
35803583
},

0 commit comments

Comments
 (0)