Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

`docs/reference/cli.md` omits five commands, one subcommand, and several flags

Open
  • Is something wrong?
#331 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
cli, documentation

Research direction

Start with docs/reference/cli.md and compare its Command Tree and command sections against the binary help output listed in the issue, especially sdkt fuzz campaign --help and sdkt fuzz replay --help. Read docs/reference/fuzz-real-contract-evidence.md for the evidence link, and check docs/reference/SUMMARY.md and gitbook-docs.yaml for consistency. Done when the documented commands, subcommands, flags, formats, artifact layout, and exit codes match the verified CLI output.

Written by the indexing model from the issue text.

Description

area:sdkt-cli documentation

Context

docs/reference/cli.md is the CLI command reference. Its Command Tree is the reader's map of what sdkt can do, and it is what the docs harness publishes to GitBook. It has drifted behind the CLI: whole command families and recently-added flags are missing, and the fuzz family — the project's release-assurance fuzzing pipeline — has no coverage in the file at all.

Problem

Verified against origin/main (5f6e7c8b) by diffing sdkt --help output (binary built from that commit) against the file.

Commands present in the CLI but absent from the Command Tree:

Command In CLI --help In docs/reference/cli.md tree
encode yes (has its own ## Encode section) absent from tree
plugin yes (has ## Plugin management) absent from tree
doctor yes (has ## Doctor) absent from tree
completions yes (has ## Shell completions) absent from tree
fuzz yes, with campaign + replay absent entirely — 0 mentions in the file

Subcommand and flag drift inside commands that are in the tree:

$ sdkt tx --help
Commands:
  inspect
  validate
  decode        <- not in the tree
  simulate
  submit
  build
  sign

$ sdkt audit --help
      --abi <WASM>                 <- not in the tree
      --abi-contract <CONTRACT_ID> <- not in the tree
      --network-profile <NAME>     <- not in the tree
      --rpc-url <URL>              <- not in the tree
      --network-passphrase <PASS>  <- not in the tree

$ sdkt release-assurance --help
      --fuzz-evidence <EVIDENCE_JSON>  <- not in the tree
      --network-profile <NAME>         <- not in the tree
      --rpc-url <URL>                  <- not in the tree
      --network-passphrase <PASS>      <- not in the tree

$ sdkt events --help
      --start-ledger <START_LEDGER>  <- not in the tree
      --end-ledger <END_LEDGER>      <- not in the tree
      --topic <SYMBOL>               <- not in the tree

docs/reference/SUMMARY.md already links a Real-Contract Fuzz Evidence page, so the docs set acknowledges fuzzing while the CLI reference never names the command.

Contributor Task

  1. Add the five missing commands to the Command Tree with their subcommands and flags, matching the level of detail the tree already uses for other families.
  2. Add the missing subcommands and flags listed above to their existing tree entries.
  3. Add a ## Fuzz section documenting sdkt fuzz campaign and sdkt fuzz replay: the flags each accepts, the --expect-success / --expect-error declaration syntax, the artifact directory layout, the --format values, and the exit-code convention. Link to docs/reference/fuzz-real-contract-evidence.md for the pipeline's evidence.
  4. State the exit-code convention for fuzz replay as it is implemented, and if it contradicts the CLI-wide rule (0 success / 1 runtime / 2 usage), note the discrepancy rather than documenting an aspiration.

Deliverables

  • Updated docs/reference/cli.md with the complete Command Tree, the new ## Fuzz section, and the missing flags on existing entries.
  • docs/reference/SUMMARY.md and gitbook-docs.yaml kept consistent with the file's sections.

Dependencies

None.

Acceptance Criteria

  • Every top-level command in sdkt --help appears in the Command Tree.
  • Every subcommand and every flag of the covered commands appears, or the omission is deliberate and explained in the file.
  • A ## Fuzz section exists and documents both fuzz subcommands, their flags, and their exit codes.
  • The file contains no reference to a command or flag that the CLI does not accept.
  • docs/reference/SUMMARY.md and gitbook-docs.yaml stay consistent with the file's sections.

Verification

cargo build --bin sdkt
./target/debug/sdkt --help
./target/debug/sdkt fuzz --help
./target/debug/sdkt fuzz campaign --help
./target/debug/sdkt fuzz replay --help
./target/debug/sdkt tx --help
./target/debug/sdkt audit --help
./target/debug/sdkt release-assurance --help
./target/debug/sdkt events --help
# then diff each flag against docs/reference/cli.md

Proof of Completion

  • The PR includes a side-by-side diff of the Command Tree before and after.
  • The PR description lists every command, subcommand, and flag that was added.

Out of Scope

  • Changing CLI behaviour to match the docs.
  • Restructuring the file or renaming sections.

Non-negotiable Constraints

  • Documentation only: no change to the CLI.
  • Every command and flag in the updated file must be verified against the binary's --help output.

PR Requirements

  • One PR covering the tree, the flags, and the ## Fuzz section.
  • cargo test --workspace passes (no code change, but the docs harness may have assertions).
Dominant language
Rust
Stars
5
Forks
84
Avg merge
18h 14m
Merged PRs (30d)
103

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SaboLabs/soroban-devkit

All issues in SaboLabs/soroban-devkit

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.