Skip to content

docs: Add new docs page covering upgrade for Specify CLI #1135

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
wants to merge 5 commits into
base: main
Choose a base branch
from
+442 −3
Open

docs: Add new docs page covering upgrade for Specify CLI #1135

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
392dbf2
docs: Add comprehensive upgrading guide for Spec Kit
anchildress1 Nov 5, 2025
3c4081d
fix: remove broken link to existing project guide
anchildress1 Nov 6, 2025
57c54d3
docs: remove related documentation section from upgrading guide
anchildress1 Nov 6, 2025
d79d99f
docs: reorganize upgrade documentation structure
anchildress1 Nov 6, 2025
d471a6f
docs: fix broken link and improve agent reference
anchildress1 Nov 7, 2025
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ env/
*.swp
*.swo
.DS_Store
*.tmp

# Project specific
*.log
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ specify init <PROJECT_NAME>
specify check
```

To upgrade specify run:
To upgrade Specify, see the [Upgrade Guide](./docs/upgrade.md) for detailed instructions. Quick upgrade:

```bash
uv tool install specify-cli --force --from git+https://github.com/github/spec-kit.git
Expand Down Expand Up @@ -205,7 +205,7 @@ specify init --here --ai copilot

# Force merge into current (non-empty) directory without confirmation
specify init . --force --ai copilot
# or
# or
specify init --here --force --ai copilot

# Skip git initialization
Expand Down Expand Up @@ -550,7 +550,7 @@ This helps refine the implementation plan and helps you avoid potential blind sp
You can also ask Claude Code (if you have the [GitHub CLI](https://docs.github.com/en/github-cli/github-cli) installed) to go ahead and create a pull request from your current branch to `main` with a detailed description, to make sure that the effort is properly tracked.

>[!NOTE]
>Before you have the agent implement it, it's also worth prompting Claude Code to cross-check the details to see if there are any over-engineered pieces (remember - it can be over-eager). If over-engineered components or decisions exist, you can ask Claude Code to resolve them. Ensure that Claude Code follows the [constitution](base/memory/constitution.md) as the foundational piece that it must adhere to when establishing the plan.
>Before you have the agent implement it, it's also worth prompting Claude Code to cross-check the details to see if there are any over-engineered pieces (remember - it can be over-eager). If over-engineered components or decisions exist, you can ask Claude Code to resolve them. Ensure that Claude Code follows the [constitution](memory/constitution.md) as the foundational piece that it must adhere to when establishing the plan.
Copy link

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

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

The constitution file path should be .specify/memory/constitution.md for consistency with the rest of the documentation and the actual file structure. The path memory/constitution.md may work as a relative link from the repository root but is inconsistent with references elsewhere (e.g., line 383, 424, 485 in README.md and throughout upgrade.md).

Suggested change
>Before you have the agent implement it, it's also worth prompting Claude Code to cross-check the details to see if there are any over-engineered pieces (remember - it can be over-eager). If over-engineered components or decisions exist, you can ask Claude Code to resolve them. Ensure that Claude Code follows the [constitution](memory/constitution.md) as the foundational piece that it must adhere to when establishing the plan.
>Before you have the agent implement it, it's also worth prompting Claude Code to cross-check the details to see if there are any over-engineered pieces (remember - it can be over-eager). If over-engineered components or decisions exist, you can ask Claude Code to resolve them. Ensure that Claude Code follows the [constitution](.specify/memory/constitution.md) as the foundational piece that it must adhere to when establishing the plan.

Copilot uses AI. Check for mistakes.

### **STEP 6:** Generate task breakdown with /speckit.tasks

Expand Down
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Spec-Driven Development **flips the script** on traditional software development

- [Installation Guide](installation.md)
- [Quick Start Guide](quickstart.md)
- [Upgrade Guide](upgrade.md)
- [Local Development](local-development.md)

## Core Philosophy
Expand Down
3 changes: 2 additions & 1 deletion docs/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@
href: installation.md
- name: Quick Start
href: quickstart.md
- name: Upgrade
href: upgrade.md

# Development workflows
- name: Development
items:
- name: Local Development
href: local-development.md

Loading