External/spec-kit
1
0
Fork 0
mirror of https://github.com/github/spec-kit.git synced 2026-08-15 14:02:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: document installing specify-cli from a custom package index (#4032)

Browse Source 
* docs: document installing specify-cli from a custom package index

Add a generic section to the PyPI install guide covering how to point
uv, pipx, and pip at a non-default package index (env var and flags),
with a placeholder URL, plus notes on pins/upgrades and authentication.
Link to it from the main installation guide.

Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: d6ef3f75-54e9-4789-902b-4f0adeaadfad

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot-Session: d6ef3f75-54e9-4789-902b-4f0adeaadfad
This commit is contained in:
Manfred Riem
2026-08-10 08:15:14 -05:00
committed by GitHub
co-authored by Copilot App Copilot Autofix powered by AI
parent 684b3d8e05
commit d751231468
2 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/install/pypi.md
+21
View File
@@ -35,6 +35,27 @@ pipx install specify-cli==0.12.11
pip install specify-cli==0.12.11
```
## Install from a custom or private package index
Some environments (corporate networks, mirrors, proxies, or artifact feeds) require installing `specify-cli` from a package index other than the default public PyPI. Each Python tool exposes a way to point at a different index — configure it before running the install commands above. Substitute your own index URL for the placeholder shown here.
```bash
# uv — via environment variable (applies to the whole command)
UV_DEFAULT_INDEX=https://your-index.example.com/pypi/simple/ uv tool install specify-cli
# uv — via flag
uv tool install --default-index https://your-index.example.com/pypi/simple/ specify-cli
# pipx — pass a pip argument through
pipx install specify-cli --index-url https://your-index.example.com/pypi/simple/
# pip
pip install specify-cli --index-url https://your-index.example.com/pypi/simple/
```
> [!NOTE]
> The same index configuration applies to pinned installs, upgrades (`--force`/`--upgrade`), and one-time usage — set the environment variable or flag on those commands too. If your index requires authentication, follow your tool's documentation and prefer credential environment variables, keyring, or netrc; do not embed secrets in command-line URLs because they can leak through shell history, process listings, or logs. Avoid committing secrets. For fully offline installs, see the [air-gapped installation guide](air-gapped.md).
## Verify
```bash
docs/installation.md
+1 -1
View File
@@ -50,7 +50,7 @@ pipx install specify-cli
pip install specify-cli
```
To install a specific release, pin the version — for example `uv tool install specify-cli==0.12.11`. See the [PyPI installation guide](install/pypi.md) for details, including how to upgrade.
To install a specific release, pin the version — for example `uv tool install specify-cli==0.12.11`. See the [PyPI installation guide](install/pypi.md) for details, including how to upgrade and how to [install from a custom or private package index](install/pypi.md#install-from-a-custom-or-private-package-index).
### One-time Usage