Skip to content

Commit 6ffc129

Browse files
committed
docs(cli): align init help with bundled scaffolding
Potential fix for pull request finding Update command package documentation and init help text to reflect the current implementation: init uses bundled assets and integration setup, while placeholder command modules are import anchors until extracted. Remove the unused tracker-active flag assignment that had no reader in the codebase. Constraint: --offline is hidden/no-op and init no longer downloads templates from GitHub releases Rejected: Add no-op register functions to placeholder modules | would imply extracted command groups are implemented there Confidence: high Scope-risk: narrow Directive: Keep CLI help text aligned with the actual init scaffolding path Tested: uv run specify init --help; uv run pytest tests/test_commands_package.py tests/test_agent_config_consistency.py -q; uv run pytest tests/test_commands_package.py tests/test_console_imports.py tests/integrations/test_cli.py -q Not-tested: full test suite
1 parent b3c5c97 commit 6ffc129

2 files changed

Lines changed: 13 additions & 16 deletions

File tree

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
1-
"""CLI command groups — each module exposes a register(app) function."""
1+
"""CLI command groups extracted from the main application.
2+
3+
Implemented command modules expose a ``register(app)`` function. Placeholder
4+
modules are import-only anchors for command groups that still live in the main
5+
application module.
6+
"""
27
from __future__ import annotations

src/specify_cli/commands/init.py

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ def init(
105105
here: bool = typer.Option(False, "--here", help="Initialize project in the current directory instead of creating a new one"),
106106
force: bool = typer.Option(False, "--force", help="Force merge/overwrite when using --here (skip confirmation)"),
107107
skip_tls: bool = typer.Option(False, "--skip-tls", help="Deprecated (no-op). Previously: skip SSL/TLS verification.", hidden=True),
108-
debug: bool = typer.Option(False, "--debug", help="Deprecated (no-op). Previously: show verbose diagnostic output.", hidden=True),
108+
debug: bool = typer.Option(False, "--debug", help="Deprecated. Previously: show verbose diagnostic output; currently only prints additional diagnostic details on failure.", hidden=True),
109109
github_token: str = typer.Option(None, "--github-token", help="Deprecated (no-op). Previously: GitHub token for API requests.", hidden=True),
110110
ai_skills: bool = typer.Option(False, "--ai-skills", help="Install Prompt.MD templates as agent skills (requires --ai)"),
111111
offline: bool = typer.Option(False, "--offline", help="Deprecated (no-op). All scaffolding now uses bundled assets.", hidden=True),
@@ -117,24 +117,18 @@ def init(
117117
"""
118118
Initialize a new Specify project.
119119
120-
By default, project files are downloaded from the latest GitHub release.
121-
Use --offline to scaffold from assets bundled inside the specify-cli
122-
package instead (no internet access required, ideal for air-gapped or
123-
enterprise environments).
124-
125-
NOTE: Starting with v0.6.0, bundled assets will be used by default and
126-
the --offline flag will be removed. The GitHub download path will be
127-
retired because bundled assets eliminate the need for network access,
128-
avoid proxy/firewall issues, and guarantee that templates always match
129-
the installed CLI version.
120+
Project files are scaffolded from assets bundled inside the specify-cli
121+
package, so initialization does not need network access and templates
122+
match the installed CLI version.
130123
131124
This command will:
132125
1. Check that required tools are installed (git is optional)
133126
2. Let you choose your coding agent integration, or default to Copilot
134127
in non-interactive sessions
135-
3. Download template from GitHub (or use bundled assets with --offline)
128+
3. Install bundled Spec Kit templates, scripts, workflow, and shared
129+
project infrastructure
136130
4. Initialize a fresh git repository (if not --no-git and no existing repo)
137-
5. Optionally set up coding agent integration commands
131+
5. Set up coding agent integration commands and optional presets
138132
139133
Examples:
140134
specify init my-project
@@ -384,8 +378,6 @@ def init(
384378

385379
tracker = StepTracker("Initialize Specify Project")
386380

387-
sys._specify_tracker_active = True
388-
389381
tracker.add("precheck", "Check required tools")
390382
tracker.complete("precheck", "ok")
391383
tracker.add("ai-select", "Select coding agent integration")

0 commit comments

Comments
 (0)