docs(readme): fix command syntax for share and policy create - #368
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
Documentation-only changes align the README examples with the CLI usage contract (per help contract tests) and introduce no behavioral or API risk.
Pull request overview
Updates README.md CLI examples to match the actual argument parsing contract for rc share and rc admin policy create, preventing copy/paste failures for users following the docs.
Changes:
- Fixes
rc shareexample by removing the non-existentdownloadsubcommand and passing<PATH>directly. - Fixes
rc admin policy createexample by removing the unsupported--fileflag and using the required positional<POLICY_FILE>argument.
File summaries
| File | Description |
|---|---|
| README.md | Corrects two CLI command examples to align with documented/contracted CLI usage. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the 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.
Summary
Fixes incorrect CLI command syntax examples in
README.mdforrc shareandrc admin policy create.Problem Background & Root Cause
Users following the examples in
README.mdencountered argument parsing errors when executing the commands:rc admin policy create local/ readonly --file policy.jsonfailed witherror: unexpected argument '--file' found. The CLI command expects 3 positional arguments<ALIAS> <NAME> <POLICY_FILE>rather than a--fileflag.rc share download local/bucket/file.txt --expire 24hfailed witherror: unexpected argument 'local/bucket/file.txt' found. Therc sharecommand accepts<PATH>directly without adownloadsubcommand.Solution
README.mdline 133 torc share local/bucket/file.txt --expire 24h.README.mdline 171 torc admin policy create local/ readonly policy.json.Test Status & Validation
README.mdby parsing them directly against the compiledrcbinary (cargo run --bin rc -- ...).README.mdcommands.