You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: revert README and installation docs to match main
Do not mention PyPI in documentation until the first official PyPI
release has been published. This PR only adds the workflow and readme
metadata in pyproject.toml.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@@ -45,19 +45,13 @@ Spec-Driven Development **flips the script** on traditional software development
45
45
46
46
### 1. Install Specify CLI
47
47
48
-
Requires **[uv](https://docs.astral.sh/uv/)** ([install uv](https://github.com/github/spec-kit/blob/main/docs/install/uv.md)). Replace `vX.Y.Z` with the latest tag from [Releases](https://github.com/github/spec-kit/releases):
48
+
Requires **[uv](https://docs.astral.sh/uv/)** ([install uv](./docs/install/uv.md)). Replace `vX.Y.Z` with the latest tag from [Releases](https://github.com/github/spec-kit/releases):
Or install from [PyPI](https://pypi.org/project/specify-cli/) (once published for a new release):
55
-
56
-
```bash
57
-
uv tool install specify-cli@latest
58
-
```
59
-
60
-
See the [Installation Guide](https://github.com/github/spec-kit/blob/main/docs/installation.md) for alternative methods, verification, upgrade, and troubleshooting.
54
+
See the [Installation Guide](./docs/installation.md) for alternative methods, verification, upgrade, and troubleshooting.
To check for updates or upgrade the installed CLI, use the self-management commands. See the [Upgrade Guide](https://github.com/github/spec-kit/blob/main/docs/upgrade.md) for detailed scenarios and customization options.
63
+
To check for updates or upgrade the installed CLI, use the self-management commands. See the [Upgrade Guide](./docs/upgrade.md) for detailed scenarios and customization options.
70
64
71
65
```bash
72
66
# Check whether a newer release is available (read-only — does not modify anything)
@@ -126,13 +120,13 @@ Use **`/speckit.implement`** to execute all tasks and build your feature accordi
126
120
/speckit.implement
127
121
```
128
122
129
-
For detailed step-by-step instructions, see our [comprehensive guide](https://github.com/github/spec-kit/blob/main/spec-driven.md).
123
+
For detailed step-by-step instructions, see our [comprehensive guide](./spec-driven.md).
130
124
131
125
## 📽️ Video Overview
132
126
133
127
Want to see Spec Kit in action? Watch our [video overview](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)!
134
128
135
-
[](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)
129
+
[](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)
136
130
137
131
## 🌍 Community
138
132
@@ -316,7 +310,7 @@ Spec-Driven Development is a structured process that emphasizes:
316
310
For existing projects, keep Spec Kit tooling updates separate from feature
317
311
artifact evolution: refresh managed project files when upgrading, and update
318
312
`specs/` artifacts when intended behavior changes. The
319
-
[Evolving Specs guide](https://github.com/github/spec-kit/blob/main/docs/guides/evolving-specs.md) describes the
313
+
[Evolving Specs guide](./docs/guides/evolving-specs.md) describes the
320
314
recommended brownfield loop.
321
315
322
316
## 🎯 Experimental Goals
@@ -357,7 +351,7 @@ If you encounter issues with an agent, please open an issue so we can refine the
357
351
358
352
## 📖 Learn More
359
353
360
-
-**[Complete Spec-Driven Development Methodology](https://github.com/github/spec-kit/blob/main/spec-driven.md)** - Deep dive into the full process
354
+
-**[Complete Spec-Driven Development Methodology](./spec-driven.md)** - Deep dive into the full process

382
+

389
383
390
384
In an interactive terminal, you will be prompted to select the coding agent integration you are using. In non-interactive sessions, such as CI or piped runs, `specify init` defaults to GitHub Copilot unless you pass `--integration`. You can also proactively specify the integration directly in the terminal:
Go to the project folder and run your coding agent. In our example, we're using `claude`.
421
415
422
-

416
+

423
417
424
418
You will know that things are configured correctly if you see the `/speckit.constitution`, `/speckit.specify`, `/speckit.plan`, `/speckit.tasks`, and `/speckit.implement` commands available.
425
419
@@ -659,4 +653,4 @@ This project is heavily influenced by and based on the work and research of [Joh
659
653
660
654
## 📄 License
661
655
662
-
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](https://github.com/github/spec-kit/blob/main/LICENSE) file for the full terms.
656
+
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.
Copy file name to clipboardExpand all lines: docs/installation.md
+2-8Lines changed: 2 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,8 @@
10
10
11
11
## Installation
12
12
13
-
> [!NOTE]
14
-
> The `specify-cli` package will also be available on [PyPI](https://pypi.org/project/specify-cli/) once official publishing is enabled. Source installs from the GitHubrepository are always available immediately.
13
+
> [!IMPORTANT]
14
+
> The only official, maintained packages for Spec Kit come from the [github/spec-kit](https://github.com/github/spec-kit) GitHub repository. Any packages with the same name available on PyPI (e.g. `specify-cli` on pypi.org) are **not** affiliated with this project and are not maintained by the Spec Kit maintainers. For normal installs, use the GitHub-based commands shown below. For offline or air-gapped environments, locally built wheels created from this repository are also valid.
15
15
16
16
### Persistent Installation (Recommended)
17
17
@@ -24,12 +24,6 @@ Install once and use everywhere. Replace `vX.Y.Z` with a tag from [Releases](htt
0 commit comments