Repository navigation
Update CLI reference for viam module lint-manifest - #5448
Merged
Eliza Farley (elizafarley) merged 2 commits intoOct 21, 2026
Merged
Conversation
rdk#6594 and rdk#6597, released in RDK v1.13.0, add an offline meta.json check and make module update and upload enforce the registry's short_description and machinePicker length limits before the RPC.
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Docs review: Ready to mergeAdds CI: All required checks passing Docs health: No regressions Nits
Verified against source (11 claims)
Automated review by Claude. Rerunning the review updates this comment. |
lint-manifest only checks module_id's namespace:name form, and upload checks the length limits only when a meta.json is present.
Collaborator
Author
|
Fixed in e284e24: Generated by Claude Code |
Eliza Farley (elizafarley)
approved these changes
Oct 21, 2026
Eliza Farley (elizafarley)
deleted the
claude/update-cli-module-lint-manifest
branch
October 21, 2026 14:49
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
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
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.

RDK v1.13.0 adds
viam module lint-manifest, an offlinemeta.jsoncheck, and makesmodule updateandmodule uploadenforce the registry's length limits locally. This PR adds the command to the CLI reference and the limits to "Upload validation".Source changes
git merge-base --is-ancestore29217fe1 and c19b2f3e6 against v1.13.0). Code checked at the v1.13.0 tag:cli/app.go(lint-manifest, flag--module, default./meta.json) andcli/module_registry.go(LintManifestAction,validateManifestLimits, limits 100, 60 and 256).Documents: no ticket key found (neither PR carries one).
Docs changes
docs/cli/reference.md:viam module lint-manifest [--module=<path to meta.json>]to themoduleusage block.module lint-manifestsection listing what the command checks: JSON parse, a validmodule_id,short_description≤ 100 bytes,machinePickerheading≤ 60 andsubheading≤ 256 bytes. It also says the command warns on a malformed modelapi, printsno problems found in <path>, and that passing doesn't guarantee an upload succeeds (the command's own usage text says this).upload(andupdate) now fail locally on those limits.The limits are in bytes because the CLI compares
len()of the Go string. The error text says "characters", andmodule-reference.mdsays "max 100 chars", which is the same for ASCII. I didn't changemodule-reference.md.How I found these
cli-xref.md→modulesubcommands →docs/cli/reference.md.lint-manifest,module validate(the name in the PR text),short_description,machinePicker,heading,100 charsacrossdocs/,static/,data/,layouts/.module-reference.mdalready states the limits; there are no other matches.Checks
prettier (repo-local 3.2.5), markdownlint, vale,
frontmatter_rules.pyandmake build-prodpass.Generated by daily docs change agent
Generated by Claude Code