Baseline
5a306f8956cb1eeae69f9709de0e4d61b44e11e7 (v1.3.1)
Reproduction
- Check out the baseline commit.
- Open
docs/src/reference/from-agent-starter-pack.md.
- Follow the "Migrating an Existing Project" steps on Linux, or inspect which commands are read-only versus mutating.
Actual behavior
The guide makes sed -i '' the primary edit command. That syntax is specific to BSD/macOS sed and fails on common GNU/Linux environments. It then runs agents-cli info and describes migration as if it will happen implicitly, without an explicit preview and apply sequence.
Expected behavior
The primary flow should be portable and make mutation explicit:
agents-cli info reads the current state.
agents-cli scaffold upgrade --dry-run previews the migration.
agents-cli scaffold upgrade applies it.
Minimal fix
Tell users to rename the two TOML section headers in their editor, document the three commands above in order, and add a lightweight contract test that verifies the commands/flag exist and prevents the macOS-only sed command 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
docs/src/reference/from-agent-starter-pack.md.Actual behavior
The guide makes
sed -i ''the primary edit command. That syntax is specific to BSD/macOSsedand fails on common GNU/Linux environments. It then runsagents-cli infoand describes migration as if it will happen implicitly, without an explicit preview and apply sequence.Expected behavior
The primary flow should be portable and make mutation explicit:
agents-cli inforeads the current state.agents-cli scaffold upgrade --dry-runpreviews the migration.agents-cli scaffold upgradeapplies it.Minimal fix
Tell users to rename the two TOML section headers in their editor, document the three commands above in order, and add a lightweight contract test that verifies the commands/flag exist and prevents the macOS-only
sedcommand 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.