[On hold until RDK release] Document --from-source flag for module build start#5136
Open
Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Open
[On hold until RDK release] Document --from-source flag for module build start#5136Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Conversation
RDK #6057 adds a --from-source flag to `viam module build start` that packages local source and uploads it to the cloud builder, bypassing the need for a GitHub repo or git push. Also adds --path, --wait, and --no-progress flags for this mode. Updates four pages: - cli/reference.md: add new flags to the argument table - cli/build-and-deploy-modules.md: add --from-source example - build-modules/deploy-a-module.md: note that --from-source does not require a GitHub repo - build-modules/module-reference.md: update flags summary Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YFy4ubaHy4n3G9AXWJBi52
✅ 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
btshrewsbury-viam
changed the title
Collaborator
|
🛑 Holding this until an RDK release ships The content is accurate — I verified every flag (
So users on the current stable CLI who run |
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
4 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.
Warning
On hold until an RDK release.
--from-sourcemerged tordkmainon 2026-07-01 (viamrobotics/rdk#6057) but is not yet in a releasedviamCLI — the latest release is v0.132.0 (2026-06-23), which predates the merge and does not contain the flag. Merging now would document a flag users on the current stable CLI cannot run. Hold until the flag ships in an RDK release (expected v0.133.0).RDK #6057 adds a
--from-sourceflag toviam module build startthat packages local source and uploads it to the cloud builder. This bypasses the need for a GitHub repo or git push, making it easier to iterate during development.New flags in
--from-sourcemode:--from-source: enable source upload mode--path: path to the local source directory (default:.)--wait: wait for the build to finish and surface failure logs--no-progress: hide the progress spinnerSource changes
Docs changes
docs/cli/reference.md: Added--from-source,--path,--wait,--no-progressflags to themodule build startargument table. Added example command.docs/cli/build-and-deploy-modules.md: Added--from-sourceexample to the Cloud builds section.docs/build-modules/deploy-a-module.md: Updated the cloud build intro to note that--from-sourcedoes not require a GitHub repo.docs/build-modules/module-reference.md: Updated thebuild startflags summary to include the new flags.How I found these
cli-xref.mdmapsrdk/cli/changes to CLI docsmodule build start,--ref,cloud buildacross entire docs repo; found 14 files referencing cloud builds, updated the 4 that describebuild startflags or behaviorGenerated by daily docs change agent
Generated by Claude Code