Baseline
5a306f8956cb1eeae69f9709de0e4d61b44e11e7 (v1.3.1)
Reproduction
- Check out the baseline commit.
- Read the CLI command tables in
README.md.
- Run
agents-cli scaffold --help and agents-cli create --help.
Actual behavior
The README tells users to create a project with agents-cli scaffold <name> in two places. scaffold is a command group and does not accept a project name in that form; the project-creation command is agents-cli create <name>.
Expected behavior
Both command tables should document the real create command so the first command copied by a new user is runnable.
Minimal fix
Replace the two incorrect README rows and add a lightweight contract test that checks the documented command has --help and prevents scaffold <name> from returning.
Tested fix:
Verification
- Documentation contract tests: 7 passed
- Full test suite: 99 passed
ruff check src tests: passed
ty check src: passed
uv build: passed
- Built wheel installed normally;
agents-cli --version returned 1.3.1 on Python 3.11 and 3.13
I am not opening a PR because the upstream repository currently does not accept PRs.
Baseline
5a306f8956cb1eeae69f9709de0e4d61b44e11e7(v1.3.1)Reproduction
README.md.agents-cli scaffold --helpandagents-cli create --help.Actual behavior
The README tells users to create a project with
agents-cli scaffold <name>in two places.scaffoldis a command group and does not accept a project name in that form; the project-creation command isagents-cli create <name>.Expected behavior
Both command tables should document the real
createcommand so the first command copied by a new user is runnable.Minimal fix
Replace the two incorrect README rows and add a lightweight contract test that checks the documented command has
--helpand preventsscaffold <name>from returning.Tested fix:
Verification
ruff check src tests: passedty check src: passeduv build: passedagents-cli --versionreturned1.3.1on Python 3.11 and 3.13I am not opening a PR because the upstream repository currently does not accept PRs.