Skip to content

Clarify CLI reference usage in README #2001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ArthurFay wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

Clarify CLI reference usage in README #2001

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ Community projects that extend, visualize, or build on Spec Kit:
## 🔧 Specify CLI Reference

The `specify` command supports the following options:
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

Markdown collapses single newlines into one paragraph, so this renders as: “The specify command supports the following options: The examples below assume…”, which reads like a run-on sentence due to the colon. Consider inserting a blank line and/or changing the colon to a period so the installation assumption is a separate paragraph.

Suggested change
The `specify` command supports the following options:
The `specify` command supports the following options.

Copilot uses AI. Check for mistakes.

The examples below assume you used the persistent installation method from the Get Started section, so the `specify` command is available directly in your PATH. If you are using the one-time usage method instead, run the equivalent commands with `uvx --from git+https://github.com/github/[email protected] specify ...`.
### Commands

| Command | Description |
Expand All @@ -314,7 +314,7 @@ The `specify` command supports the following options:
| `--branch-numbering` | Option | Branch numbering strategy: `sequential` (default — `001`, `002`, `003`) or `timestamp` (`YYYYMMDD-HHMMSS`). Timestamp mode is useful for distributed teams to avoid numbering conflicts |

### Examples

Examples below use the persistent installation form. If you did not install the CLI persistently, use the `uvx --from git+https://github.com/github/[email protected] specify ...` form instead.
```bash
# Basic project initialization
specify init my-project
Expand Down
Loading