Skip to content

docs(cli): document missing CLI commands in README - #192

Open
alelpoan wants to merge 1 commit into
Squads-Protocol:mainfrom
alelpoan:docs/cli-add-missing-command-sections
Open

docs(cli): document missing CLI commands in README#192
alelpoan wants to merge 1 commit into
Squads-Protocol:mainfrom
alelpoan:docs/cli-add-missing-command-sections

Conversation

@alelpoan

Copy link
Copy Markdown

Problem

cli/README.md documents 9 of the 16 commands registered in main.rs.
The following 7 commands are fully implemented and callable but have no
documentation:

  • claim-rent
  • display-proposals
  • display-vault
  • initiate-transfer
  • initiate-batch-transfer
  • initiate-program-upgrade
  • program-config-init

Root Cause

main.rs registers 16 subcommands. README covers 9. The gap grew as new
commands were added without corresponding documentation updates.

Fix

cli/README.md

1. 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 .rs files.

2. Updated Table of Contents

Added anchor links for all 7 new sections.

Verification

  • All parameters verified against source .rs files in cli/src/command/
  • Command names verified against match arms in cli/src/main.rs
  • transfer_common.rs excluded — internal helper module, not a subcommand
  • No code changes — documentation only

@vercel

vercel Bot commented Jun 16, 2026

Copy link
Copy Markdown

@alelpoan is attempting to deploy a commit to the squads Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant