Update module reload --home flag docs for dynamic VIAM_HOME - #5266
Open
Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Open
Update module reload --home flag docs for dynamic VIAM_HOME#5266Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Conversation
The CLI's --home flag on `viam module reload-local` changed behavior: it now queries the target machine for its VIAM_HOME directory via a shell service DoCommand, instead of defaulting to ~. The flag is now an override for when the query fails. - cli/reference.md: Update --home description and reload-local path - module-reference.md: Fix --home-dir typo to --home - write-a-driver-module.md: Fix troubleshooting tips for --home Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UeeUxjS46hfhDsAyxgky4J
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Source changes
--homeflag onviam module reload-localchanged behavior: it now queries the target machine for its VIAM_HOME directory via a shell service DoCommand, instead of defaulting to~. The flag is now an override for when the query fails or returns a wrong value. The usage text also changed.Docs changes
docs/cli/reference.md: Updated--homeflag description from "Specify home directory for a remote machine where$HOMEis not the default/root" to accurately describe the new behavior (CLI queries the machine for its VIAM_HOME;--homeis an override). Also updated thereload-localdescription to note that the destination path depends on the machine's Viam home directory rather than hardcoding~/.viam.docs/build-modules/module-reference.md: Fixed--home-dirtypo to--home(the actual flag name) and updated the description from "remote user's home directory" to "override the remote machine's home directory".docs/build-modules/write-a-driver-module.md: Updated troubleshooting tips that incorrectly described--homeas specifying the module directory. Now correctly describes--homeas an override for the machine's Viam home directory, and points to--modulefor the meta.json path issue.How I found these
cli-xref.mdpointed todocs/cli/reference.md--homeor--home-dirin the context of module reloadGenerated by daily docs change agent
Generated by Claude Code