Skip to content

docs: add core commands reference and simplify README CLI section#2245

Merged
mnriem merged 3 commits intogithub:mainfrom
mnriem:docs/add-core-reference-and-simplify-readme
Apr 16, 2026
Merged

docs: add core commands reference and simplify README CLI section#2245
mnriem merged 3 commits intogithub:mainfrom
mnriem:docs/add-core-reference-and-simplify-readme

Conversation

@mnriem
Copy link
Copy Markdown
Collaborator

@mnriem mnriem commented Apr 16, 2026

Adds a core commands reference page and simplifies the README by moving CLI reference details to the docs site.

Changes

  • New docs/reference/core.md — reference for init (active options only, no deprecated flags), check, and version commands with copilot as the consistent example
  • docs/toc.yml — added Core Commands under Reference section
  • README.md — replaced the verbose CLI Reference section (init options table with deprecated flags, 30+ per-agent examples, environment variables) with a concise list of links to the five reference docs; uses copilot as the main example throughout

Motivation

The README had accumulated a large CLI Reference section with deprecated options (--skip-tls, --debug, --github-token), legacy --ai flag examples for every agent, and content that duplicated what's now in the reference docs. Since the quickstart section already covers getting started, the CLI Reference section only needs to point users to the canonical reference documentation.

This completes the reference documentation reorganization started in #2241, #2242, #2243, and #2244.

- New docs/reference/core.md: reference for init (active options only,
  copilot as main example), check, and version commands
- docs/toc.yml: add Core Commands under Reference
- README.md: replace verbose CLI Reference section (init options table,
  30+ per-agent examples, deprecated flags, env vars) with links to
  reference docs; use copilot as main example throughout
Copilot AI review requested due to automatic review settings April 16, 2026 18:48
mnriem added 2 commits April 16, 2026 13:49
- New docs/reference/overview.md: explains each CLI surface area
  (core, integrations, extensions, presets, workflows) with key
  commands and links to detailed reference pages
- docs/toc.yml: add Overview as first item under Reference
- README.md: simplify CLI Reference to single link to overview page
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new “Core Commands” reference doc and trims the README’s CLI reference section down to links to the docs site.

Changes:

  • Added docs/reference/core.md documenting specify init, specify check, and specify version/--version.
  • Updated docs/toc.yml to include the new Core Commands page under Reference.
  • Simplified README.md by replacing the long CLI reference section with links to the docs site.
Show a summary per file
File Description
docs/toc.yml Adds “Core Commands” entry under the Reference section.
docs/reference/core.md New reference page for core CLI commands and key options.
README.md Removes verbose CLI reference and replaces with links; updates examples to use copilot.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (3)

README.md:523

  • These detailed-process examples still document --ai, which is deprecated in the CLI and emits a warning. Consider switching this whole block to --integration ... to keep the walkthrough aligned with the current command surface.

# Force merge into a non-empty current directory
specify init . --force --ai copilot

# or
specify init --here --force --ai copilot

The CLI will check if you have Claude Code, Gemini CLI, Cursor CLI, Qwen CLI, opencode, Codex CLI, Qoder CLI, Tabnine CLI, Kiro CLI, Pi, Forge, Goose, or Mistral Vibe installed. If you do not, or you prefer to get the templates without checking for the right tools, use --ignore-agent-tools with your command:

specify init <project_name> --ai copilot --ignore-agent-tools

README.md:529

  • This example uses deprecated --ai; prefer --integration copilot --ignore-agent-tools for consistency with the new reference docs and to avoid recommending a flag planned for removal.
    README.md:105
  • Same issue here: this uvx ... specify init example uses deprecated --ai. Prefer --integration copilot to match the reference docs and avoid showing a flag slated for removal.
uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init . --ai copilot
# or
uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init --here --ai copilot
  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment thread README.md
Comment thread README.md
@mnriem mnriem merged commit 697daec into github:main Apr 16, 2026
11 checks passed
@mnriem mnriem deleted the docs/add-core-reference-and-simplify-readme branch April 16, 2026 18:54
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.

2 participants