Skip to content

Commit 8d613ac

Browse files
docs: address code review feedback - fix 5 issues from PR github#2190
1 parent c120240 commit 8d613ac

2 files changed

Lines changed: 16 additions & 19 deletions

File tree

docs/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Note: Do NOT change or implement this spec; only return the spec text focusing o
5757

5858
### 3. Create a Technical Implementation Plan
5959

60-
Use the plan command to provide your tech stack and architecture choices.
60+
Use the `/speckit.plan` slash command (in an AI assistant or editor that supports slash commands) to provide your tech stack and architecture choices.
6161

6262
```text
6363
/speckit.plan The application uses Vite with minimal number of libraries. Use vanilla HTML, CSS, and JavaScript as much as possible. Images are not uploaded anywhere and metadata is stored in a local SQLite database.
@@ -170,7 +170,7 @@ to be doing that are obvious from reading this. Because I don't know if there's
170170
Generate the implementation:
171171

172172
```text
173-
/speckit.implement specs/002-create-taskify/plan.md
173+
/speckit.implement
174174
```
175175

176176
## Key Principles

docs/vscode-usage.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33,34 +33,31 @@ After launching VS Code you may still need to follow the sign-in flow the first
3333

3434
The Copilot Chat input is a conversational interface only — it does not run shell/CLI commands on your machine. To actually run `specify` (or any other CLI command supplied by this repo), use the VS Code integrated terminal:
3535

36-
1. Open the integrated terminal (View > Terminal or Ctrl+`).
36+
1. Open the integrated terminal (View > Terminal or Ctrl+\`).
3737
2. Make sure you're in the project folder (the same folder that contains the repository files).
38-
3. Activate your Python environment and install the project if needed (example using a virtual environment):
38+
3. Install and run the CLI (examples using uvx - the recommended way, or use uv for persistent installation):
3939

4040
```powershell
41-
# create a venv (first time)
42-
python -m venv .venv
41+
# Run once with uvx (no installation needed)
42+
uvx --from git+https://github.com/github/spec-kit.git specify --help
4343
44-
# allow script execution for the current session if required (temporary)
45-
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process
46-
47-
# activate the venv
48-
.\.venv\Scripts\Activate.ps1
49-
50-
# install the project in editable mode (if the project exposes a CLI entrypoint)
51-
pip install -e .
52-
53-
# run the CLI (example)
44+
# Or install persistently with uv (recommended)
45+
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
5446
specify --help
5547
```
5648

57-
If the project exposes a console script named `specify`, the last command will run it. If not, you can often run a module directly:
49+
To run the CLI from the source repository without installation:
5850

5951
```powershell
60-
python -m specify_cli --help
52+
cd /path/to/spec-kit
53+
uvx --from . specify --help
6154
```
6255

63-
Replace `specify_cli` above with the actual module name or entrypoint if different.
56+
Or directly via the module:
57+
58+
```powershell
59+
python -m src.specify_cli --help
60+
```
6461

6562
### Where to run commands: Terminal vs AI Assistant
6663

0 commit comments

Comments
 (0)