docs(cli): document missing CLI commands in README - #192
Open
alelpoan wants to merge 1 commit into
Open
Conversation
|
@alelpoan is attempting to deploy a commit to the squads Team on Vercel. A member of the Team first needs to authorize it. |
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.
Problem
cli/README.mddocuments 9 of the 16 commands registered inmain.rs.The following 7 commands are fully implemented and callable but have no
documentation:
claim-rentdisplay-proposalsdisplay-vaultinitiate-transferinitiate-batch-transferinitiate-program-upgradeprogram-config-initRoot Cause
main.rsregisters 16 subcommands. README covers 9. The gap grew as newcommands were added without corresponding documentation updates.
Fix
cli/README.md1. Added 7 missing command sections
Each section follows the existing format (Description → Syntax → Parameters
→ Example Usage). Parameters extracted directly from
#[derive(Args)]structs in the corresponding
.rsfiles.2. Updated Table of Contents
Added anchor links for all 7 new sections.
Verification
.rsfiles incli/src/command/matcharms incli/src/main.rstransfer_common.rsexcluded — internal helper module, not a subcommand