Skip to content

Commit 2d3e4a1

Browse files
committed
docs(offline): add v0.6.0 deprecation notice with rationale
- Help text: note bundled assets become default in v0.6.0 - Docstring: explain why GitHub download is being retired (no network dependency, no proxy/firewall issues, guaranteed version match) - Runtime nudge: when bundled assets are available but user takes the GitHub download path, suggest --offline with rationale - docs/installation.md: add deprecation notice with full rationale
1 parent 6aa53d6 commit 2d3e4a1

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

docs/installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,8 @@ specify init my-project --ai claude --offline
119119

120120
The `--offline` flag tells the CLI to use the templates, commands, and scripts bundled inside the wheel instead of downloading from GitHub.
121121

122+
> **Deprecation notice:** Starting with v0.6.0, `specify init` will use bundled assets by default and the `--offline` flag will be removed. The GitHub download path will be retired because bundled assets eliminate the need for network access, avoid proxy/firewall issues, and guarantee that templates always match the installed CLI version. No action will be needed — `specify init` will simply work without network access out of the box.
123+
122124
> **Note:** Python 3.11+ is required.
123125
124126
> **Windows note:** Offline scaffolding requires PowerShell 7+ (`pwsh`), not Windows PowerShell 5.x (`powershell.exe`). Install from https://aka.ms/powershell.

src/specify_cli/__init__.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1710,7 +1710,7 @@ def init(
17101710
debug: bool = typer.Option(False, "--debug", help="Show verbose diagnostic output for network and extraction failures"),
17111711
github_token: str = typer.Option(None, "--github-token", help="GitHub token to use for API requests (or set GH_TOKEN or GITHUB_TOKEN environment variable)"),
17121712
ai_skills: bool = typer.Option(False, "--ai-skills", help="Install Prompt.MD templates as agent skills (requires --ai)"),
1713-
offline: bool = typer.Option(False, "--offline", help="Use assets bundled in the specify-cli package instead of downloading from GitHub (no network access required)"),
1713+
offline: bool = typer.Option(False, "--offline", help="Use assets bundled in the specify-cli package instead of downloading from GitHub (no network access required). Bundled assets will become the default in v0.6.0 and this flag will be removed."),
17141714
preset: str = typer.Option(None, "--preset", help="Install a preset during initialization (by preset ID)"),
17151715
branch_numbering: str = typer.Option(None, "--branch-numbering", help="Branch numbering strategy: 'sequential' (001, 002, ...) or 'timestamp' (YYYYMMDD-HHMMSS)"),
17161716
):
@@ -1722,6 +1722,12 @@ def init(
17221722
package instead (no internet access required, ideal for air-gapped or
17231723
enterprise environments).
17241724
1725+
NOTE: Starting with v0.6.0, bundled assets will be used by default and
1726+
the --offline flag will be removed. The GitHub download path will be
1727+
retired because bundled assets eliminate the need for network access,
1728+
avoid proxy/firewall issues, and guarantee that templates always match
1729+
the installed CLI version.
1730+
17251731
This command will:
17261732
1. Check that required tools are installed (git is optional)
17271733
2. Let you choose your AI assistant
@@ -1934,6 +1940,14 @@ def init(
19341940

19351941
use_github = not (offline and _core is not None)
19361942

1943+
if use_github and _core is not None:
1944+
console.print(
1945+
"[yellow]Note:[/yellow] Bundled assets are available in this install. "
1946+
"Use [bold]--offline[/bold] to skip the GitHub download — faster, "
1947+
"no network required, and guaranteed version match.\n"
1948+
"This will become the default in v0.6.0."
1949+
)
1950+
19371951
if use_github:
19381952
for key, label in [
19391953
("fetch", "Fetch latest release"),

0 commit comments

Comments
 (0)