Skip to content

docs(cli): advertise built-in per-command help#95

Open
barry166 wants to merge 1 commit into
agentctxhq:mainfrom
barry166:fix/issue-85-help-footer
Open

docs(cli): advertise built-in per-command help#95
barry166 wants to merge 1 commit into
agentctxhq:mainfrom
barry166:fix/issue-85-help-footer

Conversation

@barry166

Copy link
Copy Markdown
Contributor

Summary

  • update the top-level CLI help footer to point users at agentctx <command> --help
  • keep the docs URL as a secondary reference instead of the only discovery path
  • add a dispatch-level regression test for the new footer text

Related Issues

Closes #85

Type of Change

  • Bug fix
  • New feature
  • Refactor
  • Docs / chore

How Has This Been Tested?

  • npm test --workspace @agentctxhq/agentctx
  • npm run typecheck --workspace @agentctxhq/agentctx
  • npm run build --workspace @agentctxhq/agentctx
  • npm run lint

Disclosure

  • AI-assisted: yes
  • Human reviewed: yes

Checklist

  • My code builds and runs locally without errors
  • I have added or updated tests where applicable
  • I have updated relevant documentation
  • I have read CONTRIBUTING.md and my contribution aligns with its guidelines.

Issue agentctxhq#85 pointed out that the top-level help footer sent users to the docs even though every command already supports local --help output. This updates the footer to promote built-in per-command help first, keeps the docs link as secondary reference, and adds a dispatch-level test for the new wording.\n\nConstraint: Keep this a help-text-only change with no command behavior changes\nRejected: Expand the footer into a longer usage section | unnecessary for the narrowly scoped issue\nConfidence: high\nScope-risk: narrow\nReversibility: clean\nDirective: Keep top-level help text aligned with actual command discovery paths when adding or changing CLI commands\nTested: npm test --workspace @agentctxhq/agentctx; npm run typecheck --workspace @agentctxhq/agentctx; npm run build --workspace @agentctxhq/agentctx; npm run lint\nNot-tested: Installed global CLI output outside the workspace
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Top-level agentctx --help sends users to the docs URL for per-command help, but every command already supports --help

1 participant