👋 New to open source?
Thanks for considering contributing to Mutiny.
This issue is intentionally beginner-friendly.
If you get stuck, ask questions in the comments.
We're happy to help.
Context
README Commands is a high-level table. Full flags are discoverable via --help, but newcomers often want them written down once.
Goal
Document the real mutiny init / run / test flags (from --help) in README and/or a small docs/CLI.md.
Why it matters
Reduces “what does --no-hosted do?” friction and keeps install messaging honest (from source via uv, not PyPI yet).
Acceptance criteria
Suggested files
README.md (Commands section)
- Optional:
docs/CLI.md, docs/README.md
Out of scope
- Changing CLI behavior, adding flags, or claiming PyPI publish
Hints
- Run each
--help and copy names/defaults verbatim — do not invent flags.
- One short “when to use
--no-hosted” sentence helps more than a long prose page.
- Current Commands table already names a few flags; expand rather than duplicate the Quick start.
Difficulty
S · docs / DX · no code required
Docs
👋 New to open source?
Thanks for considering contributing to Mutiny.
This issue is intentionally beginner-friendly.
If you get stuck, ask questions in the comments.
We're happy to help.
Context
README Commands is a high-level table. Full flags are discoverable via
--help, but newcomers often want them written down once.Goal
Document the real
mutiny init/run/testflags (from--help) in README and/or a smalldocs/CLI.md.Why it matters
Reduces “what does
--no-hosteddo?” friction and keeps install messaging honest (from source viauv, not PyPI yet).Acceptance criteria
uv run mutiny {init,run,test} --help(at least--path,--force,--no-hosted,--hosted-url,--failed,--json,--no-reportif present)uv sync; no false PyPI claim)docs/CLI.md+ link fromdocs/README.md/ READMESuggested files
README.md(Commands section)docs/CLI.md,docs/README.mdOut of scope
Hints
--helpand copy names/defaults verbatim — do not invent flags.--no-hosted” sentence helps more than a long prose page.Difficulty
S · docs / DX · no code required
Docs