Skip to content

README documents a nonexistent agents-cli scaffold <name> creation command #77

Description

@benagentai93-dot

Baseline

5a306f8956cb1eeae69f9709de0e4d61b44e11e7 (v1.3.1)

Reproduction

  1. Check out the baseline commit.
  2. Read the CLI command tables in README.md.
  3. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions