docs: add core commands reference and simplify README CLI section#2245
Merged
mnriem merged 3 commits intogithub:mainfrom Apr 16, 2026
Merged
Conversation
- 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
- 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
Contributor
There was a problem hiding this comment.
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.mddocumentingspecify init,specify check, andspecify version/--version. - Updated
docs/toc.ymlto include the new Core Commands page under Reference. - Simplified
README.mdby 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-toolsREADME.md:529
- This example uses deprecated
--ai; prefer--integration copilot --ignore-agent-toolsfor consistency with the new reference docs and to avoid recommending a flag planned for removal.
README.md:105 - Same issue here: this
uvx ... specify initexample uses deprecated--ai. Prefer--integration copilotto 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a core commands reference page and simplifies the README by moving CLI reference details to the docs site.
Changes
docs/reference/core.md— reference forinit(active options only, no deprecated flags),check, andversioncommands withcopilotas the consistent exampledocs/toc.yml— added Core Commands under Reference sectionREADME.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; usescopilotas the main example throughoutMotivation
The README had accumulated a large CLI Reference section with deprecated options (
--skip-tls,--debug,--github-token), legacy--aiflag 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.