diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index cf0686db1a..b15e59c3b3 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -5,4 +5,3 @@ /extensions/catalog.community.json @mnriem /integrations/catalog.community.json @mnriem /presets/catalog.community.json @mnriem - diff --git a/.github/ISSUE_TEMPLATE/agent_request.yml b/.github/ISSUE_TEMPLATE/agent_request.yml index 1353e48e69..e30f773edc 100644 --- a/.github/ISSUE_TEMPLATE/agent_request.yml +++ b/.github/ISSUE_TEMPLATE/agent_request.yml @@ -7,8 +7,8 @@ body: attributes: value: | Thanks for requesting a new agent! Before submitting, please check if the agent is already supported. - - **Currently supported agents**: Amp, Antigravity, Auggie CLI, Claude Code, Cline, CodeBuddy, Codex CLI, Cursor, Devin for Terminal, Firebender, Forge, Gemini CLI, GitHub Copilot, Goose, Hermes Agent, IBM Bob, Junie, Kilo Code, Kimi Code, Kiro CLI, Lingma, Mistral Vibe, Oh My Pi, opencode, Pi Coding Agent, Qoder CLI, Qwen Code, RovoDev ACLI, SHAI, Tabnine CLI, Trae, ZCode, Zed + + **Currently supported agents**: Amp, Antigravity, Auggie CLI, Claude Code, Cline, CodeBuddy, Codex CLI, Cursor, Devin for Terminal, Firebender, Forge, Gemini CLI, GitHub Copilot, Goose, Grok Build, Hermes Agent, IBM Bob, Junie, Kilo Code, Kimi Code, Kiro CLI, Lingma, Mistral Vibe, Oh My Pi, opencode, Pi Coding Agent, Qoder CLI, Qwen Code, RovoDev ACLI, SHAI, Tabnine CLI, Trae, ZCode, Zed - type: input id: agent-name diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index b71d90cdab..dd7c55d1ca 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -76,6 +76,7 @@ body: - Gemini CLI - GitHub Copilot - Goose + - Grok Build - Hermes Agent - IBM Bob - Junie diff --git a/.github/ISSUE_TEMPLATE/extension_submission.yml b/.github/ISSUE_TEMPLATE/extension_submission.yml index f1cf25197c..62508dd569 100644 --- a/.github/ISSUE_TEMPLATE/extension_submission.yml +++ b/.github/ISSUE_TEMPLATE/extension_submission.yml @@ -7,7 +7,7 @@ body: attributes: value: | Thanks for contributing an extension! This template helps you submit your extension to the community catalog. - + **Before submitting:** - Review the [Extension Publishing Guide](https://github.com/github/spec-kit/blob/main/extensions/EXTENSION-PUBLISHING-GUIDE.md) - Ensure your extension has a valid `extension.yml` manifest @@ -209,9 +209,9 @@ body: **Tested on:** - macOS 14.0 with Spec Kit v0.1.0 - Linux Ubuntu 22.04 with Spec Kit v0.1.0 - + **Test project:** [Link or description] - + **Test scenarios:** 1. Installed extension 2. Configured settings @@ -230,7 +230,7 @@ body: ```bash # Install extension specify extension add --from https://github.com/your-org/spec-kit-your-extension/archive/refs/tags/v1.0.0.zip - + # Use a command /speckit.your-extension.command-name arg1 arg2 ``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 76566a18fc..6a037ae1eb 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -70,6 +70,7 @@ body: - Gemini CLI - GitHub Copilot - Goose + - Grok Build - Hermes Agent - IBM Bob - Junie diff --git a/.github/ISSUE_TEMPLATE/preset_submission.yml b/.github/ISSUE_TEMPLATE/preset_submission.yml index f25c60f92a..45c1f81739 100644 --- a/.github/ISSUE_TEMPLATE/preset_submission.yml +++ b/.github/ISSUE_TEMPLATE/preset_submission.yml @@ -7,7 +7,7 @@ body: attributes: value: | Thanks for contributing a preset! This template helps you submit your preset to the community catalog. - + **Before submitting:** - Review the [Preset Publishing Guide](https://github.com/github/spec-kit/blob/main/presets/PUBLISHING.md) - Ensure your preset has a valid `preset.yml` manifest diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 68c4aeb255..c9fce2cd8d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,4 +19,3 @@ - [ ] I **did** use AI assistance (describe below) - diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1d987c7a46..3007f1032f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -35,7 +35,7 @@ jobs: fetch-depth: 0 # Fetch all history for git info - name: Setup .NET - uses: actions/setup-dotnet@9a946fdbd5fb07b82b2f5a4466058b876ab72bb2 # v5.3.0 + uses: actions/setup-dotnet@26b0ec14cb23fa6904739307f278c14f94c95bf1 # v5.4.0 with: dotnet-version: '8.x' diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 8ec68a6e98..49bf14fa1a 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -37,7 +37,7 @@ jobs: fi - name: Run markdownlint-cli2 - uses: DavidAnson/markdownlint-cli2-action@ded1f9488f68a970bc66ea5619e13e9b52e601cd # v23 + uses: DavidAnson/markdownlint-cli2-action@8de2aa07cae85fd17c0b35642db70cf5495f1d25 # v24.0.0 with: globs: | '**/*.md' diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml index 1abda3e91c..d935019068 100644 --- a/.github/workflows/publish-pypi.yml +++ b/.github/workflows/publish-pypi.yml @@ -32,7 +32,7 @@ jobs: ref: refs/tags/${{ inputs.tag }} - name: Install uv - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0 + uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Set up Python uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6 @@ -74,7 +74,7 @@ jobs: path: dist/ - name: Install uv - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0 + uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Publish to PyPI run: uv publish diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 667b942df9..67c8064e91 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -20,24 +20,24 @@ jobs: days-before-stale: 150 # Days of inactivity before a stale issue or PR is closed (after being marked stale) days-before-close: 30 - + # Stale issue settings stale-issue-message: 'This issue has been automatically marked as stale because it has not had any activity for 150 days. It will be closed in 30 days if no further activity occurs.' close-issue-message: 'This issue has been automatically closed due to inactivity (180 days total). If you believe this issue is still relevant, please reopen it or create a new issue.' stale-issue-label: 'stale' - + # Stale PR settings stale-pr-message: 'This pull request has been automatically marked as stale because it has not had any activity for 150 days. It will be closed in 30 days if no further activity occurs.' close-pr-message: 'This pull request has been automatically closed due to inactivity (180 days total). If you believe this PR is still relevant, please reopen it or create a new PR.' stale-pr-label: 'stale' - + # Exempt issues and PRs with these labels from being marked as stale exempt-issue-labels: 'pinned,security' exempt-pr-labels: 'pinned,security' - + # Only issues or PRs with all of these labels are checked # Leave empty to check all issues and PRs any-of-labels: '' - + # Operations per run (helps avoid rate limits) operations-per-run: 250 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index be3caa784c..fa4c1e8b66 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -16,7 +16,7 @@ jobs: uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 - name: Install uv - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0 + uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Set up Python uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6 @@ -37,7 +37,7 @@ jobs: uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 - name: Install uv - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0 + uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6 diff --git a/.gitignore b/.gitignore index 21e211c7e8..954a502ce3 100644 --- a/.gitignore +++ b/.gitignore @@ -53,9 +53,10 @@ docs/dev # The following directories/file are intentionally ignored so that they are not accidentally # committed to the repository. They contain the scaffolding `specify init --integration copilot` -# does and they are meant for dogfooding Spec Kit during its own feature development. +# (or other agents) does and they are meant for dogfooding Spec Kit during its own feature development. .github/agents/ .github/prompts/ .github/copilot-instructions.md +.grok/ .specify/ specs/ diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 0108b9f234..f75fc24ce2 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -26,4 +26,4 @@ "ignores": [ ".genreleases/" ] -} \ No newline at end of file +} diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000000..f5a465904f --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,12 @@ +--- +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v6.0.0 + hooks: + - id: check-executables-have-shebangs + - id: check-yaml + exclude: \.lock\.yml$ + - id: end-of-file-fixer + exclude: \.lock\.yml$ + - id: trailing-whitespace + exclude: \.lock\.yml$ diff --git a/CHANGELOG.md b/CHANGELOG.md index 0305540b98..e5435efea3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,21 @@ +## [satware-0.12.17] - 2026-07-17 + +### Changed + +- chore: sync fork with upstream v0.12.17 (integrates v0.12.5 – v0.12.17) +- feat(integrations): Grok Build skills-based integration (#3535) +- fix(workflows): if/switch, fan-in/fan-out, while/do-while error handling + (#3515, #3521, #3519, #3522, #3468) +- feat(extensions): git extension scripts ported to Python (#3400) +- fix(extensions): resolve __SPECKIT_COMMAND tokens in auto-registered skills (#3544) +- fix(integrations): preserve ai_skills on `use` for skills-mode Copilot (#3551) +- fix(presets): seed constitution from preset constitution-template (#3276) +- chore(ipadp): bump `specs/metadata.json` version → 0.12.17, + `fork_version` → satware-v0.12.17 + ## [satware-0.12.4] - 2026-07-03 ### Changed @@ -32,6 +47,202 @@ - chore: sync fork with upstream v0.8.0 +## [0.12.17] - 2026-07-16 + +### Changed + +- fix(extensions): resolve __SPECKIT_COMMAND tokens in auto-registered skills (#3544) +- fix(workflows): fail if/switch steps on non-list branch instead of crashing (#3515) +- feat(integrations): add Grok Build skills-based integration (#3535) +- fix(extensions/git): reject negative -Number in create-new-feature-branch.ps1 (#3538) +- test: cover preset constitution seeding through init CLI (#3297) +- fix(integration): preserve ai_skills on `use` for skills-mode Copilot (#3550) (#3551) +- [extension] Add Figma Starter extension to community catalog (#3547) +- [extension] Add Spec-Kit BDD extension to community catalog (#3548) +- [extension] Update Quality Gates (Enforcement Layer) extension to v0.3.2 (#3542) +- chore: release 0.12.16, begin 0.12.17.dev0 development (#3549) + +## [0.12.16] - 2026-07-15 + +### Changed + +- fix(workflows): raise a clear error, not a cryptic crash, on non-string filter args (#3522) +- feat(workflows): expose workflow source directory to steps (#3469) +- fix(workflows): fan-out max_concurrency .inf falls back to sequential, not crash (#3521) +- Update Coding Standards Drift Control extension to v0.4.0 (#3540) +- fix(presets): seed constitution from preset constitution-template (#3272) (#3276) +- docs: add PyPI as second supported install route (#3425) (#3516) +- fix(workflows): fail while/do-while steps on non-list steps instead of crashing (#3519) +- Add PatchWarden Evidence Pack extension to community catalog (#3514) +- feat(extensions): port git extension scripts to Python (#3400) +- chore: release 0.12.15, begin 0.12.16.dev0 development (#3513) + +## [0.12.15] - 2026-07-14 + +### Changed + +- Update Autonomous Run Governance preset to v0.1.4 (#3511) +- fix(workflows): raise catalog error, not raw ValueError, on a malformed catalog URL (#3484) +- fix(workflows): evaluate 'in'/'not in' safely on a non-iterable right operand (#3447) (#3468) +- fix: add trailing newline to init-options.json output (#3509) +- feat(workflows): align workflow CLI with extension command surface (#3419) +- fix(extensions): stop env-var config leaking across prefix-colliding extension IDs (#3497) +- fix(integrations): escape control characters in goose recipe YAML renderer (#3384) +- [extension] Update DocGuard — CDD Enforcement extension to v0.32.0 (#3489) +- [extension] Add Multi-Repo Branch Sync extension to community catalog (#3411) +- chore: release 0.12.14, begin 0.12.15.dev0 development (#3506) + +## [0.12.14] - 2026-07-13 + +### Changed + +- [extension] Add Spec Kit Memory extension to community catalog (#3455) +- Add Test-First Governance preset to community catalog (#3504) +- Add Autonomous Run Governance preset to community catalog (#3501) +- fix(workflows): validate command step input/options are mappings (#3262) +- fix(presets): resolve() honors manifest-declared file: for installed presets (#3351) +- fix(init): don't block on confirmation for 'init --here' without a TTY (#3236) +- [extension] Add Quality Gates (Enforcement Layer) extension to community catalog (#3431) +- fix(integrations): exit cleanly on unbalanced quote in --integration-options (#3457) (#3466) +- fix(integrations): declare kiro-cli multi-install safe (#3471) (#3485) +- fix(workflows): fail fan-in step on non-list wait_for instead of crashing (#3482) +- chore: release 0.12.13, begin 0.12.14.dev0 development (#3498) + +## [0.12.13] - 2026-07-13 + +### Changed + +- fix(workflows): fail switch step on non-mapping cases instead of crashing (#3481) +- Cleanup agent-file-template.md (#2579) +- fix: mark Kiro integration as multi-install safe (#3472) +- fix: rewrite extension-relative subdir paths in generated command bodies (#3444) +- fix(templates): point constitution sync checklist at installed command files (#3418) +- feat(workflows): make shell step timeout configurable (#3327) (#3328) +- docs: clarify that release tags keep the leading v prefix (#3463) +- fix(workflows): don't crash on membership test against a non-iterable (#3448) +- fix(workflows): if-step validate accepts falsy non-list else (#3264) +- chore: release 0.12.12, begin 0.12.13.dev0 development (#3490) + +## [0.12.12] - 2026-07-13 + +### Changed + +- fix(extensions): set-priority repairs corrupted boolean priority (#3268) +- fix(presets): set-priority repairs corrupted boolean priority (#3269) +- fix(workflows): engine loop cap ignores bool max_iterations (#3270) +- docs(bundles): document --integration on 'bundle update' (#3271) +- fix(workflows): harden catalog.py against mis-shaped registry & non-string fields (#3375) +- Add Verify Review Ship extension to community catalog (#3450) +- fix(bundle): reject file:// / local download_url — catalog URLs are HTTPS-only (#3344) +- fix(extensions): handle prefix-colliding env vars in _get_env_config (#3350) +- docs: document copilot skills mode (--skills) and markdown deprecation (#3313) +- chore: release 0.12.11, begin 0.12.12.dev0 development (#3460) + +## [0.12.11] - 2026-07-10 + +### Changed + +- fix(agent-context): discover nested plan.md in scoped layouts (#3024) (#3301) +- fix(auth): return no matches, not raw ValueError, for a malformed URL (#3437) +- fix(catalogs): raise catalog error, not raw ValueError, on a malformed URL (#3435) +- fix(bundler): raise BundlerError, not raw ValueError, on a malformed catalog URL (#3433) +- chore: add pre-commit config and fix trailing whitespace/end-of-file (#3430) +- Add EARS Requirements Syntax extension to community catalog (#3407) +- Add Spec Kit Figma extension to community catalog (#3408) +- fix(workflows): report validation errors instead of crashing on non-string workflow.yml scalars (#3421) +- fix(templates): remove self-referencing path in plan-template.md note (#3417) +- chore: release 0.12.10, begin 0.12.11.dev0 development (#3453) + +## [0.12.10] - 2026-07-10 + +### Changed + +- chore(deps): bump astral-sh/setup-uv from 8.2.0 to 8.3.2 (#3439) +- chore(deps): bump DavidAnson/markdownlint-cli2-action (#3438) +- fix(templates): correct phase numbering in plan.md (#3416) +- fix(git-ext): honor explicit -Number 0 in PowerShell branch creation (#3412) +- docs: add 'spectatui' entry to friends.md (#3362) +- test: pin interpreter probe so py-template render test passes on Windows (#3428) +- feat(workflows): make shell step timeout configurable (#3404) +- fix: find plans in nested spec directories (#3405) +- feat(templates): add py: lines to command templates' scripts frontmatter (#3403) +- chore: release 0.12.9, begin 0.12.10.dev0 development (#3426) + +## [0.12.9] - 2026-07-09 + +### Changed + +- fix(integrations): skip Windows Store python3 alias stub in resolve_python_interpreter (#3385) +- fix(integrations): escape control characters in SKILL.md frontmatter (#3399) +- fix(workflows): apply chained expression filters left-to-right (#3339) +- fix(scripts): resolve invoke_separator by parse success, not python3 availability (#3304) (#3320) +- fix(shared-infra): refresh_shared_templates preserves recovered user files (#3378) +- fix(agents): resolve skill placeholders in Goose (yaml) command output (#3374) +- fix(bundler): enforce version pin on bundled preset/extension installs (#3377) +- Update Golden Demo extension to v0.3.0 (#3394) +- test: isolate integration test home (#3144) +- chore: release 0.12.8, begin 0.12.9.dev0 development (#3410) + +## [0.12.8] - 2026-07-08 + +### Changed + +- [extension] Add LLM Wiki extension to community catalog (#3361) +- Docs: Document missing CLI flags and integrations (#3182) +- Docs: Remove Cursor from CLI check list in README (#3184) +- feat(extensions): port update-agent-context to Python (#3387) +- fix(scripts): fall through to grep/sed when python3 is a broken stub in feature.json parser (#3312) +- fix(toml): escape control characters so generated command files parse (#3341) +- fix(cli): exit cleanly on malformed IPv6 URLs in `extension`/`preset`/`workflow add` (#3369) +- fix(github-http): return None on malformed GHES port instead of raising (#3379) +- fix(integrations): guard _sha256 against unreadable managed files (#3376) +- chore: release 0.12.7, begin 0.12.8.dev0 development (#3398) + +## [0.12.7] - 2026-07-07 + +### Changed + +- fix(bundler): bundle update uninstalls components dropped by new version (#3353) +- fix(workflows): route run/resume errors to stderr under --json (#3352) +- fix(workflows): fan-in validate() rejects non-mapping output (#3349) +- fix(workflows): shell step validate() rejects non-string run (#3348) +- fix(integrations): agy honors SPECKIT_INTEGRATION_AGY_EXTRA_ARGS (#3347) +- Add Orchestration Task Context Management extension to community catalog (#3372) +- Update DocGuard — CDD Enforcement extension to v0.30.0 (#3371) +- Update Ripple extension to v1.1.0 (#3370) +- feat(integrations): generalize post-processing to all format types (#3311) +- chore: release 0.12.6, begin 0.12.7.dev0 development (#3393) + +## [0.12.6] - 2026-07-07 + +### Changed + +- fix(bundler): validate catalog URLs in `catalog add` (HTTPS-only, require host) (#3367) +- Update Ralph Loop extension to v1.2.1 (#3365) +- fix extension-local script path rewriting (#3364) +- Add Charter extension to community catalog (#3363) +- feat(scripts): add Python check-prerequisites PoC (#3302) +- test: reduce registry manifest test repetition (#3146) +- fix(integrations): hermes honors SPECKIT_INTEGRATION_HERMES_EXTRA_ARGS (#3346) +- fix(extensions): coerce non-mapping YAML config roots to {} in ConfigManager (#3345) +- fix(yaml): pin goose recipe prompt block-scalar indentation (#3343) +- chore: release 0.12.5, begin 0.12.6.dev0 development (#3381) + +## [0.12.5] - 2026-07-06 + +### Changed + +- fix(workflows): match gate reject option case-insensitively (#3335) +- fix(bundler): reject host-less catalog URLs in adapters (use hostname, not netloc) (#3333) +- fix(bundler): resolve catalog search at highest-precedence source before filtering (#3331) +- fix(workflows): compare non-numeric strings lexicographically instead of returning False (#3323) +- fix(workflows): quote-aware interpolation so a literal }} in a filter arg doesn't break multi-expression templates (#3307) +- Support namespaced git feature branch templates (#3293) +- chore(deps): bump actions/setup-dotnet from 5.3.0 to 5.4.0 (#3315) +- fix(integrations): cursor-agent honors executable/extra-args env overrides (#3265) +- docs: drop stale kimi KIMI.md->AGENTS.md migration note (#3291) +- chore: release 0.12.4, begin 0.12.5.dev0 development (#3305) + ## [0.12.4] - 2026-07-02 ### Changed diff --git a/LICENSE b/LICENSE index a0eb787a8f..28a50fa226 100644 --- a/LICENSE +++ b/LICENSE @@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - diff --git a/README.md b/README.md index 62514e5b0e..77ef313f2d 100644 --- a/README.md +++ b/README.md @@ -45,12 +45,18 @@ Spec-Driven Development **flips the script** on traditional software development ### 1. Install Specify CLI -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): +Requires **[uv](https://docs.astral.sh/uv/)** ([install uv](./docs/install/uv.md)). Replace `vX.Y.Z` with the latest release tag from [Releases](https://github.com/github/spec-kit/releases) — keep the leading `v` (for example, `v0.12.11`, not `0.12.11`): ```bash uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z ``` +Prefer installing from PyPI? The `specify-cli` package is also published there: + +```bash +uv tool install specify-cli +``` + See the [Installation Guide](./docs/installation.md) for alternative methods, verification, upgrade, and troubleshooting. ### 2. Initialize a project @@ -406,7 +412,7 @@ specify init . --force --integration copilot specify init --here --force --integration copilot ``` -The CLI will check that your selected agent's CLI tool is installed (for integrations that require a CLI), such as Claude Code, Gemini CLI, Qwen Code, opencode, Codex CLI, Qoder CLI, Tabnine CLI, Kiro CLI, Pi Coding Agent, Oh My Pi, Forge, Goose, Mistral Vibe, or ZCode. If you don't have the required tool installed, or you prefer to get the templates without checking for the right tools, use `--ignore-agent-tools` with your command: +The CLI checks that the selected integration's required CLI tool is installed on your machine when that integration has `requires_cli: True`. If you do not have the required tool installed, or you prefer to get the templates without checking for the right tools, use `--ignore-agent-tools` with your command: ```bash specify init --integration copilot --ignore-agent-tools diff --git a/docs/.gitignore b/docs/.gitignore index 68fec76e37..614670d9f1 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -6,4 +6,3 @@ obj/ # Temporary files *.tmp *.log - diff --git a/docs/community/extensions.md b/docs/community/extensions.md index 0da3b3db60..3d2005a696 100644 --- a/docs/community/extensions.md +++ b/docs/community/extensions.md @@ -42,6 +42,7 @@ The following community-contributed extensions are available in [`catalog.commun | Bugfix Workflow | Structured bugfix workflow — capture bugs, trace to spec artifacts, and patch specs surgically | `process` | Read+Write | [spec-kit-bugfix](https://github.com/Quratulain-bilal/spec-kit-bugfix) | | Canon | Adds canon-driven (baseline-driven) workflows: spec-first, code-first, spec-drift. Requires Canon Core preset installation. | `process` | Read+Write | [spec-kit-canon](https://github.com/maximiliamus/spec-kit-canon/tree/master/extension) | | Catalog CI | Automated validation for spec-kit community catalog entries — structure, URLs, diffs, and linting | `process` | Read-only | [spec-kit-catalog-ci](https://github.com/Quratulain-bilal/spec-kit-catalog-ci) | +| Charter | Compose modular project constitutions from shared fragment registries. Centralize governance rules, select per-project fragments, track upstream changes, and keep multi-project setups consistent. | `process` | Read+Write | [spec-kit-charter](https://github.com/Fyloss/spec-kit-charter) | | CI Guard | Spec compliance gates for CI/CD — verify specs exist, check drift, and block merges on gaps | `process` | Read-only | [spec-kit-ci-guard](https://github.com/Quratulain-bilal/spec-kit-ci-guard) | | Checkpoint Extension | Commit the changes made during the middle of the implementation, so you don't end up with just one very large commit at the end | `code` | Read+Write | [spec-kit-checkpoint](https://github.com/aaronrsun/spec-kit-checkpoint) | | Cleanup Extension | Post-implementation quality gate that reviews changes, fixes small issues (scout rule), creates tasks for medium issues, and generates analysis for large issues | `code` | Read+Write | [spec-kit-cleanup](https://github.com/dsrednicki/spec-kit-cleanup) | @@ -50,14 +51,16 @@ The following community-contributed extensions are available in [`catalog.commun | Confluence Extension | Create a doc in Confluence summarizing the specifications and planning files | `integration` | Read+Write | [spec-kit-confluence](https://github.com/aaronrsun/spec-kit-confluence) | | Cost Tracker | Track real LLM dollar cost across SDD workflows — per-feature budgets, per-integration comparison, and finance-ready exports | `visibility` | Read+Write | [spec-kit-cost](https://github.com/Quratulain-bilal/spec-kit-cost) | | Data Model Diagram | Generates Mermaid ER diagrams from Spec Kit data models after planning | `docs` | Read+Write | [spec-kit-data-model-diagram](https://github.com/benizzio/spec-kit-data-model-diagram) | -| DocGuard — CDD Enforcement | Canonical-Driven Development enforcement. Validates, scores, and traces project documentation with automated checks, AI-driven workflows, and spec-kit hooks. One pinned runtime dependency; pure Node.js otherwise. | `docs` | Read+Write | [spec-kit-docguard](https://github.com/raccioly/docguard) | +| DocGuard — CDD Enforcement | Doc-integrity engine with MCP server, SARIF output, and zero-LLM core. Validates, scores, and traces documentation against code — 24 validators, stable finding codes, spec-kit hooks. Pure Node.js. | `docs` | Read+Write | [spec-kit-docguard](https://github.com/raccioly/docguard) | +| EARS Requirements Syntax | Author, lint, and convert requirements using EARS - the five industry-standard sentence patterns for unambiguous, testable requirements | `docs` | Read+Write | [spec-kit-ears](https://github.com/dhruv-15-03/spec-kit-ears) | | Extensify | Create and validate extensions and extension catalogs | `process` | Read+Write | [extensify](https://github.com/mnriem/spec-kit-extensions/tree/main/extensify) | +| Figma Starter | Turns a Figma section's screens into per-screen spec.md files, an app-level user-stories.md, and a build-order.md, then hands off to /speckit.specify | `integration` | Read+Write | [spec-kit-figma-starter](https://github.com/wavemaker/spec-kit-figma-starter) | | Fix Findings | Automated analyze-fix-reanalyze loop that resolves spec findings until clean | `code` | Read+Write | [spec-kit-fix-findings](https://github.com/Quratulain-bilal/spec-kit-fix-findings) | | FixIt Extension | Spec-aware bug fixing — maps bugs to spec artifacts, proposes a plan, applies minimal changes | `code` | Read+Write | [spec-kit-fixit](https://github.com/speckit-community/spec-kit-fixit) | | Fleet Orchestrator | Orchestrate a full feature lifecycle with human-in-the-loop gates across all SpecKit phases | `process` | Read+Write | [spec-kit-fleet](https://github.com/sharathsatish/spec-kit-fleet) | | GitHub Issues Integration 1 | Generate spec artifacts from GitHub Issues - import issues, sync updates, and maintain bidirectional traceability | `integration` | Read+Write | [spec-kit-github-issues](https://github.com/Fatima367/spec-kit-github-issues) | | GitHub Issues Integration 2 | Creates and syncs local specs from an existing GitHub issue | `integration` | Read+Write | [spec-kit-issue](https://github.com/aaronrsun/spec-kit-issue) | -| Golden Demo | Extracts acceptance criteria from specs, builds test vectors, and produces a behavioral drift report — complementary to Architecture Guard and CDD | `docs` | Read+Write | [spec-kit-golden-demo](https://github.com/jasstt/spec-kit-golden-demo) | +| Golden Demo | Deterministic behavioral drift oracle. Extracts acceptance criteria, generates fuzz test vectors (seed=42), compares golden Python implementations against real code in any language. CI/CD gatekeeper with warn/strict modes. | `docs` | Read+Write | [spec-kit-golden-demo](https://github.com/jasstt/spec-kit-golden-demo) | | Improve Extension | Audits any codebase as a senior advisor and writes prioritized, self-contained spec prompts under specs/ that the spec-kit lifecycle can process | `process` | Read+Write | [spec-kit-improve](https://github.com/d0whc3r/spec-kit-improve) | | Intake | Normalize PRD, design, HTML SSOT, and test-case evidence into SDD-ready intake artifacts. | `docs` | Read+Write | [spec-kit-intake](https://github.com/bigsmartben/spec-kit-intake) | | Intelligent Agent Orchestrator | Cross-catalog agent discovery and intelligent prompt-to-command routing | `process` | Read+Write | [spec-kit-orchestrator](https://github.com/pragya247/spec-kit-orchestrator) | @@ -66,6 +69,7 @@ The following community-contributed extensions are available in [`catalog.commun | Jira Integration (Sync Engine) | Idempotent, drift-aware, fail-closed reconcile engine mirroring spec-kit specs into Jira (Epic per repo, Story per spec, Subtask per phase) | `integration` | Read+Write | [spec-kit-jira-sync](https://github.com/ashbrener/spec-kit-jira-sync) | | Learning Extension | Generate educational guides from implementations and enhance clarifications with mentoring context | `docs` | Read+Write | [spec-kit-learn](https://github.com/imviancagrace/spec-kit-learn) | | Linear Integration | Mirror spec-kit feature directories into Linear (filesystem → Linear, reconcile-based, unidirectional). | `integration` | Read+Write | [spec-kit-linear-sync](https://github.com/ashbrener/spec-kit-linear-sync) | +| LLM Wiki | LLM-maintained compounding project wiki: source ingestion, cited answers, and consistency linting | `docs` | Read+Write | [spec-kit-wiki](https://github.com/formin/spec-kit-wiki) | | Loop Engineering | Engineer safe autonomous agent loops for spec-driven development: a maker/checker split, externalized loop state, and stay-the-engineer guardrails against comprehension debt and cognitive surrender | `process` | Read+Write | [spec-kit-loop](https://github.com/formin/spec-kit-loop) | | MAQA — Multi-Agent & Quality Assurance | Coordinator → feature → QA agent workflow with parallel worktree-based implementation. Language-agnostic. Auto-detects installed board plugins. Optional CI gate. | `process` | Read+Write | [spec-kit-maqa-ext](https://github.com/GenieRobot/spec-kit-maqa-ext) | | MAQA Azure DevOps Integration | Azure DevOps Boards integration for MAQA — syncs User Stories and Task children as features progress | `integration` | Read+Write | [spec-kit-maqa-azure-devops](https://github.com/GenieRobot/spec-kit-maqa-azure-devops) | @@ -81,11 +85,14 @@ The following community-contributed extensions are available in [`catalog.commun | MemoryLint | Evidence-driven instruction drift checker: audits agent memory files for boundary, reality, conflict, and redundancy drift. | `process` | Read+Write | [memorylint](https://github.com/RbBtSn0w/spec-kit-extensions/tree/main/memorylint) | | Microsoft 365 Integration | Fetch Teams messages, meeting transcripts, and SharePoint/OneDrive files as local Markdown for spec generation | `integration` | Read+Write | [spec-kit-m365](https://github.com/BenBtg/spec-kit-m365) | | Multi-Model Review | Cross-model Spec Kit handoffs for spec authoring, implementation routing, and review. | `process` | Read+Write | [multi-model-review](https://github.com/formin/multi-model-review) | +| Multi-Repo Branch Sync | Creates the feature branch in affected sub-repositories and git submodules via plan/tasks hooks | `process` | Read+Write | [multi-repo-sync](https://github.com/fyloss/spec-kit-multi-repo-sync) | | Multi-Sites Spec Kit | Multi-site aware specify command with per-site spec folders, auto-increment, and Drupal support | `process` | Read+Write | [spec-kit-multi-sites](https://github.com/teeyo/spec-kit-multi-sites) | | .NET Framework to Modern .NET Migration | Orchestrate end-to-end .NET Framework to modern .NET migration across 7 phases, with SDD lifecycle integration | `process` | Read+Write | [spec-kit-fx-to-net](https://github.com/RogerBestMsft/spec-kit-FxToNet) | | Onboard | Contextual onboarding and progressive growth for developers new to spec-kit projects. Explains specs, maps dependencies, validates understanding, and guides the next step | `process` | Read+Write | [spec-kit-onboard](https://github.com/dmux/spec-kit-onboard) | | Optimize | Audit and optimize AI governance for context efficiency — token budgets, rule health, interpretability, compression, coherence, and echo detection | `process` | Read+Write | [spec-kit-optimize](https://github.com/sakitA/spec-kit-optimize) | +| Orchestration Task Context Management | Adds subagent work-unit orchestration to generated Spec Kit task files | `process` | Read+Write | [spec-kit-orchestration-task-context-management](https://github.com/benizzio/spec-kit-orchestration-task-context-management) | | OWASP LLM Threat Model | OWASP Top 10 for LLM Applications 2025 threat analysis on agent artifacts | `code` | Read-only | [spec-kit-threatmodel](https://github.com/NaviaSamal/spec-kit-threatmodel) | +| PatchWarden Evidence Pack | Map Spec Kit tasks into a guarded PatchWarden Goal and export bounded, traceable evidence for an accepted lineage. | `process` | Read+Write | [spec-kit-patchwarden](https://github.com/jiezeng2004-design/spec-kit-patchwarden) | | Plan Review Gate | Require spec.md and plan.md to be merged via MR/PR before allowing task generation | `process` | Read-only | [spec-kit-plan-review-gate](https://github.com/luno/spec-kit-plan-review-gate) | | PR Bridge | Auto-generate pull request descriptions, checklists, and summaries from spec artifacts | `process` | Read-only | [spec-kit-pr-bridge-](https://github.com/Quratulain-bilal/spec-kit-pr-bridge-) | | Presetify | Create and validate presets and preset catalogs | `process` | Read+Write | [presetify](https://github.com/mnriem/spec-kit-extensions/tree/main/presetify) | @@ -94,6 +101,7 @@ The following community-contributed extensions are available in [`catalog.commun | Project Health Check | Diagnose a Spec Kit project and report health issues across structure, agents, features, scripts, extensions, and git | `visibility` | Read-only | [spec-kit-doctor](https://github.com/KhawarHabibKhan/spec-kit-doctor) | | Project Status | Show current SDD workflow progress — active feature, artifact status, task completion, workflow phase, and extensions summary | `visibility` | Read-only | [spec-kit-status](https://github.com/KhawarHabibKhan/spec-kit-status) | | QA Testing Extension | Systematic QA testing with browser-driven or CLI-based validation of acceptance criteria from spec | `code` | Read-only | [spec-kit-qa](https://github.com/arunt14/spec-kit-qa) | +| Quality Gates (Enforcement Layer) | Deterministic quality enforcement for Spec Kit across agent hooks, git checks, and CI pipelines with one policy file and one verify entrypoint for identical results at every boundary. | `process` | Read+Write | [spec-gates](https://github.com/schwichtgit/spec-gates) | | RAG Azure Builder | Spec Kit extension for onboarding and operating an Azure RAG stack with guided workflows. | `process` | Read+Write | [spec-kit-extension-rag-azure-builder](https://github.com/Sertxito/spec-kit-extension-rag-azure-builder) | | Ralph Loop | Autonomous implementation loop using AI agent CLI | `code` | Read+Write | [spec-kit-ralph](https://github.com/Rubiss-Projects/spec-kit-ralph) | | Reconcile Extension | Reconcile implementation drift by surgically updating feature artifacts. | `docs` | Read+Write | [spec-kit-reconcile](https://github.com/stn1slv/spec-kit-reconcile) | @@ -105,7 +113,7 @@ The following community-contributed extensions are available in [`catalog.commun | Retro Extension | Sprint retrospective analysis with metrics, spec accuracy assessment, and improvement suggestions | `process` | Read+Write | [spec-kit-retro](https://github.com/arunt14/spec-kit-retro) | | Retrospective Extension | Post-implementation retrospective with spec adherence scoring, drift analysis, and human-gated spec updates | `docs` | Read+Write | [spec-kit-retrospective](https://github.com/emi-dm/spec-kit-retrospective) | | Review Extension | Post-implementation comprehensive code review with specialized agents for code quality, comments, tests, error handling, type design, and simplification | `code` | Read-only | [spec-kit-review](https://github.com/ismaelJimenez/spec-kit-review) | -| Ripple | Detect side effects that tests can't catch after implementation — delta-anchored analysis across 9 domain-agnostic categories | `code` | Read+Write | [spec-kit-ripple](https://github.com/chordpli/spec-kit-ripple) | +| Ripple | Detect side effects that tests can't catch after implementation — surface hidden ripple effects across 9 analysis categories | `code` | Read+Write | [spec-kit-ripple](https://github.com/chordpli/spec-kit-ripple) | | SDD Utilities | Resume interrupted workflows, validate project health, and verify spec-to-task traceability | `process` | Read+Write | [speckit-utils](https://github.com/mvanhorn/speckit-utils) | | Security Review | Full-project secure-by-design security audits plus staged, branch/PR, plan, task, follow-up, and apply reviews | `code` | Read+Write | [spec-kit-security-review](https://github.com/DyanGalih/spec-kit-security-review) | | SFSpeckit | Enterprise Salesforce SDLC with 18 commands for the full SDD lifecycle. | `process` | Read+Write | [spec-kit-sf](https://github.com/ysumanth06/spec-kit-sf) | @@ -114,6 +122,8 @@ The following community-contributed extensions are available in [`catalog.commun | Spec Critique Extension | Dual-lens critical review of spec and plan from product strategy and engineering risk perspectives | `docs` | Read-only | [spec-kit-critique](https://github.com/arunt14/spec-kit-critique) | | Spec Diagram | Auto-generate Mermaid diagrams of SDD workflow state, feature progress, and task dependencies | `visibility` | Read-only | [spec-kit-diagram-](https://github.com/Quratulain-bilal/spec-kit-diagram-) | | Spec Kit Discovery Extension | Run technical discovery commands for feasibility, technology selection, scenario-specific technical decisions, legacy codebase assessment, implementation understanding, and proof-of-concept validation | `process` | Read+Write | [spec-kit-discovery](https://github.com/bigsmartben/spec-kit-discovery) | +| Spec Kit Figma | Agent-agnostic SpecKit extension that grounds spec, plan & task generation in Figma design context — REST + optional MCP, single/mono/multi-repo, macOS/Linux/Windows. | `integration` | Read+Write | [spec-kit-figma](https://github.com/Fyloss/spec-kit-figma) | +| Spec Kit Memory | Recalls prior specs and decisions from configurable memory tools (e.g. memsearch) before SDLC stages, so planning and specification start from what the project already knows | `docs` | Read+Write | [spec-kit-memory](https://github.com/zaytsevand/spec-kit-memory) | | Spec Kit Preview | Generate evidence-backed low, mid, or high fidelity previews from Spec Kit artifacts as Markdown or self-contained HTML | `docs` | Read+Write | [spec-kit-preview](https://github.com/bigsmartben/spec-kit-preview) | | Spec Kit Schedule | Optimal multi-agent task scheduling via CP-SAT — DAG precedence, hallucination-aware caps, file-conflict avoidance, stochastic durations, replanning, and interactive HTML output | `process` | Read+Write | [spec-kit-schedule](https://github.com/jfranc38/spec-kit-schedule) | | Spec Kit TLDR | Render a feature's spec.md / plan.md into a review-oriented TLDR (self-contained HTML dashboard + PR-native Markdown) that surfaces risks for faster PR review. | `visibility` | Read+Write | [speckit-tldr](https://github.com/qurore/speckit-tldr) | @@ -125,6 +135,7 @@ The following community-contributed extensions are available in [`catalog.commun | Spec Sync | Detect and resolve drift between specs and implementation. AI-assisted resolution with human approval | `docs` | Read+Write | [spec-kit-sync](https://github.com/bgervin/spec-kit-sync) | | Spec Trace | Build a requirement → test traceability matrix from spec.md and the test suite — surface untested requirements and orphan tests | `code` | Read+Write | [spec-kit-trace](https://github.com/Quratulain-bilal/spec-kit-trace) | | Spec Validate | Comprehension validation, review gating, and approval state for spec-kit artifacts — staged quizzes, peer review SLA, and a hard gate before /speckit.implement | `process` | Read+Write | [spec-kit-spec-validate](https://github.com/aeltayeb/spec-kit-spec-validate) | +| Spec-Kit BDD | ATDD/BDD extension: convert specs to Gherkin scenarios, scaffold step definitions, and verify acceptance test coverage | `process` | Read+Write | [spec-kit-bdd](https://github.com/RSginer/spec-kit-bdd) | | Spec2Cloud | Spec-driven workflow tuned for shipping to Azure | `process` | Read+Write | [spec2cloud](https://github.com/Azure-Samples/Spec2Cloud) | | SpecKit Companion | Live spec-driven progress — lifecycle capture, status, resume, and a turbo pipeline profile | `visibility` | Read+Write | [speckit-companion](https://github.com/alfredoperez/speckit-companion) | | SpecTest | Auto-generate test scaffolds from spec criteria, map coverage, and find untested requirements | `code` | Read+Write | [spec-kit-spectest](https://github.com/Quratulain-bilal/spec-kit-spectest) | @@ -143,6 +154,7 @@ The following community-contributed extensions are available in [`catalog.commun | Token Economy | Token routing, measured savings, and context audit workflows | `process` | Read+Write | [spec-kit-token-economy](https://github.com/formin/spec-kit-token-economy) | | V-Model Extension Pack | Enforces V-Model paired generation of development specs and test specs with full traceability | `docs` | Read+Write | [spec-kit-v-model](https://github.com/leocamello/spec-kit-v-model) | | Verify Extension | Post-implementation quality gate that validates implemented code against specification artifacts | `code` | Read-only | [spec-kit-verify](https://github.com/ismaelJimenez/spec-kit-verify) | +| Verify Review Ship | Adds post-implementation verify, review, and ship readiness gates to Spec Kit workflows | `process` | Read-only | [spec-kit-verify-review-ship](https://github.com/cadugevaerd/spec-kit-verify-review-ship) | | Verify Tasks Extension | Detect phantom completions: tasks marked [X] in tasks.md with no real implementation | `code` | Read-only | [spec-kit-verify-tasks](https://github.com/datastone-inc/spec-kit-verify-tasks) | | Version Guard | Verify tech stack versions against live npm registries before planning and implementation | `process` | Read-only | [spec-kit-version-guard](https://github.com/KevinBrown5280/spec-kit-version-guard) | | What-if Analysis | Preview the downstream impact (complexity, effort, tasks, risks) of requirement changes before committing to them | `visibility` | Read-only | [spec-kit-whatif](https://github.com/DevAbdullah90/spec-kit-whatif) | diff --git a/docs/community/friends.md b/docs/community/friends.md index 9aff166d0f..82fd9f2bc7 100644 --- a/docs/community/friends.md +++ b/docs/community/friends.md @@ -14,3 +14,5 @@ Community projects that extend, visualize, or build on Spec Kit: - **[SpecKit Companion](https://marketplace.visualstudio.com/items?itemName=alfredoperez.speckit-companion)** — A VS Code extension that brings a visual GUI to Spec Kit. Browse specs in a rich markdown viewer with clickable file references, create specifications with image attachments, comment and refine each step inline (GitHub-style review), track your progress through the SDD workflow with a visual phase stepper, and manage steering documents like constitutions and templates. - **[cc-spec-kit](https://github.com/speckit-community/cc-spec-kit)** — Community-maintained plugin for Claude Code and GitHub Copilot CLI that installs Spec Kit skills via the plugin marketplace. + +- **[spectatui](https://github.com/tinesoft/spectatui)** — A terminal UI (TUI) dashboard for Spec Kit that lets you track features, manage specifications, integrations, presets, workflows, and extensions, and monitor AI agent workflows. Attach to existing AI sessions or launch new ones from your terminal. Keyboard and mouse support. Light/dark theme support. Customizable and performance-oriented. Requires the `specify` CLI in your PATH. diff --git a/docs/community/presets.md b/docs/community/presets.md index 52f923a3ad..ae5489e209 100644 --- a/docs/community/presets.md +++ b/docs/community/presets.md @@ -11,6 +11,7 @@ The following community-contributed presets customize how Spec Kit behaves — o | Agent Parity Governance | Adds shared-guidance parity, audit-ready Spec-Kit run evidence, and agent-neutral model-routing guidance across a project's declared AI-agent instruction surfaces so agent guidance does not drift. | 6 templates, 3 commands | — | [spec-kit-preset-agent-parity-governance](https://github.com/hindermath/spec-kit-preset-agent-parity-governance) | | AIDE In-Place Migration | Adapts the AIDE extension workflow for in-place technology migrations (X → Y pattern) — adds migration objectives, verification gates, knowledge documents, and behavioral equivalence criteria | 2 templates, 8 commands | AIDE extension | [spec-kit-presets](https://github.com/mnriem/spec-kit-presets) | | Architecture Governance | Adds secure software architecture, STRIDE+CAPEC threat modeling, arc42 security cross-cutting concepts, S-ADRs, Zero Trust applicability, OWASP SAMM governance, BSI C3A cloud autonomy, BSI C5 cloud compliance assurance, and audit-ready Spec Kit run evidence | 13 templates, 3 commands | — | [spec-kit-preset-architecture-governance](https://github.com/hindermath/spec-kit-preset-architecture-governance) | +| Autonomous Run Governance | Adds permission-bounded, evidence-first governance for autonomous Spec Kit delivery, convergence, resume, closeout, and retrospective learning. | 12 templates, 2 commands, 2 scripts | — | [spec-kit-preset-autonomous-run-governance](https://github.com/hindermath/spec-kit-preset-autonomous-run-governance) | | Canon Core | Adapts original Spec Kit workflow to work together with Canon extension | 2 templates, 8 commands | — | [spec-kit-canon](https://github.com/maximiliamus/spec-kit-canon) | | Claude AskUserQuestion | Upgrades `/speckit.clarify` and `/speckit.checklist` on Claude Code from Markdown-table prompts to the native AskUserQuestion picker, with a recommended option and reasoning on every question | 2 commands | — | [spec-kit-preset-claude-ask-questions](https://github.com/0xrafasec/spec-kit-preset-claude-ask-questions) | | Command Density | Compacts the nine core Spec Kit command prompts while preserving scripts, handoffs, placeholders, hook output blocks, and rule structure | 9 commands | — | [spec-kit-preset-command-density](https://github.com/Xopoko/spec-kit-preset-command-density) | @@ -28,6 +29,7 @@ The following community-contributed presets customize how Spec Kit behaves — o | SicarioSpec Core | Baseline secure-by-default Spec Kit governance profile. | 5 templates | — | [sicario-spec](https://github.com/dfirs1car1o/sicario-spec) | | Spec2Cloud | Spec-driven workflow tuned for shipping to Azure: spec → plan → tasks → implement → deploy | 5 templates, 8 commands | — | [spec2cloud](https://github.com/Azure-Samples/Spec2Cloud) | | Table of Contents Navigation | Adds a navigable Table of Contents to generated spec.md, plan.md, and tasks.md documents | 3 templates, 3 commands | — | [spec-kit-preset-toc-navigation](https://github.com/Quratulain-bilal/spec-kit-preset-toc-navigation) | +| Test-First Governance | Governs TDD with coverage-complete BDD/ATDD Gherkin scenarios, explicit suite ownership, professional test reports, traceability, and risk-based quality gates. | 10 templates, 8 commands | — | [spec-kit-preset-test-first-governance](https://github.com/ka-zo/spec-kit-preset-test-first-governance) | | VS Code Ask Questions | Enhances the clarify command to use `vscode/askQuestions` for batched interactive questioning. | 1 command | — | [spec-kit-presets](https://github.com/fdcastel/spec-kit-presets) | | Workflow Preset | Behavior-first specification, design artifacts, and agent-native handoff orchestration — adds requirement-phase behavior drafts, formal BDD/UIF/behavior contracts, optional design artifacts, and scoped implementation handoffs with Core Agent, Vertical Planner Agent, and Worker Agent modes | 22 templates, 8 commands | — | [spec-kit-workflow-preset](https://github.com/bigsmartben/spec-kit-workflow-preset) | diff --git a/docs/install/one-time.md b/docs/install/one-time.md index 134cb0b11d..ed8bdef4ee 100644 --- a/docs/install/one-time.md +++ b/docs/install/one-time.md @@ -11,7 +11,8 @@ If you want to try Spec Kit without installing it permanently, use `uvx` to run # Create a new project (latest from main) uvx --from git+https://github.com/github/spec-kit.git specify init -# Or target a specific release (replace vX.Y.Z with a tag from Releases) +# Or target a specific release (replace vX.Y.Z with a tag from Releases; +# keep the leading v, e.g. v0.12.11 not 0.12.11) uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init # Initialize in the current directory diff --git a/docs/install/pipx.md b/docs/install/pipx.md index 3a25b16489..8e64ee083a 100644 --- a/docs/install/pipx.md +++ b/docs/install/pipx.md @@ -7,7 +7,8 @@ Pin a specific release tag for stability (check [Releases](https://github.com/github/spec-kit/releases) for the latest): ```bash -# Install a specific stable release (recommended — replace vX.Y.Z with the latest tag) +# Install a specific stable release (recommended — replace vX.Y.Z with the +# latest tag, keeping the leading v, e.g. v0.12.11 not 0.12.11) pipx install git+https://github.com/github/spec-kit.git@vX.Y.Z # Or install latest from main (may include unreleased changes) diff --git a/docs/install/pypi.md b/docs/install/pypi.md new file mode 100644 index 0000000000..1b89d78e44 --- /dev/null +++ b/docs/install/pypi.md @@ -0,0 +1,83 @@ +# Installing from PyPI + +Spec Kit is published to PyPI as [`specify-cli`](https://pypi.org/project/specify-cli/), maintained by the Spec Kit maintainers. Installing from PyPI is the second supported install route alongside installing from the [GitHub source](../installation.md#install-from-source--persistent-installation-recommended). Use whichever fits your workflow — both provide the same `specify` CLI. + +> [!NOTE] +> The PyPI release version tracks the GitHub release tags (for example, PyPI `0.12.11` corresponds to the `v0.12.11` tag). `specify version` is only a local version/runtime sanity check — it reports the installed version but not where the `specify` executable came from, so it cannot distinguish a PyPI install from a Git install. To confirm the install source, inspect the source metadata your package manager records: `pipx list --json` reports the exact install specification for each tool, and for uv/pip installs you can check the package's [PEP 610](https://peps.python.org/pep-0610/) `direct_url.json` inside its `*.dist-info` directory (a Git or URL install records the repository/archive URL there, while a plain PyPI index install does not create that file). Note that `pip show specify-cli` only prints package metadata and will not see uv/pipx-managed environments from the host interpreter. + +## Install Specify CLI + +Use whichever Python tool you already have: + +```bash +# Using uv (recommended) +uv tool install specify-cli + +# Or using pipx +pipx install specify-cli + +# Or using pip +pip install specify-cli +``` + +### Install a specific release + +Pin an exact version for reproducible installs (check [PyPI](https://pypi.org/project/specify-cli/#history) or [Releases](https://github.com/github/spec-kit/releases) for available versions): + +```bash +# Using uv +uv tool install specify-cli==0.12.11 + +# Or using pipx +pipx install specify-cli==0.12.11 + +# Or using pip +pip install specify-cli==0.12.11 +``` + +## Verify + +```bash +specify version +``` + +## Initialize a project + +```bash +specify init --integration copilot +``` + +## Upgrade + +Upgrade by reinstalling the package through the same tool you used for the original install. If you originally pinned a version, note that `uv tool upgrade` preserves that pin; to move to the newest PyPI release, use an unpinned install command so you do not keep the existing version pin: + +```bash +# Using uv +uv tool install --force specify-cli + +# Or using pipx +pipx install --force specify-cli + +# Or using pip +pip install --upgrade specify-cli +``` + +> [!NOTE] +> `specify self upgrade` currently rebuilds `uv tool` and `pipx` installs from the GitHub source release URL rather than preserving a PyPI-based installation. If you want to stay on the PyPI route, use the package-manager commands above. A plain `pip install specify-cli` is treated as an unmanaged install — upgrade it with `pip install --upgrade specify-cli`. See the [Upgrade Guide](../upgrade.md) for details. + +## Uninstall + +```bash +# Using uv +uv tool uninstall specify-cli + +# Or using pipx +pipx uninstall specify-cli + +# Or using pip +pip uninstall specify-cli +``` + +## Next steps + +Head to the [Quick Start](../quickstart.md) to initialize your first project. diff --git a/docs/installation.md b/docs/installation.md index 744423b29c..9fb2bf519f 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -11,11 +11,16 @@ ## Installation > [!IMPORTANT] -> 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. +> Spec Kit is distributed through two official channels, both published and maintained by the Spec Kit maintainers: the [github/spec-kit](https://github.com/github/spec-kit) GitHub repository (source installs) and the [`specify-cli`](https://pypi.org/project/specify-cli/) package on [PyPI](https://pypi.org/project/specify-cli/). Either route is supported for normal installs — use the commands shown below. After installing, run `specify version` as a local version/runtime sanity check. It confirms that the `specify` command is available and reports its version, but it does not prove whether the executable came from PyPI or GitHub. For offline or air-gapped environments, locally built wheels created from this repository are also valid. -### Persistent Installation (Recommended) +Spec Kit supports two install routes: -Install once and use everywhere. Replace `vX.Y.Z` with a tag from [Releases](https://github.com/github/spec-kit/releases): +1. **Install from source (GitHub)** — the recommended route, pinned to a release tag. +2. **Install from PyPI** — install the published `specify-cli` package with your usual Python tooling. + +### Install from Source — Persistent Installation (Recommended) + +Install once and use everywhere. Replace `vX.Y.Z` with a release tag from [Releases](https://github.com/github/spec-kit/releases) — keep the leading `v` (for example, `v0.12.11`, not `0.12.11`): > [!NOTE] > The command below requires **[uv](https://docs.astral.sh/uv/)**. If you see `command not found: uv`, [install uv first](./install/uv.md). @@ -30,12 +35,30 @@ Then initialize a project: specify init --integration copilot ``` +### Install from PyPI + +Spec Kit is also published to PyPI as [`specify-cli`](https://pypi.org/project/specify-cli/), so you can install it with your preferred Python package manager without referencing the Git URL: + +```bash +# Using uv (recommended) +uv tool install specify-cli + +# Or using pipx +pipx install specify-cli + +# Or using pip +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. + ### One-time Usage Run directly without installing — see the [One-time usage (uvx)](install/one-time.md) guide. ### Alternative Package Managers +- **PyPI** — see the [PyPI installation guide](install/pypi.md) - **pipx** — see the [pipx installation guide](install/pipx.md) - **Enterprise / Air-Gapped** — see the [air-gapped installation guide](install/air-gapped.md) @@ -81,13 +104,13 @@ specify init --integration claude --ignore-agent-tools ## Verification -After installation, run the following command to confirm the correct version is installed: +After installation, run the following command as a local version/runtime check: ```bash specify version ``` -This helps verify you are running the official Spec Kit build from GitHub, not an unrelated package with the same name. +This confirms that the `specify` command is available and reporting the expected version. It does not prove whether that executable came from PyPI or GitHub. **Stay current:** Run `specify self check` periodically to learn whether a newer release is available — it is read-only and never modifies your installation. When you are ready to upgrade, follow the [Upgrade Guide](./upgrade.md). diff --git a/docs/reference/bundles.md b/docs/reference/bundles.md index 57f3c700b1..2bd33c960b 100644 --- a/docs/reference/bundles.md +++ b/docs/reference/bundles.md @@ -51,10 +51,11 @@ If the current directory is not yet a Spec Kit project, `install` initializes on specify bundle update [] ``` -| Option | Description | -| ------------ | ------------------------------------ | -| `--all` | Update every installed bundle | -| `--offline` | Do not access the network | +| Option | Description | +| ---------------- | --------------------------------------------------------------------------------------------------------------------- | +| `--all` | Update every installed bundle | +| `--integration` | Override the integration used when refreshing components; applied only when the project's active integration can't be determined | +| `--offline` | Do not access the network | Re-resolves a bundle and **refreshes** its components through each primitive's update path, bringing already-installed components up to the bundle's newly pinned versions while preserving primitive-level overrides (such as preset priority). Provide a bundle id, or use `--all` to update everything installed. diff --git a/docs/reference/extensions.md b/docs/reference/extensions.md index 90e5ab8747..30f33eca0d 100644 --- a/docs/reference/extensions.md +++ b/docs/reference/extensions.md @@ -26,7 +26,7 @@ specify extension add | --------------- | -------------------------------------------------------- | | `--dev` | Install from a local directory (for development) | | `--from ` | Install from a custom URL instead of the catalog | -| `--force` | Overwrite if already installed | +| `--force` | Overwrite if the extension is already installed | | `--priority `| Resolution priority (default: 10; lower = higher precedence) | Installs an extension from the catalog, a URL, or a local directory. Extension commands are automatically registered with the currently installed AI coding agent integration. diff --git a/docs/reference/integrations.md b/docs/reference/integrations.md index b5ae740d45..1280dd6083 100644 --- a/docs/reference/integrations.md +++ b/docs/reference/integrations.md @@ -18,13 +18,14 @@ The Specify CLI supports a wide range of AI coding agents. When you run `specify | [Firebender](https://firebender.com/) | `firebender` | IDE-based agent for Android Studio / IntelliJ | | [Forge](https://forgecode.dev/) | `forge` | | | [Gemini CLI](https://github.com/google-gemini/gemini-cli) | `gemini` | | -| [GitHub Copilot](https://code.visualstudio.com/) | `copilot` | | +| [GitHub Copilot](https://code.visualstudio.com/) | `copilot` | Defaults to legacy markdown mode: `.agent.md` command files under `.github/agents/`, companion `.prompt.md` files under `.github/prompts/`, and a `.vscode/settings.json` merge. Pass `--integration-options="--skills"` to scaffold skills as `speckit-/SKILL.md` under `.github/skills/` instead. Legacy markdown mode is deprecated and will stop being the default in a future release. | | [Goose](https://goose-docs.ai/) | `goose` | Uses YAML recipe format in `.goose/recipes/` | +| [Grok Build](https://docs.x.ai/build/overview) | `grok` | Skills-based integration; installs skills into `.grok/skills` and invokes them as `/speckit-` | | [Hermes](https://github.com/NousResearch/hermes-agent) | `hermes` | Skills-based integration; installs skills globally into `~/.hermes/skills/` | | [IBM Bob](https://www.ibm.com/products/bob) | `bob` | IDE-based agent | | [Junie](https://junie.jetbrains.com/) | `junie` | | | [Kilo Code](https://github.com/Kilo-Org/kilocode) | `kilocode` | | -| [Kimi Code](https://code.kimi.com/) | `kimi` | Skills-based integration; installs into `.kimi-code/skills/`. `--migrate-legacy` moves old `.kimi/skills/` installs to the new paths, and (when the `agent-context` extension is enabled) migrates `KIMI.md` context into `AGENTS.md` | +| [Kimi Code](https://code.kimi.com/) | `kimi` | Skills-based integration; installs into `.kimi-code/skills/`. `--migrate-legacy` moves old `.kimi/skills/` installs to the new paths | | [Kiro CLI](https://kiro.dev/docs/cli/) | `kiro-cli` | Kiro CLI does not substitute `$ARGUMENTS` in file-based prompts, so Spec Kit ships a prose fallback at render time (see [Manage prompts](https://kiro.dev/docs/cli/chat/manage-prompts/) and issue [#1926](https://github.com/github/spec-kit/issues/1926)). Alias: `--integration kiro` | | [Lingma](https://lingma.aliyun.com/) | `lingma` | Skills-based integration; skills are installed automatically | | [Mistral Vibe](https://github.com/mistralai/mistral-vibe) | `vibe` | | @@ -218,7 +219,8 @@ Some integrations accept additional options via `--integration-options`: | Integration | Option | Description | | ----------- | ------------------- | -------------------------------------------------------------- | | `generic` | `--commands-dir` | Required. Directory for command files | -| `kimi` | `--migrate-legacy` | Migrate legacy `.kimi/skills/` installs to `.kimi-code/skills/` (including dotted→hyphenated directory names); when the `agent-context` extension is enabled, also migrates `KIMI.md` to `AGENTS.md` | +| `kimi` | `--migrate-legacy` | Migrate legacy `.kimi/skills/` installs to `.kimi-code/skills/` (including dotted→hyphenated skill naming, e.g. `speckit.xxx` → `speckit-xxx`) | +| `copilot` | `--skills` | Scaffold commands as agent skills (`speckit-/SKILL.md` under `.github/skills/`, invoked as `/speckit-`) instead of the default legacy markdown mode (`.github/agents/*.agent.md` plus `.github/prompts/*.prompt.md` and a `.vscode/settings.json` merge). Without this flag, install warns that legacy markdown mode is deprecated. | Example: @@ -248,7 +250,11 @@ Spec Kit tracks one default integration in `.specify/integration.json` with `def ### Which integrations are multi-install safe? -An integration is multi-install safe when it uses isolated agent directories, a dedicated context file that does not collide with another safe integration, stable command invocation settings, and a separate install manifest. Shared Spec Kit templates remain aligned to the single default integration. +An integration is multi-install safe when it uses a static, unique agent root and command directory, stable command invocation settings, and a separate install manifest whose managed files do not overlap another safe integration. Registry tests enforce those path and manifest invariants. Shared Spec Kit templates remain aligned to the single default integration. + +The Isolation column below lists paths Spec Kit manages for that integration (skills/commands roots and any integration-owned rule files). It is not a full inventory of every file an agent may read. + +**Agent-context defaults are separate.** The optional agent-context extension maps each integration to a default context file in `extensions/agent-context/agent-context-defaults.json`. Those defaults are independent of multi-install safety: several agents may share a root file such as `AGENTS.md` when the extension is enabled. Multi-install safety does not require a unique context file per safe integration. The currently declared multi-install safe integrations are: @@ -262,6 +268,7 @@ The currently declared multi-install safe integrations are: | `cursor-agent` | `.cursor/skills`, `.cursor/rules/specify-rules.mdc` | | `firebender` | `.firebender/commands`, `.firebender/rules/specify-rules.mdc` | | `gemini` | `.gemini/commands`, `GEMINI.md` | +| `grok` | `.grok/skills` | | `junie` | `.junie/commands`, `.junie/AGENTS.md` | | `kilocode` | `.kilocode/workflows`, `.kilocode/rules/specify-rules.md` | | `qodercli` | `.qoder/commands`, `QODER.md` | @@ -271,7 +278,7 @@ The currently declared multi-install safe integrations are: | `trae` | `.trae/skills`, `.trae/rules/project_rules.md` | | `zcode` | `.zcode/skills`, `ZCODE.md` | -Integrations that share a context file or command directory with another integration, require dynamic install paths such as `--commands-dir`, or merge shared tool settings are not declared safe by default. They can still be installed alongside another integration with `--force`. +Integrations that share a command directory with another integration, require dynamic install paths such as `--commands-dir`, or merge shared tool settings are not declared safe by default. They can still be installed alongside another integration with `--force`. ### What happens to my changes when I uninstall or switch? diff --git a/docs/reference/workflows.md b/docs/reference/workflows.md index 16bbe0893e..1dfc5e6904 100644 --- a/docs/reference/workflows.md +++ b/docs/reference/workflows.md @@ -86,8 +86,30 @@ Lists workflows installed in the current project. specify workflow add ``` +| Option | Description | +| --------------- | ------------------------------------------------------ | +| `--dev` | Install from a local workflow YAML file or directory | +| `--from ` | Install from a custom URL (`` names the expected workflow ID) | + Installs a workflow from the catalog, a URL (HTTPS required), or a local file path. +## Update Workflows + +```bash +specify workflow update [workflow_id] +``` + +Updates one installed catalog workflow — or all of them when no ID is given — to the latest catalog version. Prompts for confirmation and keeps the installed copy if a download or validation fails. + +## Enable or Disable a Workflow + +```bash +specify workflow enable +specify workflow disable +``` + +Disabled workflows stay installed and listed (marked `[disabled]`) but refuse to run until re-enabled. + ## Remove a Workflow ```bash @@ -102,9 +124,10 @@ Removes an installed workflow from the project. specify workflow search [query] ``` -| Option | Description | -| ------- | --------------- | -| `--tag` | Filter by tag | +| Option | Description | +| ---------- | ----------------- | +| `--tag` | Filter by tag | +| `--author` | Filter by author | Searches all active catalogs for workflows matching the query. @@ -282,6 +305,8 @@ Steps can reference inputs and previous step outputs using `{{ expression }}` sy | `inputs.spec` | Workflow input values | | `steps.specify.output.file` | Output from a previous step | | `item` | Current item in a fan-out iteration | +| `context.run_id` | Current workflow run ID | +| `context.workflow_dir` | Resolved absolute path to the workflow source directory. Empty string for string-loaded workflows. | Available filters: `default`, `join`, `contains`, `map`, `from_json`. @@ -293,6 +318,14 @@ args: "{{ inputs.spec }}" message: "{{ status | default('pending') }}" ``` +## Shell Step Environment Variables + +Shell steps automatically receive the following environment variables: + +| Variable | Description | +| -------- | ----------- | +| `SPECKIT_WORKFLOW_DIR` | Resolved absolute path to the workflow source directory (same value as `{{ context.workflow_dir }}`). Not set when the workflow has no source path. | + ## Input Types | Type | Coercion | diff --git a/docs/toc.yml b/docs/toc.yml index ca9fba235d..6e348f6e66 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -13,6 +13,8 @@ href: upgrade.md - name: Install uv href: install/uv.md + - name: Install from PyPI + href: install/pypi.md - name: Install with pipx href: install/pipx.md - name: One-time Usage (uvx) diff --git a/extensions/agent-context/agent-context-defaults.json b/extensions/agent-context/agent-context-defaults.json index 0870e6693a..1ef52b159d 100644 --- a/extensions/agent-context/agent-context-defaults.json +++ b/extensions/agent-context/agent-context-defaults.json @@ -17,6 +17,7 @@ "gemini": "GEMINI.md", "generic": "AGENTS.md", "goose": "AGENTS.md", + "grok": "AGENTS.md", "hermes": "AGENTS.md", "junie": ".junie/AGENTS.md", "kilocode": ".kilocode/rules/specify-rules.md", diff --git a/extensions/agent-context/commands/speckit.agent-context.update.md b/extensions/agent-context/commands/speckit.agent-context.update.md index a654eb5a0e..71c85f5d85 100644 --- a/extensions/agent-context/commands/speckit.agent-context.update.md +++ b/extensions/agent-context/commands/speckit.agent-context.update.md @@ -15,7 +15,7 @@ The script reads the agent-context extension config at - `context_files` — optional project-relative paths for multiple coding agent context files. When non-empty, the script updates each listed file and the list takes precedence over `context_file`. - `context_markers.start` / `.end` — the delimiters surrounding the managed section. Defaults to `` and `` when the field is missing. -It then creates, replaces, or appends the managed block so that the section points at the most recent plan path when one can be discovered (`specs//plan.md`). +It then creates, replaces, or appends the managed block so that the section points at the most recent plan path when one can be discovered (any `plan.md` under `specs/`, including nested scoped layouts such as `specs///plan.md`). If `context_files` and `context_file` are empty, the command reports nothing to do and exits successfully. Context file paths must stay project-relative; absolute paths, Windows drive paths, backslash separators, and `..` path segments are rejected. @@ -24,4 +24,4 @@ If `context_files` and `context_file` are empty, the command reports nothing to - **Bash**: `.specify/extensions/agent-context/scripts/bash/update-agent-context.sh [plan_path]` - **PowerShell**: `.specify/extensions/agent-context/scripts/powershell/update-agent-context.ps1 [plan_path]` -When `plan_path` is omitted, the script auto-detects the most recently modified `specs/*/plan.md`. +When `plan_path` is omitted, the script auto-detects the most recently modified `specs/**/plan.md` (searched recursively, so nested scoped layouts are discovered). diff --git a/extensions/agent-context/scripts/bash/update-agent-context.sh b/extensions/agent-context/scripts/bash/update-agent-context.sh index b7121a2f64..747a47a16d 100755 --- a/extensions/agent-context/scripts/bash/update-agent-context.sh +++ b/extensions/agent-context/scripts/bash/update-agent-context.sh @@ -12,7 +12,7 @@ # # When `plan_path` is omitted, the script derives it from `.specify/feature.json` # (written by /speckit-specify). Falls back to the most recently modified -# `specs/*/plan.md` only when feature.json is absent or its plan does not exist yet. +# `specs/**/plan.md` only when feature.json is absent or its plan does not exist yet. set -euo pipefail @@ -307,16 +307,28 @@ import sys from pathlib import Path root = Path(sys.argv[1]).resolve() specs = root / "specs" -plans = sorted( - specs.glob("*/plan.md"), - key=lambda p: p.stat().st_mtime, - reverse=True, -) -if plans: + +def _resolved_rel(p): + # Resolve symlinks before checking containment: relative_to() is lexical + # and would otherwise accept a plan reached through a specs/ symlink that + # points outside the project, emitting an in-project-looking path for an + # out-of-project file (or picking it as "most recent"). try: - print(plans[0].relative_to(root).as_posix()) - except ValueError: - print("") + return p.resolve().relative_to(root) + except (OSError, ValueError): + return None + +# Recurse (rather than the old one-level specs/*/plan.md glob) so scoped layouts +# created via SPECIFY_FEATURE_DIRECTORY, e.g. specs///plan.md, +# are still discovered when feature.json is absent (#3024). +candidates = [] +for p in specs.rglob("plan.md"): + rel = _resolved_rel(p) + if rel: + candidates.append((p, rel)) +candidates.sort(key=lambda pr: pr[0].stat().st_mtime, reverse=True) +if candidates: + print(candidates[0][1].as_posix()) else: print("") PY diff --git a/extensions/agent-context/scripts/powershell/update-agent-context.ps1 b/extensions/agent-context/scripts/powershell/update-agent-context.ps1 index 98a55c55fd..91d067cc41 100644 --- a/extensions/agent-context/scripts/powershell/update-agent-context.ps1 +++ b/extensions/agent-context/scripts/powershell/update-agent-context.ps1 @@ -12,7 +12,7 @@ # # When `plan_path` is omitted, the script derives it from `.specify/feature.json` # (written by /speckit-specify). Falls back to the most recently modified -# `specs/*/plan.md` only when feature.json is absent or its plan does not exist yet. +# `specs/**/plan.md` only when feature.json is absent or its plan does not exist yet. [CmdletBinding()] param( @@ -426,9 +426,11 @@ if (-not $PlanPath) { if (-not $PlanPath) { try { $specsDir = Join-Path $ProjectRoot 'specs' - $candidate = Get-ChildItem -Path $specsDir -Directory -ErrorAction SilentlyContinue | - ForEach-Object { Get-Item -LiteralPath (Join-Path $_.FullName 'plan.md') -ErrorAction SilentlyContinue } | - Where-Object { $_ } | + # Recurse (rather than the old one-level specs/*/plan.md scan) so scoped + # layouts created via SPECIFY_FEATURE_DIRECTORY, e.g. + # specs///plan.md, are still discovered when + # feature.json is absent (#3024). + $candidate = Get-ChildItem -Path $specsDir -Filter 'plan.md' -File -Recurse -ErrorAction SilentlyContinue | Sort-Object LastWriteTime -Descending | Select-Object -First 1 if ($candidate) { diff --git a/extensions/agent-context/scripts/python/update_agent_context.py b/extensions/agent-context/scripts/python/update_agent_context.py new file mode 100644 index 0000000000..15c0dceef9 --- /dev/null +++ b/extensions/agent-context/scripts/python/update_agent_context.py @@ -0,0 +1,352 @@ +#!/usr/bin/env python3 +"""Refresh the managed Spec Kit section in the coding agent's context file(s). + +Python port of ``update-agent-context.sh`` / ``update-agent-context.ps1``. + +Reads ``context_files`` or ``context_file``, plus ``context_markers.{start,end}``, +from the agent-context extension config: + .specify/extensions/agent-context/agent-context-config.yml + +Usage: update_agent_context.py [plan_path] + +When ``plan_path`` is omitted, the script derives it from +``.specify/feature.json`` (written by /speckit-specify). Falls back to the most +recently modified ``specs/*/plan.md`` only when feature.json is absent or its +plan does not exist yet. +""" + +from __future__ import annotations + +import json +import os +import re +import sys +from pathlib import Path + +DEFAULT_START = "" +DEFAULT_END = "" + + +def _err(message: str) -> None: + print(message, file=sys.stderr) + + +def _get_str(obj: object, *keys: str) -> str: + node = obj + for key in keys: + if isinstance(node, dict) and key in node: + node = node[key] + else: + return "" + return node if isinstance(node, str) else "" + + +def _collect_context_files(data: dict, project_root: str) -> list[str]: + """Resolve the managed context files from config, mirroring the bash logic.""" + context_files: list[str] = [] + seen: set[str] = set() + case_insensitive = sys.platform.startswith(("win32", "cygwin", "msys")) + + def add(value: object) -> None: + if not isinstance(value, str): + return + candidate = value.strip() + if not candidate: + return + key = candidate.casefold() if case_insensitive else candidate + if key in seen: + return + context_files.append(candidate) + seen.add(key) + + raw_files = data.get("context_files") + if isinstance(raw_files, list): + for value in raw_files: + add(value) + if not context_files: + add(_get_str(data, "context_file")) + if not context_files: + # Self-seed: when the config declares no target, derive one from the + # active integration recorded in init-options.json, mapped through the + # bundled agent-context-defaults.json file. Independent of the Specify + # CLI by design. + integration_key = "" + try: + with open( + f"{project_root}/.specify/init-options.json", "r", encoding="utf-8" + ) as fh: + opts = json.load(fh) + if isinstance(opts, dict): + value = opts.get("integration") or opts.get("ai") or "" + integration_key = value if isinstance(value, str) else "" + except Exception: + integration_key = "" + if integration_key: + defaults_path = ( + f"{project_root}/.specify/extensions/agent-context/" + "agent-context-defaults.json" + ) + mapping = {} + try: + with open(defaults_path, "r", encoding="utf-8") as fh: + loaded = json.load(fh) + agents = loaded.get("agents", {}) if isinstance(loaded, dict) else {} + mapping = agents if isinstance(agents, dict) else {} + except Exception: + _err( + "agent-context: unable to read %s; cannot self-seed the context " + "file. Set context_file in the extension config." % defaults_path + ) + mapping = {} + add(mapping.get(integration_key, "") or "") + if not context_files: + _err( + "agent-context: no default context file is known for integration " + "%s. Set context_file in the extension config to choose one." + % integration_key + ) + return context_files + + +def _validate_context_file(project_root: str, context_file: str) -> str | None: + """Return an error message when the path escapes the project root.""" + if context_file.startswith("/") or re.match(r"^[A-Za-z]:", context_file): + return ( + "agent-context: context files must be project-relative paths; " + f"got '{context_file}'." + ) + if "\\" in context_file: + return ( + "agent-context: context files must not contain backslash separators; " + f"got '{context_file}'." + ) + if ".." in context_file.split("/"): + return ( + "agent-context: context files must not contain '..' path segments; " + f"got '{context_file}'." + ) + root = Path(project_root).resolve() + target = (root / context_file).resolve() + try: + target.relative_to(root) + except ValueError: + return ( + "agent-context: context file path resolves outside the project root; " + f"got '{context_file}'." + ) + return None + + +def _resolve_plan_path(project_root: str) -> str: + """Derive the plan path: feature.json first, then the mtime fallback.""" + plan_path = "" + feature_json = Path(project_root) / ".specify" / "feature.json" + if feature_json.is_file(): + feature_dir = "" + try: + with open(feature_json, "r", encoding="utf-8") as fh: + data = json.load(fh) + value = data.get("feature_directory", "") + feature_dir = value if isinstance(value, str) else "" + except Exception: + feature_dir = "" + # Normalize backslashes (written by PS on Windows) before path ops. + feature_dir = feature_dir.replace("\\", "/").rstrip("/") + if feature_dir: + # feature_directory may be relative or absolute (absolute paths + # outside the project root are preserved as-is), including + # drive-qualified paths (C:/...) written by PowerShell on Windows. + if feature_dir.startswith("/") or re.match(r"^[A-Za-z]:/", feature_dir): + candidate = Path(feature_dir) / "plan.md" + else: + candidate = Path(project_root) / feature_dir / "plan.md" + if candidate.is_file(): + # Resolve symlinks before comparing so paths like /var/… vs + # /private/var/… (macOS) are treated as equivalent. + root = Path(project_root).resolve() + resolved = candidate.resolve() + try: + plan_path = resolved.relative_to(root).as_posix() + except ValueError: + plan_path = resolved.as_posix() + + if not plan_path: + root = Path(project_root).resolve() + plans = sorted( + (root / "specs").glob("*/plan.md"), + key=lambda p: p.stat().st_mtime, + reverse=True, + ) + if plans: + try: + plan_path = plans[0].relative_to(root).as_posix() + except ValueError: + plan_path = "" + return plan_path + + +def _build_section(marker_start: str, marker_end: str, plan_path: str) -> str: + lines = [ + marker_start, + "For additional context about technologies to be used, project structure,", + "shell commands, and other important information, read the current plan", + ] + if plan_path: + lines.append(f"at {plan_path}") + lines.append(marker_end) + return "\n".join(lines) + "\n" + + +def ensure_mdc_frontmatter(content: str) -> str: + """Ensure ``.mdc`` content has YAML frontmatter with ``alwaysApply: true``. + + Cursor only auto-loads ``.mdc`` rule files that carry frontmatter with + ``alwaysApply: true``. Prepend it when missing, or repair the value while + preserving any existing frontmatter comments/formatting. + """ + leading_ws = len(content) - len(content.lstrip()) + leading = content[:leading_ws] + stripped = content[leading_ws:] + + if not stripped.startswith("---"): + return "---\nalwaysApply: true\n---\n\n" + content + + match = re.match( + r"^(---[ \t]*\r?\n)(.*?)(\r?\n---[ \t]*)(\r?\n|$)(.*)", + stripped, + re.DOTALL, + ) + if not match: + return "---\nalwaysApply: true\n---\n\n" + content + + opening, fm_text, closing, sep, rest = match.groups() + newline = "\r\n" if "\r\n" in opening else "\n" + + if re.search(r"(?m)^[ \t]*alwaysApply[ \t]*:[ \t]*true[ \t]*(?:#.*)?$", fm_text): + return content + + if re.search(r"(?m)^[ \t]*alwaysApply[ \t]*:", fm_text): + fm_text = re.sub( + r"(?m)^([ \t]*)alwaysApply[ \t]*:.*?([ \t]*(?:#.*)?)$", + r"\1alwaysApply: true\2", + fm_text, + count=1, + ) + elif fm_text.strip(): + fm_text = fm_text + newline + "alwaysApply: true" + else: + fm_text = "alwaysApply: true" + + return f"{leading}{opening}{fm_text}{closing}{sep}{rest}" + + +def _upsert_section( + ctx_path: str, marker_start: str, marker_end: str, section: str +) -> None: + """Insert or replace the managed section, then normalize and write.""" + if os.path.exists(ctx_path): + with open(ctx_path, "r", encoding="utf-8-sig") as fh: + content = fh.read() + s = content.find(marker_start) + e = content.find(marker_end, s if s != -1 else 0) + if s != -1 and e != -1 and e > s: + end_of_marker = e + len(marker_end) + if end_of_marker < len(content) and content[end_of_marker] == "\r": + end_of_marker += 1 + if end_of_marker < len(content) and content[end_of_marker] == "\n": + end_of_marker += 1 + new_content = content[:s] + section + content[end_of_marker:] + elif s != -1: + new_content = content[:s] + section + elif e != -1: + end_of_marker = e + len(marker_end) + if end_of_marker < len(content) and content[end_of_marker] == "\r": + end_of_marker += 1 + if end_of_marker < len(content) and content[end_of_marker] == "\n": + end_of_marker += 1 + new_content = section + content[end_of_marker:] + else: + if content and not content.endswith("\n"): + content += "\n" + new_content = (content + "\n" + section) if content else section + else: + new_content = section + + new_content = new_content.replace("\r\n", "\n").replace("\r", "\n") + if ctx_path.casefold().endswith(".mdc"): + new_content = ensure_mdc_frontmatter(new_content) + with open(ctx_path, "wb") as fh: + fh.write(new_content.encode("utf-8")) + + +def main(argv: list[str] | None = None) -> int: + args = sys.argv[1:] if argv is None else argv + project_root = os.getcwd() + ext_config = ( + f"{project_root}/.specify/extensions/agent-context/agent-context-config.yml" + ) + + if not os.path.isfile(ext_config): + _err(f"agent-context: {ext_config} not found; nothing to do.") + return 0 + + try: + import yaml + except ImportError: + _err( + "agent-context: PyYAML is required to parse extension config but is " + "not available in the current Python environment.\n" + " To resolve: pip install pyyaml (or install it into the environment " + "used by python3).\n" + " Context file will not be updated until PyYAML is importable." + ) + _err("agent-context: skipping update (see above for details).") + return 0 + + try: + with open(ext_config, "r", encoding="utf-8") as fh: + data = yaml.safe_load(fh) + except Exception as exc: + _err( + f"agent-context: unable to parse {ext_config} ({exc}); " + "cannot update context." + ) + _err("agent-context: skipping update (see above for details).") + return 0 + if not isinstance(data, dict): + data = {} + + context_files = _collect_context_files(data, project_root) + if not context_files: + _err( + "agent-context: context_files/context_file not set in extension config; " + "nothing to do." + ) + return 0 + + for context_file in context_files: + error = _validate_context_file(project_root, context_file) + if error: + _err(error) + return 1 + + marker_start = _get_str(data, "context_markers", "start") or DEFAULT_START + marker_end = _get_str(data, "context_markers", "end") or DEFAULT_END + + plan_path = args[0] if args else "" + if not plan_path: + plan_path = _resolve_plan_path(project_root) + + section = _build_section(marker_start, marker_end, plan_path) + + for context_file in context_files: + ctx_path = os.path.join(project_root, context_file) + os.makedirs(os.path.dirname(ctx_path) or ".", exist_ok=True) + _upsert_section(ctx_path, marker_start, marker_end, section) + print(f"agent-context: updated {context_file}") + + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/extensions/catalog.community.json b/extensions/catalog.community.json index 81ba3ac2b5..1da0265966 100644 --- a/extensions/catalog.community.json +++ b/extensions/catalog.community.json @@ -1,6 +1,6 @@ { "schema_version": "1.0", - "updated_at": "2026-07-01T00:00:00Z", + "updated_at": "2026-07-15T14:10:00Z", "catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/extensions/catalog.community.json", "extensions": { "aide": { @@ -395,6 +395,66 @@ "created_at": "2026-03-03T00:00:00Z", "updated_at": "2026-03-03T00:00:00Z" }, + "bdd": { + "name": "Spec-Kit BDD", + "id": "bdd", + "description": "ATDD/BDD extension: convert specs to Gherkin scenarios, scaffold step definitions, and verify acceptance test coverage.", + "author": "RSginer", + "version": "1.0.2", + "download_url": "https://github.com/RSginer/spec-kit-bdd/archive/refs/tags/v1.0.2.zip", + "repository": "https://github.com/RSginer/spec-kit-bdd", + "homepage": "https://github.com/RSginer/spec-kit-bdd", + "documentation": "https://github.com/RSginer/spec-kit-bdd/blob/main/docs/usage.md", + "changelog": "https://github.com/RSginer/spec-kit-bdd/releases", + "license": "MIT", + "category": "process", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.2.0", + "tools": [ + { + "name": "pytest-bdd", + "required": false + }, + { + "name": "behave", + "required": false + }, + { + "name": "@cucumber/cucumber", + "required": false + }, + { + "name": "cucumber", + "required": false + }, + { + "name": "io.cucumber", + "required": false + }, + { + "name": "SpecFlow", + "required": false + } + ] + }, + "provides": { + "commands": 3, + "hooks": 2 + }, + "tags": [ + "bdd", + "gherkin", + "atdd", + "acceptance-testing", + "tdd" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-15T00:00:00Z", + "updated_at": "2026-07-15T00:00:00Z" + }, "blueprint": { "name": "Blueprint", "id": "blueprint", @@ -670,6 +730,40 @@ "created_at": "2026-04-11T18:00:00Z", "updated_at": "2026-04-11T18:00:00Z" }, + "charter": { + "name": "Charter", + "id": "charter", + "description": "Compose modular project constitutions from shared fragment registries. Centralize governance rules, select per-project fragments, track upstream changes, and keep multi-project setups consistent.", + "author": "Fyloss", + "version": "0.3.1", + "download_url": "https://github.com/Fyloss/spec-kit-charter/archive/refs/tags/v0.3.1.zip", + "repository": "https://github.com/Fyloss/spec-kit-charter", + "homepage": "https://github.com/Fyloss/spec-kit-charter", + "documentation": "https://github.com/Fyloss/spec-kit-charter/tree/master/docs", + "changelog": "https://github.com/Fyloss/spec-kit-charter/blob/master/CHANGELOG.md", + "license": "MIT", + "category": "process", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.11.9" + }, + "provides": { + "commands": 5, + "hooks": 1 + }, + "tags": [ + "constitution", + "governance", + "modular", + "fragments", + "registry" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-06T00:00:00Z", + "updated_at": "2026-07-06T00:00:00Z" + }, "ci-guard": { "name": "CI Guard", "id": "ci-guard", @@ -775,8 +869,8 @@ "id": "coding-standards-drift-control", "description": "Generate coding-standards drift reports and remediation tasks for active Spec Kit features", "author": "Igor Benicio de Mesquita", - "version": "0.3.1", - "download_url": "https://github.com/benizzio/spec-kit-coding-standards-drift-control/archive/refs/tags/v0.3.1.zip", + "version": "0.4.0", + "download_url": "https://github.com/benizzio/spec-kit-coding-standards-drift-control/archive/refs/tags/v0.4.0.zip", "repository": "https://github.com/benizzio/spec-kit-coding-standards-drift-control", "homepage": "https://github.com/benizzio/spec-kit-coding-standards-drift-control", "documentation": "https://github.com/benizzio/spec-kit-coding-standards-drift-control#readme", @@ -801,7 +895,7 @@ "downloads": 0, "stars": 0, "created_at": "2026-06-11T00:00:00Z", - "updated_at": "2026-06-11T00:00:00Z" + "updated_at": "2026-07-15T00:00:00Z" }, "companion": { "name": "SpecKit Companion", @@ -1072,10 +1166,10 @@ "docguard": { "name": "DocGuard — CDD Enforcement", "id": "docguard", - "description": "Canonical-Driven Development enforcement. Validates, scores, and traces project documentation with automated checks, AI-driven workflows, and spec-kit hooks. One pinned runtime dependency; pure Node.js otherwise.", + "description": "Doc-integrity engine with MCP server, SARIF output, and zero-LLM core. Validates, scores, and traces documentation against code — 24 validators, stable finding codes, spec-kit hooks. Pure Node.js.", "author": "raccioly", - "version": "0.28.0", - "download_url": "https://github.com/raccioly/docguard/releases/download/v0.28.0/spec-kit-docguard-v0.28.0.zip", + "version": "0.32.0", + "download_url": "https://github.com/raccioly/docguard/releases/download/v0.32.0/spec-kit-docguard-v0.32.0.zip", "repository": "https://github.com/raccioly/docguard", "homepage": "https://www.npmjs.com/package/docguard-cli", "documentation": "https://github.com/raccioly/docguard/blob/main/extensions/spec-kit-docguard/README.md", @@ -1090,6 +1184,14 @@ "name": "node", "version": ">=18.0.0", "required": true + }, + { + "name": "npx", + "required": true + }, + { + "name": "specify", + "required": false } ] }, @@ -1111,7 +1213,7 @@ "downloads": 0, "stars": 0, "created_at": "2026-03-13T00:00:00Z", - "updated_at": "2026-06-23T00:00:00Z" + "updated_at": "2026-07-13T00:00:00Z" }, "doctor": { "name": "Project Health Check", @@ -1146,6 +1248,39 @@ "created_at": "2026-03-13T00:00:00Z", "updated_at": "2026-03-13T00:00:00Z" }, + "ears": { + "name": "EARS Requirements Syntax", + "id": "ears", + "description": "Author, lint, and convert requirements using EARS (Easy Approach to Requirements Syntax) - the five industry-standard sentence patterns for unambiguous, testable requirements.", + "author": "dhruv-15-03", + "version": "1.0.0", + "download_url": "https://github.com/dhruv-15-03/spec-kit-ears/archive/refs/tags/v1.0.0.zip", + "repository": "https://github.com/dhruv-15-03/spec-kit-ears", + "homepage": "https://github.com/dhruv-15-03/spec-kit-ears", + "documentation": "https://github.com/dhruv-15-03/spec-kit-ears/blob/main/README.md", + "changelog": "https://github.com/dhruv-15-03/spec-kit-ears/blob/main/CHANGELOG.md", + "license": "MIT", + "category": "docs", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.9.0" + }, + "provides": { + "commands": 3, + "hooks": 0 + }, + "tags": [ + "ears", + "requirements", + "specification", + "quality" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-08T00:00:00Z", + "updated_at": "2026-07-08T00:00:00Z" + }, "extensify": { "name": "Extensify", "id": "extensify", @@ -1179,6 +1314,84 @@ "created_at": "2026-03-18T00:00:00Z", "updated_at": "2026-04-23T00:00:00Z" }, + "figma": { + "name": "Spec Kit Figma", + "id": "figma", + "description": "Agent-agnostic SpecKit extension that grounds spec, plan & task generation in Figma design context — REST + optional MCP, single/mono/multi-repo, macOS/Linux/Windows.", + "author": "Fyloss", + "version": "1.6.0", + "download_url": "https://github.com/Fyloss/spec-kit-figma/archive/refs/tags/v1.6.0.zip", + "repository": "https://github.com/Fyloss/spec-kit-figma", + "homepage": "https://github.com/Fyloss/spec-kit-figma", + "documentation": "https://github.com/Fyloss/spec-kit-figma/blob/main/docs/INSTALL.md", + "changelog": "https://github.com/Fyloss/spec-kit-figma/blob/main/CHANGELOG.md", + "license": "MIT", + "category": "integration", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.1.0", + "tools": [ + { "name": "git", "required": true }, + { "name": "bash", "required": false }, + { "name": "curl", "required": false }, + { "name": "jq", "required": false }, + { "name": "pwsh", "required": false } + ] + }, + "provides": { + "commands": 5, + "hooks": 6 + }, + "tags": [ + "figma", + "design", + "frontend", + "ui", + "design-system" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-08T00:00:00Z", + "updated_at": "2026-07-08T00:00:00Z" + }, + "figma-starter": { + "name": "Figma Starter", + "id": "figma-starter", + "description": "Turns a Figma section's screens into per-screen spec.md files, an app-level user-stories.md, and a build-order.md, then hands off to /speckit.specify.", + "author": "WaveMaker", + "version": "1.0.0", + "download_url": "https://github.com/wavemaker/spec-kit-figma-starter/archive/refs/tags/v1.0.0.zip", + "repository": "https://github.com/wavemaker/spec-kit-figma-starter", + "homepage": "https://github.com/wavemaker/spec-kit-figma-starter", + "documentation": "https://github.com/wavemaker/spec-kit-figma-starter/blob/main/README.md", + "changelog": "https://github.com/wavemaker/spec-kit-figma-starter/blob/main/CHANGELOG.md", + "license": "MIT", + "category": "integration", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.1.0", + "tools": [ + { "name": "python3", "version": ">=3.8", "required": true } + ] + }, + "provides": { + "commands": 1, + "hooks": 1 + }, + "tags": [ + "figma", + "design", + "design-to-spec", + "ui", + "frontend" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-15T00:00:00Z", + "updated_at": "2026-07-15T00:00:00Z" + }, "fix-findings": { "name": "Fix Findings", "id": "fix-findings", @@ -1319,6 +1532,58 @@ "created_at": "2026-05-06T00:00:00Z", "updated_at": "2026-05-06T00:00:00Z" }, + "gates": { + "name": "Quality Gates (Enforcement Layer)", + "id": "gates", + "description": "Deterministic quality enforcement for Spec Kit across agent hooks, git checks, and CI pipelines with one policy file and one verify entrypoint for identical results at every boundary.", + "author": "schwichtgit", + "version": "0.3.2", + "download_url": "https://github.com/schwichtgit/spec-gates/releases/download/v0.3.2/gates-0.3.2.zip", + "repository": "https://github.com/schwichtgit/spec-gates", + "homepage": "https://github.com/schwichtgit/spec-gates", + "documentation": "https://github.com/schwichtgit/spec-gates/blob/main/docs/how-it-works.md", + "changelog": "https://github.com/schwichtgit/spec-gates/releases", + "license": "MIT", + "category": "process", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.12.0", + "tools": [ + { + "name": "jq", + "required": true + }, + { + "name": "git", + "required": false + }, + { + "name": "node", + "required": false + }, + { + "name": "shellcheck", + "required": false + } + ] + }, + "provides": { + "commands": 8, + "hooks": 2 + }, + "tags": [ + "quality", + "enforcement", + "hooks", + "ci", + "governance" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-09T00:00:00Z", + "updated_at": "2026-07-15T00:00:00Z" + }, "github-issues": { "name": "GitHub Issues Integration 1", "id": "github-issues", @@ -1364,10 +1629,10 @@ "golden-demo": { "name": "Golden Demo", "id": "golden-demo", - "description": "Extracts acceptance criteria from specs, builds test vectors, and produces a behavioral drift report — complementary to Architecture Guard and CDD.", + "description": "Deterministic behavioral drift oracle. Extracts acceptance criteria, generates fuzz test vectors (seed=42), compares golden Python implementations against real code in any language. CI/CD gatekeeper with warn/strict modes.", "author": "jasstt", - "version": "0.1.1", - "download_url": "https://github.com/jasstt/spec-kit-golden-demo/archive/refs/tags/v0.1.1.zip", + "version": "0.3.0", + "download_url": "https://github.com/jasstt/spec-kit-golden-demo/archive/refs/tags/v0.3.0.zip", "repository": "https://github.com/jasstt/spec-kit-golden-demo", "homepage": "https://github.com/jasstt/spec-kit-golden-demo", "documentation": "https://github.com/jasstt/spec-kit-golden-demo", @@ -1378,13 +1643,16 @@ "speckit_version": ">=0.1.0" }, "provides": { - "commands": 2, + "commands": 3, "hooks": 2 }, "tags": [ "testing", "drift-detection", "behavioral-oracle", + "fuzzing", + "ci-cd", + "cross-language", "tdd", "quality" ], @@ -1392,7 +1660,7 @@ "downloads": 0, "stars": 0, "created_at": "2026-06-24T00:00:00Z", - "updated_at": "2026-06-24T00:00:00Z" + "updated_at": "2026-07-07T00:00:00Z" }, "harness": { "name": "Research Harness", @@ -2106,6 +2374,42 @@ "created_at": "2026-05-08T00:00:00Z", "updated_at": "2026-05-08T00:00:00Z" }, + "memory": { + "name": "Spec Kit Memory", + "id": "memory", + "description": "Recalls prior specs and decisions from configurable memory tools (e.g. memsearch) before SDLC stages, so planning and specification start from what the project already knows.", + "author": "Andrey Zaytsev", + "version": "0.3.0", + "download_url": "https://github.com/zaytsevand/spec-kit-memory/archive/refs/tags/v0.3.0.zip", + "repository": "https://github.com/zaytsevand/spec-kit-memory", + "homepage": "https://github.com/zaytsevand/spec-kit-memory", + "documentation": "https://github.com/zaytsevand/spec-kit-memory/blob/main/README.md", + "changelog": "", + "license": "MIT", + "category": "docs", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.2.0", + "tools": [ + { "name": "memsearch", "required": false } + ] + }, + "provides": { + "commands": 2, + "hooks": 3 + }, + "tags": [ + "memory", + "recall", + "research", + "memsearch" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-10T00:00:00Z", + "updated_at": "2026-07-10T00:00:00Z" + }, "memory-loader": { "name": "Memory Loader", "id": "memory-loader", @@ -2260,6 +2564,48 @@ "created_at": "2026-05-04T02:51:52Z", "updated_at": "2026-06-18T00:00:00Z" }, + "multi-repo-sync": { + "name": "Multi-Repo Branch Sync", + "id": "multi-repo-sync", + "description": "Creates the feature branch in affected sub-repositories and git submodules via plan/tasks hooks", + "author": "Fyloss", + "version": "1.0.0", + "download_url": "https://github.com/fyloss/spec-kit-multi-repo-sync/releases/download/v1.0.0/spec-kit-multi-repo-sync.zip", + "sha256": "12a5c7392145b4424b20715aaa3d8b6a8218c143dea596873e344146c1a76ba0", + "repository": "https://github.com/fyloss/spec-kit-multi-repo-sync", + "homepage": "https://github.com/fyloss/spec-kit-multi-repo-sync", + "documentation": "https://github.com/fyloss/spec-kit-multi-repo-sync/blob/main/README.md", + "changelog": "https://github.com/fyloss/spec-kit-multi-repo-sync/blob/main/CHANGELOG.md", + "license": "MIT", + "category": "process", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.2.0", + "tools": [ + { + "name": "git", + "version": ">=2.31", + "required": true + } + ] + }, + "provides": { + "commands": 3, + "hooks": 2 + }, + "tags": [ + "git", + "branching", + "multi-repo", + "submodules", + "workflow" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-13T00:00:00Z", + "updated_at": "2026-07-13T00:00:00Z" + }, "multi-sites": { "name": "Multi-Sites Spec Kit", "id": "multi-sites", @@ -2362,6 +2708,39 @@ "created_at": "2026-04-03T00:00:00Z", "updated_at": "2026-04-03T00:00:00Z" }, + "orchestration-task-context-management": { + "name": "Orchestration Task Context Management", + "id": "orchestration-task-context-management", + "description": "Adds subagent work-unit orchestration to generated Spec Kit task files", + "author": "Igor Benicio de Mesquita", + "version": "0.0.0", + "download_url": "https://github.com/benizzio/spec-kit-orchestration-task-context-management/archive/refs/tags/v0.0.0.zip", + "repository": "https://github.com/benizzio/spec-kit-orchestration-task-context-management", + "homepage": "https://github.com/benizzio/spec-kit-orchestration-task-context-management", + "documentation": "https://github.com/benizzio/spec-kit-orchestration-task-context-management/blob/main/README.md", + "changelog": "https://github.com/benizzio/spec-kit-orchestration-task-context-management/blob/main/CHANGELOG.md", + "license": "MIT", + "category": "process", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.7.2" + }, + "provides": { + "commands": 2, + "hooks": 2 + }, + "tags": [ + "agent", + "orchestration", + "tasks", + "context" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-06T00:00:00Z", + "updated_at": "2026-07-06T00:00:00Z" + }, "orchestrator": { "name": "Spec Orchestrator", "id": "orchestrator", @@ -2396,6 +2775,46 @@ "created_at": "2026-04-24T14:00:00Z", "updated_at": "2026-04-24T14:00:00Z" }, + "patchwarden-evidence": { + "name": "PatchWarden Evidence Pack", + "id": "patchwarden-evidence", + "description": "Map Spec Kit tasks into a guarded PatchWarden Goal and export bounded, traceable evidence for an accepted lineage.", + "author": "Zengjie", + "version": "1.0.1", + "download_url": "https://github.com/jiezeng2004-design/spec-kit-patchwarden/archive/refs/tags/v1.0.1.zip", + "repository": "https://github.com/jiezeng2004-design/spec-kit-patchwarden", + "homepage": "https://github.com/jiezeng2004-design/spec-kit-patchwarden", + "documentation": "https://github.com/jiezeng2004-design/spec-kit-patchwarden/blob/main/README.md", + "changelog": "https://github.com/jiezeng2004-design/spec-kit-patchwarden/blob/main/CHANGELOG.md", + "license": "MIT", + "category": "process", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.1.0", + "tools": [ + { + "name": "patchwarden", + "version": ">=1.5.1", + "required": true + } + ] + }, + "provides": { + "commands": 2, + "hooks": 2 + }, + "tags": [ + "verification", + "evidence", + "traceability", + "security" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-14T00:00:00Z", + "updated_at": "2026-07-14T00:00:00Z" + }, "plan-review-gate": { "name": "Plan Review Gate", "id": "plan-review-gate", @@ -2679,8 +3098,8 @@ "id": "ralph", "description": "Autonomous implementation loop using AI agent CLI", "author": "Rubiss", - "version": "1.1.1", - "download_url": "https://github.com/Rubiss-Projects/spec-kit-ralph/archive/refs/tags/v1.1.1.zip", + "version": "1.2.1", + "download_url": "https://github.com/Rubiss-Projects/spec-kit-ralph/archive/refs/tags/v1.2.1.zip", "repository": "https://github.com/Rubiss-Projects/spec-kit-ralph", "homepage": "https://github.com/Rubiss-Projects/spec-kit-ralph", "documentation": "https://github.com/Rubiss-Projects/spec-kit-ralph/blob/main/README.md", @@ -2689,7 +3108,7 @@ "category": "code", "effect": "read-write", "requires": { - "speckit_version": ">=0.1.0", + "speckit_version": ">=0.8.5", "tools": [ { "name": "copilot", @@ -2699,6 +3118,10 @@ "name": "codex", "required": false }, + { + "name": "claude", + "required": false + }, { "name": "git", "required": true @@ -2714,13 +3137,14 @@ "automation", "loop", "copilot", - "codex" + "codex", + "claude" ], "verified": false, "downloads": 0, "stars": 0, "created_at": "2026-03-09T00:00:00Z", - "updated_at": "2026-06-05T03:11:06Z" + "updated_at": "2026-07-06T00:00:00Z" }, "reconcile": { "name": "Reconcile Extension", @@ -3047,10 +3471,10 @@ "ripple": { "name": "Ripple", "id": "ripple", - "description": "Detect side effects that tests can't catch after implementation — delta-anchored analysis across 9 domain-agnostic categories with fix-induced side effect detection", + "description": "Detect side effects that tests can't catch after implementation — surface hidden ripple effects across 9 analysis categories", "author": "chordpli", - "version": "1.0.0", - "download_url": "https://github.com/chordpli/spec-kit-ripple/archive/refs/tags/v1.0.0.zip", + "version": "1.1.0", + "download_url": "https://github.com/chordpli/spec-kit-ripple/archive/refs/tags/v1.1.0.zip", "repository": "https://github.com/chordpli/spec-kit-ripple", "homepage": "https://github.com/chordpli/spec-kit-ripple", "documentation": "https://github.com/chordpli/spec-kit-ripple/blob/main/README.md", @@ -3059,7 +3483,13 @@ "category": "code", "effect": "read-write", "requires": { - "speckit_version": ">=0.2.0" + "speckit_version": ">=0.2.0", + "tools": [ + { + "name": "git", + "required": true + } + ] }, "provides": { "commands": 3, @@ -3076,7 +3506,7 @@ "downloads": 0, "stars": 0, "created_at": "2026-04-20T00:00:00Z", - "updated_at": "2026-04-20T00:00:00Z" + "updated_at": "2026-07-06T00:00:00Z" }, "roadmap": { "name": "Spec Roadmap", @@ -4201,6 +4631,40 @@ "created_at": "2026-03-03T00:00:00Z", "updated_at": "2026-04-09T00:00:00Z" }, + "verify-review-ship": { + "name": "Verify Review Ship", + "id": "verify-review-ship", + "description": "Adds post-implementation verify, review, and ship readiness gates to Spec Kit workflows.", + "author": "Carlos Eduardo Gevaerd Araujo", + "version": "0.1.0", + "download_url": "https://github.com/cadugevaerd/spec-kit-verify-review-ship/archive/refs/tags/v0.1.0.zip", + "repository": "https://github.com/cadugevaerd/spec-kit-verify-review-ship", + "homepage": "https://github.com/cadugevaerd/spec-kit-verify-review-ship", + "documentation": "https://github.com/cadugevaerd/spec-kit-verify-review-ship/blob/main/README.md", + "changelog": "https://github.com/cadugevaerd/spec-kit-verify-review-ship/blob/main/CHANGELOG.md", + "license": "MIT", + "category": "process", + "effect": "read-only", + "requires": { + "speckit_version": ">=0.1.0" + }, + "provides": { + "commands": 3, + "hooks": 1 + }, + "tags": [ + "quality", + "review", + "shipping", + "workflow", + "testing" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-10T00:00:00Z", + "updated_at": "2026-07-10T00:00:00Z" + }, "verify-tasks": { "name": "Verify Tasks Extension", "id": "verify-tasks", @@ -4297,6 +4761,40 @@ "created_at": "2026-04-13T00:00:00Z", "updated_at": "2026-04-13T00:00:00Z" }, + "wiki": { + "name": "LLM Wiki", + "id": "wiki", + "description": "LLM-maintained compounding project wiki: source ingestion, cited answers, and consistency linting", + "author": "formin", + "version": "1.0.0", + "download_url": "https://github.com/formin/spec-kit-wiki/archive/refs/tags/v1.0.0.zip", + "repository": "https://github.com/formin/spec-kit-wiki", + "homepage": "https://github.com/formin/spec-kit-wiki", + "documentation": "https://github.com/formin/spec-kit-wiki/blob/main/README.md", + "changelog": "https://github.com/formin/spec-kit-wiki/blob/main/CHANGELOG.md", + "license": "MIT", + "category": "docs", + "effect": "read-write", + "requires": { + "speckit_version": ">=0.2.0" + }, + "provides": { + "commands": 5, + "hooks": 2 + }, + "tags": [ + "wiki", + "knowledge-base", + "docs", + "memory", + "context-management" + ], + "verified": false, + "downloads": 0, + "stars": 0, + "created_at": "2026-07-06T00:00:00Z", + "updated_at": "2026-07-06T00:00:00Z" + }, "wireframe": { "name": "Wireframe Visual Feedback Loop", "id": "wireframe", diff --git a/extensions/catalog.json b/extensions/catalog.json index 6ab98edb8f..a3fac30391 100644 --- a/extensions/catalog.json +++ b/extensions/catalog.json @@ -48,4 +48,4 @@ ] } } -} \ No newline at end of file +} diff --git a/extensions/git/README.md b/extensions/git/README.md index e2c53fb769..b5df3e31ee 100644 --- a/extensions/git/README.md +++ b/extensions/git/README.md @@ -7,7 +7,7 @@ Git repository initialization, feature branch creation, numbering (sequential/ti This extension provides Git operations as an optional, self-contained module. It manages: - **Repository initialization** with configurable commit messages -- **Feature branch creation** with sequential (`001-feature-name`) or timestamp (`20260319-143022-feature-name`) numbering +- **Feature branch creation** with sequential (`001-feature-name`) or timestamp (`20260319-143022-feature-name`) numbering and optional templates for branch namespaces - **Branch validation** to ensure branches follow naming conventions - **Git remote detection** for GitHub integration (e.g., issue creation) - **Auto-commit** after core commands (configurable per-command with custom messages) @@ -53,6 +53,16 @@ Configuration is stored in `.specify/extensions/git/git-config.yml`: # Branch numbering strategy: "sequential" or "timestamp" branch_numbering: sequential +# Optional branch name template. Leave empty for the default "{number}-{slug}". +# Supported tokens: {author}, {app}, {number}, {slug}; {slug} must not appear +# before {number}, and the final path segment must start with {number}-. +# Example for monorepos: "{author}/{app}/{number}-{slug}" +branch_template: "" + +# Optional shorthand namespace. Leave empty to use branch_template/default behavior. +# Example: "features/{app}" expands to "features/{app}/{number}-{slug}" +branch_prefix: "" + # Custom commit message for git init init_commit_message: "[Spec Kit] Initial commit" @@ -65,6 +75,10 @@ auto_commit: message: "[Spec Kit] Add specification" ``` +`{author}` is derived from Git config and sanitized for branch names. `{app}` is derived from the Spec Kit init directory name. Custom templates must not put `{slug}` before `{number}`, and must put `{number}-` at the start of the final path segment so generated names remain valid feature branches. For a monorepo project at `apps/web/.specify/`, a template such as `{author}/{app}/{number}-{slug}` produces branches like `jdoe/web/008-guided-tour`. + +For simple namespace-only customization, `branch_prefix` is also accepted as a shorthand and expands to `/{number}-{slug}`. + ## Installation ```bash diff --git a/extensions/git/commands/speckit.git.feature.md b/extensions/git/commands/speckit.git.feature.md index 27fdbd5f72..01f664f84b 100644 --- a/extensions/git/commands/speckit.git.feature.md +++ b/extensions/git/commands/speckit.git.feature.md @@ -19,7 +19,7 @@ You **MUST** consider the user input before proceeding (if not empty). If the user explicitly provided `GIT_BRANCH_NAME` (e.g., via environment variable, argument, or in their request), pass it through to the script by setting the `GIT_BRANCH_NAME` environment variable before invoking the script. When `GIT_BRANCH_NAME` is set: - The script uses the exact value as the branch name, bypassing all prefix/suffix generation - `--short-name`, `--number`, and `--timestamp` flags are ignored -- `FEATURE_NUM` is extracted from the name if it starts with a numeric prefix, otherwise set to the full branch name +- `FEATURE_NUM` is extracted when the final path segment starts with a numeric or timestamp feature marker (for example `042-name`, `feat/042-name`, or `jdoe/app/042-name`), otherwise set to the full branch name ## Prerequisites @@ -35,6 +35,19 @@ Determine the branch numbering strategy by checking configuration in this order: 3. Check `.specify/init-options.json` for `branch_numbering` value (deprecated, backward compatibility — will be removed in a future release) 4. Default to `sequential` if none of the above exist +## Branch Name Template + +Check `.specify/extensions/git/git-config.yml` for an optional `branch_template` value. If it is empty or missing, use the default branch shape `{number}-{slug}`. If it is set, `{slug}` must not appear before `{number}`, its final path segment must start with `{number}-`, and the script expands these tokens: + +- `{author}`: sanitized Git config author (`user.name`, falling back to the email local part) +- `{app}`: sanitized Spec Kit init directory name +- `{number}`: sequential number or timestamp +- `{slug}`: generated short branch slug + +For monorepos, a template such as `{author}/{app}/{number}-{slug}` creates names like `jdoe/web/008-guided-tour` while preserving per-project feature numbering. + +The script also accepts `branch_prefix` as a shorthand for simple namespaces; it expands to `/{number}-{slug}`. + ## Execution Generate a concise short name (2-4 words) for the branch: @@ -54,6 +67,7 @@ Run the appropriate script based on your platform: - Always include the JSON flag (`--json` for Bash, `-Json` for PowerShell) so the output can be parsed reliably - You must only ever run this script once per feature - The JSON output will contain `BRANCH_NAME` and `FEATURE_NUM` +- Do not manually expand `branch_template`; the script reads the git extension config and applies it consistently ## Graceful Degradation @@ -64,5 +78,5 @@ If Git is not installed or the current directory is not a Git repository: ## Output The script outputs JSON with: -- `BRANCH_NAME`: The branch name (e.g., `003-user-auth` or `20260319-143022-user-auth`) +- `BRANCH_NAME`: The branch name (e.g., `003-user-auth`, `20260319-143022-user-auth`, or `jdoe/web/003-user-auth`) - `FEATURE_NUM`: The numeric or timestamp prefix used diff --git a/extensions/git/commands/speckit.git.validate.md b/extensions/git/commands/speckit.git.validate.md index dd84618cb8..c7feeb2600 100644 --- a/extensions/git/commands/speckit.git.validate.md +++ b/extensions/git/commands/speckit.git.validate.md @@ -22,24 +22,24 @@ Get the current branch name: git rev-parse --abbrev-ref HEAD ``` -The branch name must match one of these patterns: +The branch name's final path segment must start with one of these feature markers: -1. **Sequential**: `^[0-9]{3,}-` (e.g., `001-feature-name`, `042-fix-bug`, `1000-big-feature`) -2. **Timestamp**: `^[0-9]{8}-[0-9]{6}-` (e.g., `20260319-143022-feature-name`) +1. **Sequential**: `[0-9]{3,}-` (e.g., `001-feature-name`, `042-fix-bug`, `1000-big-feature`, `jdoe/web/008-guided-tour`) +2. **Timestamp**: `[0-9]{8}-[0-9]{6}-` (e.g., `20260319-143022-feature-name`, `jdoe/web/20260319-143022-feature-name`) ## Execution If on a feature branch (matches either pattern): - Output: `✓ On feature branch: ` - Check if the corresponding spec directory exists under `specs/`: - - For sequential branches, look for `specs/-*` where prefix matches the numeric portion - - For timestamp branches, look for `specs/-*` where prefix matches the `YYYYMMDD-HHMMSS` portion + - For sequential branches, look for `specs/-*` where prefix matches the numeric portion, regardless of branch namespace prefixes + - For timestamp branches, look for `specs/-*` where prefix matches the `YYYYMMDD-HHMMSS` portion, regardless of branch namespace prefixes - If spec directory exists: `✓ Spec directory found: ` - If spec directory missing: `⚠ No spec directory found for prefix ` If NOT on a feature branch: - Output: `✗ Not on a feature branch. Current branch: ` -- Output: `Feature branches should be named like: 001-feature-name or 20260319-143022-feature-name` +- Output: `Feature branches should be named like: 001-feature-name, 20260319-143022-feature-name, or /001-feature-name` ## Graceful Degradation diff --git a/extensions/git/config-template.yml b/extensions/git/config-template.yml index 8c414babe6..99e3d31692 100644 --- a/extensions/git/config-template.yml +++ b/extensions/git/config-template.yml @@ -4,6 +4,16 @@ # Branch numbering strategy: "sequential" (001, 002, ...) or "timestamp" (YYYYMMDD-HHMMSS) branch_numbering: sequential +# Optional branch name template. Leave empty for the default "{number}-{slug}". +# Supported tokens: {author}, {app}, {number}, {slug} +# {slug} must not appear before {number}; final path segment must start with {number}-. +# Example for monorepos: "{author}/{app}/{number}-{slug}" +branch_template: "" + +# Optional shorthand namespace. Leave empty to use branch_template/default behavior. +# Example: "features/{app}" expands to "features/{app}/{number}-{slug}" +branch_prefix: "" + # Commit message used by `git commit` during repository initialization init_commit_message: "[Spec Kit] Initial commit" diff --git a/extensions/git/extension.yml b/extensions/git/extension.yml index 13c1977ea1..c92322d8b1 100644 --- a/extensions/git/extension.yml +++ b/extensions/git/extension.yml @@ -4,7 +4,7 @@ extension: id: git name: "Git Branching Workflow" version: "1.0.0" - description: "Feature branch creation, numbering (sequential/timestamp), validation, and Git remote detection" + description: "Feature branch creation, numbering (sequential/timestamp), templating, validation, and Git remote detection" author: spec-kit-core repository: https://github.com/github/spec-kit license: MIT @@ -19,7 +19,7 @@ provides: commands: - name: speckit.git.feature file: commands/speckit.git.feature.md - description: "Create a feature branch with sequential or timestamp numbering" + description: "Create a feature branch with sequential or timestamp numbering and optional templates" - name: speckit.git.validate file: commands/speckit.git.validate.md description: "Validate current branch follows feature branch naming conventions" @@ -137,4 +137,6 @@ tags: config: defaults: branch_numbering: sequential + branch_template: "" + branch_prefix: "" init_commit_message: "[Spec Kit] Initial commit" diff --git a/extensions/git/git-config.yml b/extensions/git/git-config.yml index 8c414babe6..99e3d31692 100644 --- a/extensions/git/git-config.yml +++ b/extensions/git/git-config.yml @@ -4,6 +4,16 @@ # Branch numbering strategy: "sequential" (001, 002, ...) or "timestamp" (YYYYMMDD-HHMMSS) branch_numbering: sequential +# Optional branch name template. Leave empty for the default "{number}-{slug}". +# Supported tokens: {author}, {app}, {number}, {slug} +# {slug} must not appear before {number}; final path segment must start with {number}-. +# Example for monorepos: "{author}/{app}/{number}-{slug}" +branch_template: "" + +# Optional shorthand namespace. Leave empty to use branch_template/default behavior. +# Example: "features/{app}" expands to "features/{app}/{number}-{slug}" +branch_prefix: "" + # Commit message used by `git commit` during repository initialization init_commit_message: "[Spec Kit] Initial commit" diff --git a/extensions/git/scripts/bash/create-new-feature-branch.sh b/extensions/git/scripts/bash/create-new-feature-branch.sh index c6e4e0668f..856cb0bec4 100755 --- a/extensions/git/scripts/bash/create-new-feature-branch.sh +++ b/extensions/git/scripts/bash/create-new-feature-branch.sh @@ -75,6 +75,10 @@ while [ $i -le $# ]; do echo "Environment variables:" echo " GIT_BRANCH_NAME Use this exact branch name, bypassing all prefix/suffix generation" echo "" + echo "Configuration:" + echo " branch_template Optional git-config.yml template with {author}, {app}, {number}, {slug}" + echo " branch_prefix Optional shorthand namespace expanded before {number}-{slug}" + echo "" echo "Examples:" echo " $0 'Add user authentication system' --short-name 'user-auth'" echo " $0 'Implement OAuth2 integration for API' --number 5" @@ -127,16 +131,28 @@ get_highest_from_specs() { # Function to get highest number from git branches get_highest_from_branches() { - git branch -a 2>/dev/null | sed -E 's/^[+*][[:space:]]+//; s/^[[:space:]]+//; s|^remotes/[^/]*/||' | _extract_highest_number + local scope_prefix="${1:-}" + git branch -a 2>/dev/null | sed -E 's/^[+*][[:space:]]+//; s/^[[:space:]]+//; s|^remotes/[^/]*/||' | _extract_highest_number "$scope_prefix" } # Extract the highest sequential feature number from a list of ref names (one per line). _extract_highest_number() { + local scope_prefix="${1:-}" local highest=0 while IFS= read -r name; do [ -z "$name" ] && continue - if echo "$name" | grep -Eq '^[0-9]{3,}-' && ! echo "$name" | grep -Eq '^[0-9]{8}-[0-9]{6}-'; then - number=$(echo "$name" | grep -Eo '^[0-9]+' || echo "0") + if [ -n "$scope_prefix" ]; then + case "$name" in + "$scope_prefix"*) name="${name#"$scope_prefix"}" ;; + *) continue ;; + esac + fi + name="${name##*/}" + if echo "$name" | grep -Eq '^[0-9]{3,}-' \ + && ! echo "$name" | grep -Eq '^[0-9]{8}-[0-9]{6}-' \ + && ! echo "$name" | grep -Eq '^[0-9]{7}-[0-9]{6}-' \ + && ! echo "$name" | grep -Eq '^[0-9]{7,8}-[0-9]{6}$'; then + number=$(echo "$name" | grep -Eo '^[0-9]{3,}-' | sed -E 's/-$//' || echo "0") number=$((10#$number)) if [ "$number" -gt "$highest" ]; then highest=$number @@ -148,11 +164,12 @@ _extract_highest_number() { # Function to get highest number from remote branches without fetching (side-effect-free) get_highest_from_remote_refs() { + local scope_prefix="${1:-}" local highest=0 for remote in $(git remote 2>/dev/null); do local remote_highest - remote_highest=$(GIT_TERMINAL_PROMPT=0 git ls-remote --heads "$remote" 2>/dev/null | sed 's|.*refs/heads/||' | _extract_highest_number) + remote_highest=$(GIT_TERMINAL_PROMPT=0 git ls-remote --heads "$remote" 2>/dev/null | sed 's|.*refs/heads/||' | _extract_highest_number "$scope_prefix") if [ "$remote_highest" -gt "$highest" ]; then highest=$remote_highest fi @@ -165,16 +182,17 @@ get_highest_from_remote_refs() { check_existing_branches() { local specs_dir="$1" local skip_fetch="${2:-false}" + local scope_prefix="${3:-}" if [ "$skip_fetch" = true ]; then - local highest_remote=$(get_highest_from_remote_refs) - local highest_branch=$(get_highest_from_branches) + local highest_remote=$(get_highest_from_remote_refs "$scope_prefix") + local highest_branch=$(get_highest_from_branches "$scope_prefix") if [ "$highest_remote" -gt "$highest_branch" ]; then highest_branch=$highest_remote fi else git fetch --all --prune >/dev/null 2>&1 || true - local highest_branch=$(get_highest_from_branches) + local highest_branch=$(get_highest_from_branches "$scope_prefix") fi local highest_spec=$(get_highest_from_specs "$specs_dir") @@ -273,6 +291,152 @@ fi cd "$REPO_ROOT" SPECS_DIR="$REPO_ROOT/specs" +CONFIG_FILE="$REPO_ROOT/.specify/extensions/git/git-config.yml" + +read_git_config_value() { + local key="$1" + [ -f "$CONFIG_FILE" ] || return 0 + grep -E "^[[:space:]]*${key}:" "$CONFIG_FILE" 2>/dev/null \ + | head -n 1 \ + | sed -E "s/^[[:space:]]*${key}:[[:space:]]*//" \ + | sed -E 's/[[:space:]]+#.*$//' \ + | sed -E 's/^[[:space:]]+|[[:space:]]+$//g' \ + | sed -E 's/^"//; s/"$//' \ + | sed -E "s/^'//; s/'$//" +} + +branch_token() { + local value="$1" + local fallback="$2" + local cleaned + cleaned=$(clean_branch_name "$value") + if [ -n "$cleaned" ]; then + printf '%s\n' "$cleaned" + else + printf '%s\n' "$fallback" + fi +} + +get_author_token() { + local author="" + if command -v git >/dev/null 2>&1; then + author=$(git config user.name 2>/dev/null || true) + if [ -z "$author" ]; then + author=$(git config user.email 2>/dev/null | sed 's/@.*$//' || true) + fi + fi + if [ -z "$author" ]; then + author="${USER:-unknown}" + fi + branch_token "$author" "unknown" +} + +get_app_token() { + branch_token "$(basename "$REPO_ROOT")" "app" +} + +resolve_branch_template() { + local template + local prefix + template=$(read_git_config_value "branch_template") + if [ -n "$template" ]; then + printf '%s\n' "$template" + return + fi + + prefix=$(read_git_config_value "branch_prefix") + if [ -z "$prefix" ]; then + printf '%s\n' "" + return + fi + case "$prefix" in + */) printf '%s%s\n' "$prefix" "{number}-{slug}" ;; + *) printf '%s/%s\n' "$prefix" "{number}-{slug}" ;; + esac +} + +render_branch_template() { + local template="$1" + local feature_num="$2" + local branch_suffix="$3" + local rendered="$template" + rendered=${rendered//\{author\}/$AUTHOR_TOKEN} + rendered=${rendered//\{app\}/$APP_TOKEN} + rendered=${rendered//\{number\}/$feature_num} + rendered=${rendered//\{slug\}/$branch_suffix} + printf '%s\n' "$rendered" +} + +validate_branch_template() { + local template="$1" + [ -n "$template" ] || return 0 + local feature_segment + feature_segment="${template##*/}" + case "$template" in + *"{number}"*) ;; + *) + >&2 echo "Error: branch_template must include the {number} token so generated branches remain valid feature branches." + exit 1 + ;; + esac + case "$template" in + *"{slug}"*"{number}"*) + >&2 echo "Error: branch_template must not place {slug} before {number}; use {slug} only in the final feature segment." + exit 1 + ;; + esac + case "$feature_segment" in + "{number}-"*) ;; + *) + >&2 echo "Error: branch_template must put {number}- at the start of the final path segment so generated branches remain valid feature branches." + exit 1 + ;; + esac +} + +build_branch_name() { + local feature_num="$1" + local branch_suffix="$2" + if [ -n "$BRANCH_TEMPLATE" ]; then + render_branch_template "$BRANCH_TEMPLATE" "$feature_num" "$branch_suffix" + else + printf '%s-%s\n' "$feature_num" "$branch_suffix" + fi +} + +branch_scope_prefix() { + local template="$1" + local prefix="$template" + [ -n "$prefix" ] || return 0 + case "$prefix" in + *"{number}"*) prefix="${prefix%%\{number\}*}" ;; + *"{slug}"*) prefix="${prefix%%\{slug\}*}" ;; + *) return 0 ;; + esac + render_branch_template "$prefix" "" "$BRANCH_SUFFIX" +} + +extract_feature_num_from_branch() { + local branch_name="$1" + local feature_segment="${branch_name##*/}" + local match + match=$(printf '%s\n' "$feature_segment" | grep -Eo '^[0-9]{8}-[0-9]{6}-' | head -n 1 || true) + if [ -n "$match" ]; then + printf '%s\n' "$match" | sed -E 's/-$//' + return + fi + match=$(printf '%s\n' "$feature_segment" | grep -Eo '^[0-9]+-' | head -n 1 || true) + if [ -n "$match" ]; then + printf '%s\n' "$match" | sed -E 's/-$//' + return + fi + printf '%s\n' "$branch_name" +} + +AUTHOR_TOKEN=$(get_author_token) +APP_TOKEN=$(get_app_token) +BRANCH_TEMPLATE=$(resolve_branch_template) +validate_branch_template "$BRANCH_TEMPLATE" # Function to generate branch name with stop word filtering generate_branch_name() { @@ -318,18 +482,8 @@ generate_branch_name() { # Check for GIT_BRANCH_NAME env var override (exact branch name, no prefix/suffix) if [ -n "${GIT_BRANCH_NAME:-}" ]; then BRANCH_NAME="$GIT_BRANCH_NAME" - # Extract FEATURE_NUM from the branch name if it starts with a numeric prefix - # Check timestamp pattern first (YYYYMMDD-HHMMSS-) since it also matches the simpler ^[0-9]+ pattern - if echo "$BRANCH_NAME" | grep -Eq '^[0-9]{8}-[0-9]{6}-'; then - FEATURE_NUM=$(echo "$BRANCH_NAME" | grep -Eo '^[0-9]{8}-[0-9]{6}') - BRANCH_SUFFIX="${BRANCH_NAME#${FEATURE_NUM}-}" - elif echo "$BRANCH_NAME" | grep -Eq '^[0-9]+-'; then - FEATURE_NUM=$(echo "$BRANCH_NAME" | grep -Eo '^[0-9]+') - BRANCH_SUFFIX="${BRANCH_NAME#${FEATURE_NUM}-}" - else - FEATURE_NUM="$BRANCH_NAME" - BRANCH_SUFFIX="$BRANCH_NAME" - fi + FEATURE_NUM=$(extract_feature_num_from_branch "$BRANCH_NAME") + BRANCH_SUFFIX="$BRANCH_NAME" else # Generate branch name if [ -n "$SHORT_NAME" ]; then @@ -347,16 +501,17 @@ else # Determine branch prefix if [ "$USE_TIMESTAMP" = true ]; then FEATURE_NUM=$(date +%Y%m%d-%H%M%S) - BRANCH_NAME="${FEATURE_NUM}-${BRANCH_SUFFIX}" + BRANCH_NAME=$(build_branch_name "$FEATURE_NUM" "$BRANCH_SUFFIX") else + BRANCH_SCOPE_PREFIX=$(branch_scope_prefix "$BRANCH_TEMPLATE") if [ -z "$BRANCH_NUMBER" ]; then if [ "$DRY_RUN" = true ] && [ "$HAS_GIT" = true ]; then - BRANCH_NUMBER=$(check_existing_branches "$SPECS_DIR" true) + BRANCH_NUMBER=$(check_existing_branches "$SPECS_DIR" true "$BRANCH_SCOPE_PREFIX") elif [ "$DRY_RUN" = true ]; then HIGHEST=$(get_highest_from_specs "$SPECS_DIR") BRANCH_NUMBER=$((HIGHEST + 1)) elif [ "$HAS_GIT" = true ]; then - BRANCH_NUMBER=$(check_existing_branches "$SPECS_DIR") + BRANCH_NUMBER=$(check_existing_branches "$SPECS_DIR" false "$BRANCH_SCOPE_PREFIX") else HIGHEST=$(get_highest_from_specs "$SPECS_DIR") BRANCH_NUMBER=$((HIGHEST + 1)) @@ -364,7 +519,7 @@ else fi FEATURE_NUM=$(printf "%03d" "$((10#$BRANCH_NUMBER))") - BRANCH_NAME="${FEATURE_NUM}-${BRANCH_SUFFIX}" + BRANCH_NAME=$(build_branch_name "$FEATURE_NUM" "$BRANCH_SUFFIX") fi fi @@ -376,18 +531,23 @@ if [ -n "${GIT_BRANCH_NAME:-}" ] && [ "$BRANCH_BYTE_LEN" -gt $MAX_BRANCH_LENGTH >&2 echo "Error: GIT_BRANCH_NAME must be 244 bytes or fewer in UTF-8. Provided value is ${BRANCH_BYTE_LEN} bytes." exit 1 elif [ "$BRANCH_BYTE_LEN" -gt $MAX_BRANCH_LENGTH ]; then - PREFIX_LENGTH=$(( ${#FEATURE_NUM} + 1 )) - MAX_SUFFIX_LENGTH=$((MAX_BRANCH_LENGTH - PREFIX_LENGTH)) - - TRUNCATED_SUFFIX=$(echo "$BRANCH_SUFFIX" | cut -c1-$MAX_SUFFIX_LENGTH) - TRUNCATED_SUFFIX=$(echo "$TRUNCATED_SUFFIX" | sed 's/-$//') - ORIGINAL_BRANCH_NAME="$BRANCH_NAME" - BRANCH_NAME="${FEATURE_NUM}-${TRUNCATED_SUFFIX}" + TRUNCATED_SUFFIX="$BRANCH_SUFFIX" + while [ "$(_byte_length "$BRANCH_NAME")" -gt "$MAX_BRANCH_LENGTH" ] && [ -n "$TRUNCATED_SUFFIX" ]; do + TRUNCATED_SUFFIX="${TRUNCATED_SUFFIX%?}" + TRUNCATED_SUFFIX="${TRUNCATED_SUFFIX%-}" + BRANCH_NAME=$(build_branch_name "$FEATURE_NUM" "$TRUNCATED_SUFFIX") + done + if [ "$(_byte_length "$BRANCH_NAME")" -gt "$MAX_BRANCH_LENGTH" ]; then + >&2 echo "Error: Branch template prefix exceeds GitHub's 244-byte branch name limit." + exit 1 + fi >&2 echo "[specify] Warning: Branch name exceeded GitHub's 244-byte limit" - >&2 echo "[specify] Original: $ORIGINAL_BRANCH_NAME (${#ORIGINAL_BRANCH_NAME} bytes)" - >&2 echo "[specify] Truncated to: $BRANCH_NAME (${#BRANCH_NAME} bytes)" + ORIGINAL_BRANCH_BYTE_LEN=$(_byte_length "$ORIGINAL_BRANCH_NAME") + TRUNCATED_BRANCH_BYTE_LEN=$(_byte_length "$BRANCH_NAME") + >&2 echo "[specify] Original: $ORIGINAL_BRANCH_NAME (${ORIGINAL_BRANCH_BYTE_LEN} bytes)" + >&2 echo "[specify] Truncated to: $BRANCH_NAME (${TRUNCATED_BRANCH_BYTE_LEN} bytes)" fi if [ "$DRY_RUN" != true ]; then diff --git a/extensions/git/scripts/bash/git-common.sh b/extensions/git/scripts/bash/git-common.sh index b78356d1c6..60bb79c867 100755 --- a/extensions/git/scripts/bash/git-common.sh +++ b/extensions/git/scripts/bash/git-common.sh @@ -23,8 +23,9 @@ spec_kit_effective_branch_name() { } # Validate that a branch name matches the expected feature branch pattern. -# Accepts sequential (###-* with >=3 digits) or timestamp (YYYYMMDD-HHMMSS-*) formats. -# Logic aligned with scripts/bash/common.sh check_feature_branch after effective-name normalization. +# Accepts sequential (###-* with >=3 digits) or timestamp (YYYYMMDD-HHMMSS-*) formats, +# either at the start of the branch or after path-style namespace prefixes. +# Logic aligned with the git extension's PowerShell Test-FeatureBranch twin. check_feature_branch() { local raw="$1" local has_git_repo="$2" @@ -37,16 +38,17 @@ check_feature_branch() { local branch branch=$(spec_kit_effective_branch_name "$raw") + local feature_segment="${branch##*/}" # Accept sequential prefix (3+ digits) but exclude malformed timestamps # Malformed: 7-or-8 digit date + 6-digit time with no trailing slug (e.g. "2026031-143022" or "20260319-143022") local is_sequential=false - if [[ "$branch" =~ ^[0-9]{3,}- ]] && [[ ! "$branch" =~ ^[0-9]{7}-[0-9]{6}- ]] && [[ ! "$branch" =~ ^[0-9]{7,8}-[0-9]{6}$ ]]; then + if [[ "$feature_segment" =~ ^[0-9]{3,}- ]] && [[ ! "$feature_segment" =~ ^[0-9]{7}-[0-9]{6}- ]] && [[ ! "$feature_segment" =~ ^[0-9]{7,8}-[0-9]{6}$ ]]; then is_sequential=true fi - if [[ "$is_sequential" != "true" ]] && [[ ! "$branch" =~ ^[0-9]{8}-[0-9]{6}- ]]; then + if [[ "$is_sequential" != "true" ]] && [[ ! "$feature_segment" =~ ^[0-9]{8}-[0-9]{6}- ]]; then echo "ERROR: Not on a feature branch. Current branch: $raw" >&2 - echo "Feature branches should be named like: 001-feature-name, 1234-feature-name, or 20260319-143022-feature-name" >&2 + echo "Feature branches should be named like: 001-feature-name, 1234-feature-name, 20260319-143022-feature-name, or /001-feature-name" >&2 return 1 fi diff --git a/extensions/git/scripts/powershell/create-new-feature-branch.ps1 b/extensions/git/scripts/powershell/create-new-feature-branch.ps1 index 0439ec80ad..1536f9a2ba 100644 --- a/extensions/git/scripts/powershell/create-new-feature-branch.ps1 +++ b/extensions/git/scripts/powershell/create-new-feature-branch.ps1 @@ -34,9 +34,23 @@ if ($Help) { Write-Host "Environment variables:" Write-Host " GIT_BRANCH_NAME Use this exact branch name, bypassing all prefix/suffix generation" Write-Host "" + Write-Host "Configuration:" + Write-Host " branch_template Optional git-config.yml template with {author}, {app}, {number}, {slug}" + Write-Host " branch_prefix Optional shorthand namespace expanded before {number}-{slug}" + Write-Host "" exit 0 } +# -Number is [long], so PowerShell binds "-5" as -5 rather than rejecting it +# the way the bash/Python twins do (`^[0-9]+$`). A negative value would format +# via '{0:000}' to e.g. "-005" and produce a branch name starting with "-", +# which git refuses (refs cannot begin with a dash). Reject it here, before the +# description check, matching the bash twin's parse-time validation order. +if ($Number -lt 0) { + Write-Error 'Error: --number must be a non-negative integer' + exit 1 +} + if (-not $FeatureDescription -or $FeatureDescription.Count -eq 0) { Write-Error "Usage: ./create-new-feature-branch.ps1 [-Json] [-DryRun] [-AllowExistingBranch] [-ShortName ] [-Number N] [-Timestamp] " exit 1 @@ -67,11 +81,23 @@ function Get-HighestNumberFromSpecs { } function Get-HighestNumberFromNames { - param([string[]]$Names) + param( + [string[]]$Names, + [string]$ScopePrefix = '' + ) [long]$highest = 0 foreach ($name in $Names) { - if ($name -match '^(\d{3,})-' -and $name -notmatch '^\d{8}-\d{6}-') { + if ($ScopePrefix -and -not $name.StartsWith($ScopePrefix, [System.StringComparison]::Ordinal)) { + continue + } + if ($ScopePrefix) { + $name = $name.Substring($ScopePrefix.Length) + } + $name = ($name -split '/')[-1] + $hasTimestampPrefix = $name -match '^\d{8}-\d{6}-' + $hasMalformedTimestamp = ($name -match '^\d{7}-\d{6}-') -or ($name -match '^(?:\d{7}|\d{8})-\d{6}$') + if ($name -match '^(\d{3,})-' -and -not $hasTimestampPrefix -and -not $hasMalformedTimestamp) { [long]$num = 0 if ([long]::TryParse($matches[1], [ref]$num) -and $num -gt $highest) { $highest = $num @@ -82,7 +108,7 @@ function Get-HighestNumberFromNames { } function Get-HighestNumberFromBranches { - param() + param([string]$ScopePrefix = '') try { $branches = git branch -a 2>$null @@ -90,7 +116,7 @@ function Get-HighestNumberFromBranches { $cleanNames = $branches | ForEach-Object { $_.Trim() -replace '^[+*]?\s+', '' -replace '^remotes/[^/]+/', '' } - return Get-HighestNumberFromNames -Names $cleanNames + return Get-HighestNumberFromNames -Names $cleanNames -ScopePrefix $ScopePrefix } } catch { Write-Verbose "Could not check Git branches: $_" @@ -99,6 +125,8 @@ function Get-HighestNumberFromBranches { } function Get-HighestNumberFromRemoteRefs { + param([string]$ScopePrefix = '') + [long]$highest = 0 try { $remotes = git remote 2>$null @@ -111,7 +139,7 @@ function Get-HighestNumberFromRemoteRefs { $refNames = $refs | ForEach-Object { if ($_ -match 'refs/heads/(.+)$') { $matches[1] } } | Where-Object { $_ } - $remoteHighest = Get-HighestNumberFromNames -Names $refNames + $remoteHighest = Get-HighestNumberFromNames -Names $refNames -ScopePrefix $ScopePrefix if ($remoteHighest -gt $highest) { $highest = $remoteHighest } } } @@ -125,18 +153,19 @@ function Get-HighestNumberFromRemoteRefs { function Get-NextBranchNumber { param( [string]$SpecsDir, - [switch]$SkipFetch + [switch]$SkipFetch, + [string]$ScopePrefix = '' ) if ($SkipFetch) { - $highestBranch = Get-HighestNumberFromBranches - $highestRemote = Get-HighestNumberFromRemoteRefs + $highestBranch = Get-HighestNumberFromBranches -ScopePrefix $ScopePrefix + $highestRemote = Get-HighestNumberFromRemoteRefs -ScopePrefix $ScopePrefix $highestBranch = [Math]::Max($highestBranch, $highestRemote) } else { try { git fetch --all --prune 2>$null | Out-Null } catch { } - $highestBranch = Get-HighestNumberFromBranches + $highestBranch = Get-HighestNumberFromBranches -ScopePrefix $ScopePrefix } $highestSpec = Get-HighestNumberFromSpecs -SpecsDir $SpecsDir @@ -232,6 +261,145 @@ if (Get-Command Test-HasGit -ErrorAction SilentlyContinue) { Set-Location $repoRoot $specsDir = Join-Path $repoRoot 'specs' +$configFile = Join-Path $repoRoot ".specify/extensions/git/git-config.yml" + +function Read-GitConfigValue { + param([string]$Key) + + if (-not (Test-Path -LiteralPath $configFile -PathType Leaf)) { return '' } + $escapedKey = [regex]::Escape($Key) + foreach ($line in Get-Content -LiteralPath $configFile) { + if ($line -match "^\s*$escapedKey\s*:\s*(.*)$") { + $val = ($matches[1] -replace '\s+#.*$', '').Trim() + $val = $val -replace '^["'']', '' -replace '["'']$', '' + return $val + } + } + return '' +} + +function ConvertTo-BranchToken { + param( + [string]$Value, + [string]$Fallback + ) + + $cleaned = ConvertTo-CleanBranchName -Name $Value + if ($cleaned) { return $cleaned } + return $Fallback +} + +function Get-GitAuthorToken { + $author = '' + if (Get-Command git -ErrorAction SilentlyContinue) { + try { $author = (git config user.name 2>$null | Out-String).Trim() } catch {} + if (-not $author) { + try { + $email = (git config user.email 2>$null | Out-String).Trim() + if ($email) { $author = ($email -split '@')[0] } + } catch {} + } + } + if (-not $author) { $author = if ($env:USER) { $env:USER } elseif ($env:USERNAME) { $env:USERNAME } else { 'unknown' } } + return ConvertTo-BranchToken -Value $author -Fallback 'unknown' +} + +function Get-AppToken { + return ConvertTo-BranchToken -Value (Split-Path $repoRoot -Leaf) -Fallback 'app' +} + +function Resolve-BranchTemplate { + $template = Read-GitConfigValue -Key 'branch_template' + if ($template) { return $template } + + $prefix = Read-GitConfigValue -Key 'branch_prefix' + if (-not $prefix) { return '' } + if ($prefix.EndsWith('/')) { return "${prefix}{number}-{slug}" } + return "$prefix/{number}-{slug}" +} + +function Expand-BranchTemplate { + param( + [string]$Template, + [string]$FeatureNum, + [string]$BranchSuffix + ) + + $rendered = $Template.Replace('{author}', $authorToken) + $rendered = $rendered.Replace('{app}', $appToken) + $rendered = $rendered.Replace('{number}', $FeatureNum) + $rendered = $rendered.Replace('{slug}', $BranchSuffix) + return $rendered +} + +function Assert-BranchTemplateValid { + param([string]$Template) + + if ($Template -and -not $Template.Contains('{number}')) { + throw "branch_template must include the {number} token so generated branches remain valid feature branches." + } + if ($Template) { + $numberIndex = $Template.IndexOf('{number}', [System.StringComparison]::Ordinal) + $slugIndex = $Template.IndexOf('{slug}', [System.StringComparison]::Ordinal) + if ($slugIndex -ge 0 -and $slugIndex -lt $numberIndex) { + throw "branch_template must not place {slug} before {number}; use {slug} only in the final feature segment." + } + $featureSegment = ($Template -split '/')[-1] + if (-not $featureSegment.StartsWith('{number}-', [System.StringComparison]::Ordinal)) { + throw "branch_template must put {number}- at the start of the final path segment so generated branches remain valid feature branches." + } + } +} + +function New-BranchName { + param( + [string]$FeatureNum, + [string]$BranchSuffix + ) + + if ($branchTemplate) { + return Expand-BranchTemplate -Template $branchTemplate -FeatureNum $FeatureNum -BranchSuffix $BranchSuffix + } + return "$FeatureNum-$BranchSuffix" +} + +function Get-BranchScopePrefix { + param( + [string]$Template, + [string]$BranchSuffix + ) + + if (-not $Template) { return '' } + $numberIndex = $Template.IndexOf('{number}', [System.StringComparison]::Ordinal) + $slugIndex = $Template.IndexOf('{slug}', [System.StringComparison]::Ordinal) + $indexes = @($numberIndex, $slugIndex) | Where-Object { $_ -ge 0 } | Sort-Object + if (-not $indexes) { return '' } + $prefix = $Template.Substring(0, $indexes[0]) + return Expand-BranchTemplate -Template $prefix -FeatureNum '' -BranchSuffix $BranchSuffix +} + +function Get-FeatureNumberFromBranchName { + param([string]$BranchName) + + $featureSegment = ($BranchName -split '/')[-1] + if ($featureSegment -match '^(\d{8}-\d{6})-') { + return $matches[1] + } + if ($featureSegment -match '^(\d+)-') { + return $matches[1] + } + return $BranchName +} + +function Get-Utf8ByteCount { + param([string]$Value) + return [System.Text.Encoding]::UTF8.GetByteCount($Value) +} + +$authorToken = Get-GitAuthorToken +$appToken = Get-AppToken +$branchTemplate = Resolve-BranchTemplate +Assert-BranchTemplateValid -Template $branchTemplate function Get-BranchName { param([string]$Description) @@ -276,19 +444,11 @@ function Get-BranchName { if ($env:GIT_BRANCH_NAME) { $branchName = $env:GIT_BRANCH_NAME # Check 244-byte limit (UTF-8) for override names - $branchNameUtf8ByteCount = [System.Text.Encoding]::UTF8.GetByteCount($branchName) + $branchNameUtf8ByteCount = Get-Utf8ByteCount -Value $branchName if ($branchNameUtf8ByteCount -gt 244) { throw "GIT_BRANCH_NAME must be 244 bytes or fewer in UTF-8. Provided value is $branchNameUtf8ByteCount bytes; please supply a shorter override branch name." } - # Extract FEATURE_NUM from the branch name if it starts with a numeric prefix - # Check timestamp pattern first (YYYYMMDD-HHMMSS-) since it also matches the simpler ^\d+ pattern - if ($branchName -match '^(\d{8}-\d{6})-') { - $featureNum = $matches[1] - } elseif ($branchName -match '^(\d+)-') { - $featureNum = $matches[1] - } else { - $featureNum = $branchName - } + $featureNum = Get-FeatureNumberFromBranchName -BranchName $branchName } else { if ($ShortName) { $branchSuffix = ConvertTo-CleanBranchName -Name $ShortName @@ -296,46 +456,54 @@ if ($env:GIT_BRANCH_NAME) { $branchSuffix = Get-BranchName -Description $featureDesc } - if ($Timestamp -and $Number -ne 0) { + # Warn if -Number and -Timestamp are both specified. Use ContainsKey (not + # `-ne 0`) so an explicit `-Number 0` is also detected, matching the bash twin's + # `[ -n "$BRANCH_NUMBER" ]` check. + if ($Timestamp -and $PSBoundParameters.ContainsKey('Number')) { Write-Warning "[specify] Warning: -Number is ignored when -Timestamp is used" $Number = 0 } if ($Timestamp) { $featureNum = Get-Date -Format 'yyyyMMdd-HHmmss' - $branchName = "$featureNum-$branchSuffix" + $branchName = New-BranchName -FeatureNum $featureNum -BranchSuffix $branchSuffix } else { - if ($Number -eq 0) { + $branchScopePrefix = Get-BranchScopePrefix -Template $branchTemplate -BranchSuffix $branchSuffix + # Auto-detect the next number only when -Number was not supplied; an + # explicit value (including 0) is honored, matching the bash twin's + # `[ -z "$BRANCH_NUMBER" ]` check. + if (-not $PSBoundParameters.ContainsKey('Number')) { if ($DryRun -and $hasGit) { - $Number = Get-NextBranchNumber -SpecsDir $specsDir -SkipFetch + $Number = Get-NextBranchNumber -SpecsDir $specsDir -SkipFetch -ScopePrefix $branchScopePrefix } elseif ($DryRun) { $Number = (Get-HighestNumberFromSpecs -SpecsDir $specsDir) + 1 } elseif ($hasGit) { - $Number = Get-NextBranchNumber -SpecsDir $specsDir + $Number = Get-NextBranchNumber -SpecsDir $specsDir -ScopePrefix $branchScopePrefix } else { $Number = (Get-HighestNumberFromSpecs -SpecsDir $specsDir) + 1 } } $featureNum = ('{0:000}' -f $Number) - $branchName = "$featureNum-$branchSuffix" + $branchName = New-BranchName -FeatureNum $featureNum -BranchSuffix $branchSuffix } } $maxBranchLength = 244 -if ($branchName.Length -gt $maxBranchLength) { - $prefixLength = $featureNum.Length + 1 - $maxSuffixLength = $maxBranchLength - $prefixLength - - $truncatedSuffix = $branchSuffix.Substring(0, [Math]::Min($branchSuffix.Length, $maxSuffixLength)) - $truncatedSuffix = $truncatedSuffix -replace '-$', '' - +if ((Get-Utf8ByteCount -Value $branchName) -gt $maxBranchLength) { $originalBranchName = $branchName - $branchName = "$featureNum-$truncatedSuffix" + $truncatedSuffix = $branchSuffix + while ((Get-Utf8ByteCount -Value $branchName) -gt $maxBranchLength -and $truncatedSuffix.Length -gt 0) { + $truncatedSuffix = $truncatedSuffix.Substring(0, $truncatedSuffix.Length - 1) -replace '-$', '' + $branchName = New-BranchName -FeatureNum $featureNum -BranchSuffix $truncatedSuffix + } + if ((Get-Utf8ByteCount -Value $branchName) -gt $maxBranchLength) { + throw "Branch template prefix exceeds GitHub's 244-byte branch name limit." + } Write-Warning "[specify] Branch name exceeded GitHub's 244-byte limit" - Write-Warning "[specify] Original: $originalBranchName ($($originalBranchName.Length) bytes)" - Write-Warning "[specify] Truncated to: $branchName ($($branchName.Length) bytes)" + Write-Warning "[specify] Original: $originalBranchName ($(Get-Utf8ByteCount -Value $originalBranchName) bytes)" + Write-Warning "[specify] Truncated to: $branchName ($(Get-Utf8ByteCount -Value $branchName) bytes)" } if (-not $DryRun) { diff --git a/extensions/git/scripts/powershell/git-common.ps1 b/extensions/git/scripts/powershell/git-common.ps1 index 13ea7542c4..a7ea724a31 100644 --- a/extensions/git/scripts/powershell/git-common.ps1 +++ b/extensions/git/scripts/powershell/git-common.ps1 @@ -37,14 +37,15 @@ function Test-FeatureBranch { $raw = $Branch $Branch = Get-SpecKitEffectiveBranchName $raw + $featureSegment = ($Branch -split '/')[-1] - # Accept sequential prefix (3+ digits) but exclude malformed timestamps - # Malformed: 7-or-8 digit date + 6-digit time with no trailing slug (e.g. "2026031-143022" or "20260319-143022") - $hasMalformedTimestamp = ($Branch -match '^[0-9]{7}-[0-9]{6}-') -or ($Branch -match '^(?:\d{7}|\d{8})-\d{6}$') - $isSequential = ($Branch -match '^[0-9]{3,}-') -and (-not $hasMalformedTimestamp) - if (-not $isSequential -and $Branch -notmatch '^\d{8}-\d{6}-') { + # Accept sequential prefix (3+ digits), at the start or after namespace + # segments, but exclude malformed timestamps. + $hasMalformedTimestamp = ($featureSegment -match '^[0-9]{7}-[0-9]{6}-') -or ($featureSegment -match '^(?:\d{7}|\d{8})-\d{6}$') + $isSequential = ($featureSegment -match '^[0-9]{3,}-') -and (-not $hasMalformedTimestamp) + if (-not $isSequential -and $featureSegment -notmatch '^\d{8}-\d{6}-') { [Console]::Error.WriteLine("ERROR: Not on a feature branch. Current branch: $raw") - [Console]::Error.WriteLine("Feature branches should be named like: 001-feature-name, 1234-feature-name, or 20260319-143022-feature-name") + [Console]::Error.WriteLine("Feature branches should be named like: 001-feature-name, 1234-feature-name, 20260319-143022-feature-name, or /001-feature-name") return $false } return $true diff --git a/extensions/git/scripts/python/auto_commit.py b/extensions/git/scripts/python/auto_commit.py new file mode 100644 index 0000000000..ebf23a9454 --- /dev/null +++ b/extensions/git/scripts/python/auto_commit.py @@ -0,0 +1,187 @@ +#!/usr/bin/env python3 +"""Git extension: auto_commit.py + +Automatically commit changes after a Spec Kit command completes. +Python port of ``auto-commit.sh`` / ``auto-commit.ps1``. +Checks per-command config keys in git-config.yml before committing. + +Usage: auto_commit.py + e.g.: auto_commit.py after_specify +""" + +from __future__ import annotations + +import re +import shutil +import subprocess +import sys +from pathlib import Path + + +def _find_project_root(start: Path) -> Path | None: + current = start + while True: + if (current / ".specify").is_dir() or (current / ".git").exists(): + return current + if current.parent == current: + return None + current = current.parent + + +def _value_after_colon(line: str) -> str: + return re.sub(r"^[^:]*:\s*", "", line) + + +def _strip_quotes(value: str) -> str: + """Strip one leading quote and all trailing quotes, mirroring the bash sed.""" + value = re.sub(r"^[\"']", "", value) + return re.sub(r"[\"']*$", "", value) + + +def _parse_auto_commit_config( + config_file: Path, event_name: str +) -> tuple[bool, str]: + """Parse the auto_commit section for this event, mirroring the bash line parser. + + Returns (enabled, commit_msg). Looks for auto_commit..enabled + and .message, with auto_commit.default as fallback. + """ + enabled = False + commit_msg = "" + default_enabled = False + in_auto_commit = False + in_event = False + + try: + content = config_file.read_text(encoding="utf-8") + except (OSError, UnicodeDecodeError): + # Unreadable or non-UTF-8 config is treated like a missing one: + # auto-commit stays disabled instead of crashing with a traceback. + return False, "" + for record in content.splitlines(keepends=True): + if not record.endswith("\n"): + break + line = record[:-1] + if line.startswith("auto_commit:"): + in_auto_commit = True + in_event = False + continue + + # Exit auto_commit section on next top-level key + if in_auto_commit and re.match(r"^[a-z]", line): + break + + if not in_auto_commit: + continue + + if re.match(r"^\s+default:\s", line): + value = re.sub(r"\s", "", _value_after_colon(line)).lower() + if value == "true": + default_enabled = True + + if re.match(rf"^\s+{re.escape(event_name)}:", line): + in_event = True + continue + + if in_event: + # Exit on next sibling key (same indent level as event name) + if re.match(r"^\s{2}[a-z]", line) and not re.match(r"^\s{4}", line): + in_event = False + continue + if re.search(r"\s+enabled:", line): + value = re.sub(r"\s", "", _value_after_colon(line)).lower() + if value == "true": + enabled = True + elif value == "false": + enabled = False + if re.search(r"\s+message:", line): + commit_msg = _strip_quotes(_value_after_colon(line)) + + # If event-specific key not found, use default — but only if the event + # section didn't exist at all (an explicit false must win). + if not enabled and default_enabled: + if not re.search(rf"^\s*{re.escape(event_name)}:", content, re.MULTILINE): + enabled = True + + return enabled, commit_msg + + +def main(argv: list[str]) -> int: + event_name = argv[0] if argv else "" + if not event_name: + print(f"Usage: {Path(sys.argv[0]).name} ", file=sys.stderr) + return 1 + + script_dir = Path(__file__).resolve().parent + repo_root = _find_project_root(script_dir) or Path.cwd() + + if shutil.which("git") is None: + print("[specify] Warning: Git not found; skipped auto-commit", file=sys.stderr) + return 0 + + probe = subprocess.run( + ["git", "rev-parse", "--is-inside-work-tree"], + cwd=repo_root, + capture_output=True, + text=True, + ) + if probe.returncode != 0: + print( + "[specify] Warning: Not a Git repository; skipped auto-commit", + file=sys.stderr, + ) + return 0 + + config_file = repo_root / ".specify" / "extensions" / "git" / "git-config.yml" + if not config_file.is_file(): + # No config file — auto-commit disabled by default + return 0 + + enabled, commit_msg = _parse_auto_commit_config(config_file, event_name) + if not enabled: + return 0 + + # Check if there are changes to commit + def _quiet(*args: str) -> bool: + return ( + subprocess.run( + ["git", *args], cwd=repo_root, capture_output=True, text=True + ).returncode + == 0 + ) + + untracked = subprocess.run( + ["git", "ls-files", "--others", "--exclude-standard"], + cwd=repo_root, + capture_output=True, + text=True, + ).stdout.strip() + if _quiet("diff", "--quiet", "HEAD") and _quiet("diff", "--cached", "--quiet") and not untracked: + print(f"[specify] No changes to commit after {event_name}", file=sys.stderr) + return 0 + + # Derive a human-readable command name from the event + # e.g., after_specify -> specify, before_plan -> plan + command_name = re.sub(r"^(after_|before_)", "", event_name) + phase = "before" if event_name.startswith("before_") else "after" + + if not commit_msg: + commit_msg = f"[Spec Kit] Auto-commit {phase} {command_name}" + + steps = [ + (["git", "add", "."], "git add"), + (["git", "commit", "-q", "-m", commit_msg], "git commit"), + ] + for cmd, label in steps: + result = subprocess.run(cmd, cwd=repo_root, capture_output=True, text=True) + if result.returncode != 0: + output = (result.stdout + result.stderr).strip() + print(f"[specify] Error: {label} failed: {output}", file=sys.stderr) + return 1 + + print(f"[OK] Changes committed {phase} {command_name}", file=sys.stderr) + return 0 + + +if __name__ == "__main__": + raise SystemExit(main(sys.argv[1:])) diff --git a/extensions/git/scripts/python/create_new_feature_branch.py b/extensions/git/scripts/python/create_new_feature_branch.py new file mode 100644 index 0000000000..e4b4135150 --- /dev/null +++ b/extensions/git/scripts/python/create_new_feature_branch.py @@ -0,0 +1,634 @@ +#!/usr/bin/env python3 +"""Git extension: create_new_feature_branch.py + +Creates a git feature branch only. The feature directory and spec file are +created by the core create-new-feature script. Python port of +``create-new-feature-branch.sh`` / ``create-new-feature-branch.ps1``. + +Loads the core Python helpers from the project's installed scripts when +available, falling back to the minimal git helpers next to this script. +""" + +from __future__ import annotations + +import importlib.util +import json +import os +import re +import shutil +import subprocess +import sys +from dataclasses import dataclass, field +from datetime import datetime +from pathlib import Path + +SCRIPT_DIR = Path(__file__).resolve().parent +MAX_BRANCH_LENGTH = 244 # GitHub enforces a 244-byte limit on branch names + +USAGE = ( + "Usage: create_new_feature_branch.py [--json] [--dry-run] " + "[--allow-existing-branch] [--short-name ] [--number N] " + "[--timestamp] " +) + +HELP_TEXT = f"""{USAGE} + +Options: + --json Output in JSON format + --dry-run Compute branch name without creating the branch + --allow-existing-branch Switch to branch if it already exists instead of failing + --short-name Provide a custom short name (2-4 words) for the branch + --number N Specify branch number manually (overrides auto-detection) + --timestamp Use timestamp prefix (YYYYMMDD-HHMMSS) instead of sequential numbering + --help, -h Show this help message + +Environment variables: + GIT_BRANCH_NAME Use this exact branch name, bypassing all prefix/suffix generation + +Configuration: + branch_template Optional git-config.yml template with {{author}}, {{app}}, {{number}}, {{slug}} + branch_prefix Optional shorthand namespace expanded before {{number}}-{{slug}} + +Examples: + create_new_feature_branch.py 'Add user authentication system' --short-name 'user-auth' + create_new_feature_branch.py 'Implement OAuth2 integration for API' --number 5 + create_new_feature_branch.py --timestamp --short-name 'user-auth' 'Add user authentication' + GIT_BRANCH_NAME=my-branch create_new_feature_branch.py 'feature description' +""" + +STOP_WORDS = frozenset( + "i a an the to for of in on at by with from is are was were be been being " + "have has had do does did will would should could can may might must shall " + "this that these those my your our their want need add get set".split() +) + + +def _err(message: str) -> None: + print(message, file=sys.stderr) + + +def _persist_hint(var_name: str, value: str) -> str: + """Shell-appropriate guidance for persisting an env var in the caller's shell.""" + if os.name == "nt": + escaped_value = value.replace("'", "''") + return f"$env:{var_name} = '{escaped_value}'" + escaped_value = re.sub(r"([^\w@%+=:,./-])", r"\\\1", value) + return f"export {var_name}={escaped_value}" + + +@dataclass +class Args: + json_mode: bool = False + dry_run: bool = False + allow_existing: bool = False + short_name: str = "" + branch_number: str = "" + use_timestamp: bool = False + description_parts: list[str] = field(default_factory=list) + + +def parse_args(argv: list[str]) -> Args: + args = Args() + i = 0 + while i < len(argv): + arg = argv[i] + if arg == "--json": + args.json_mode = True + elif arg == "--dry-run": + args.dry_run = True + elif arg == "--allow-existing-branch": + args.allow_existing = True + elif arg == "--short-name": + if i + 1 >= len(argv) or argv[i + 1].startswith("--"): + _err("Error: --short-name requires a value") + raise SystemExit(1) + i += 1 + args.short_name = argv[i] + elif arg == "--number": + if i + 1 >= len(argv) or argv[i + 1].startswith("--"): + _err("Error: --number requires a value") + raise SystemExit(1) + i += 1 + args.branch_number = argv[i] + if not re.fullmatch(r"[0-9]+", args.branch_number): + _err("Error: --number must be a non-negative integer") + raise SystemExit(1) + elif arg == "--timestamp": + args.use_timestamp = True + elif arg in ("--help", "-h"): + print(HELP_TEXT) + raise SystemExit(0) + else: + args.description_parts.append(arg) + i += 1 + return args + + +# ── Core helpers loading ───────────────────────────────────────────────────── + + +def _find_project_root(start: Path) -> Path | None: + current = start + while True: + if (current / ".specify").is_dir() or (current / ".git").exists(): + return current + if current.parent == current: + return None + current = current.parent + + +def _load_core_common(project_root: Path | None): + """Load the core common.py from the project's installed scripts. + + Search locations in priority order, mirroring the bash script: + 1. .specify/scripts/python/common.py (installed project) + 2. scripts/python/common.py (source checkout fallback) + Returns the loaded module or None. + """ + if project_root is None: + return None + for relative in (".specify/scripts/python/common.py", "scripts/python/common.py"): + candidate = project_root / relative + if candidate.is_file(): + spec = importlib.util.spec_from_file_location("speckit_core_common", candidate) + if spec is None or spec.loader is None: + continue + module = importlib.util.module_from_spec(spec) + sys.modules[spec.name] = module + spec.loader.exec_module(module) + return module + return None + + +def _local_has_git(repo_root: Path) -> bool: + git_marker = repo_root / ".git" + if not (git_marker.is_dir() or git_marker.is_file()): + return False + if shutil.which("git") is None: + return False + return ( + subprocess.run( + ["git", "-C", str(repo_root), "rev-parse", "--is-inside-work-tree"], + capture_output=True, + text=True, + ).returncode + == 0 + ) + + +# ── Numbering ──────────────────────────────────────────────────────────────── + + +def get_highest_from_specs(specs_dir: Path) -> int: + highest = 0 + if specs_dir.is_dir(): + for entry in specs_dir.iterdir(): + if not entry.is_dir(): + continue + name = entry.name + # Match sequential prefixes (>=3 digits), but skip timestamp dirs. + if re.match(r"^[0-9]{3,}-", name) and not re.match( + r"^[0-9]{8}-[0-9]{6}-", name + ): + number = int(re.match(r"^[0-9]+", name).group(0)) + highest = max(highest, number) + return highest + + +def _extract_highest_number(names: list[str], scope_prefix: str) -> int: + """Extract the highest sequential feature number from a list of ref names.""" + highest = 0 + for name in names: + if not name: + continue + if scope_prefix: + if not name.startswith(scope_prefix): + continue + name = name[len(scope_prefix) :] + name = name.rsplit("/", 1)[-1] + if ( + re.match(r"^[0-9]{3,}-", name) + and not re.match(r"^[0-9]{8}-[0-9]{6}-", name) + and not re.match(r"^[0-9]{7}-[0-9]{6}-", name) + and not re.fullmatch(r"[0-9]{7,8}-[0-9]{6}", name) + ): + match = re.match(r"^([0-9]{3,})-", name) + number = int(match.group(1)) if match else 0 + highest = max(highest, number) + return highest + + +def _git_lines(repo_root: Path, *args: str, env_extra: dict | None = None) -> list[str]: + if shutil.which("git") is None: + return [] + env = {**os.environ, **(env_extra or {})} + result = subprocess.run( + ["git", *args], cwd=repo_root, capture_output=True, text=True, env=env + ) + if result.returncode != 0: + return [] + return result.stdout.splitlines() + + +def get_highest_from_branches(repo_root: Path, scope_prefix: str) -> int: + names = [] + for line in _git_lines(repo_root, "branch", "-a"): + line = re.sub(r"^[+*]\s+", "", line) + line = line.lstrip() + line = re.sub(r"^remotes/[^/]*/", "", line) + names.append(line) + return _extract_highest_number(names, scope_prefix) + + +def get_highest_from_remote_refs(repo_root: Path, scope_prefix: str) -> int: + """Highest number from remote branches without fetching (side-effect-free).""" + highest = 0 + for remote in _git_lines(repo_root, "remote"): + refs = _git_lines( + repo_root, + "ls-remote", + "--heads", + remote, + env_extra={"GIT_TERMINAL_PROMPT": "0"}, + ) + names = [re.sub(r".*refs/heads/", "", ref) for ref in refs] + highest = max(highest, _extract_highest_number(names, scope_prefix)) + return highest + + +def check_existing_branches( + repo_root: Path, specs_dir: Path, skip_fetch: bool, scope_prefix: str +) -> int: + """Check existing branches and return the next available number.""" + if skip_fetch: + highest_branch = max( + get_highest_from_remote_refs(repo_root, scope_prefix), + get_highest_from_branches(repo_root, scope_prefix), + ) + else: + subprocess.run( + ["git", "fetch", "--all", "--prune"], + cwd=repo_root, + capture_output=True, + text=True, + ) + highest_branch = get_highest_from_branches(repo_root, scope_prefix) + + return max(highest_branch, get_highest_from_specs(specs_dir)) + 1 + + +# ── Branch naming ──────────────────────────────────────────────────────────── + + +def clean_branch_name(name: str) -> str: + name = re.sub(r"[^a-z0-9]", "-", name.lower()) + name = re.sub(r"-+", "-", name) + return name.strip("-") + + +def generate_branch_name(description: str) -> str: + """Generate a branch suffix from the description with stop word filtering.""" + clean_name = re.sub(r"[^a-z0-9]", " ", description.lower()) + + meaningful_words = [] + for word in clean_name.split(): + if word in STOP_WORDS: + continue + if len(word) >= 3: + meaningful_words.append(word) + # Keep short words only when they appear uppercased in the original + # description (acronyms like "API" or "DB"). + elif re.search(rf"\b{re.escape(word.upper())}\b", description): + meaningful_words.append(word) + + if meaningful_words: + max_words = 4 if len(meaningful_words) == 4 else 3 + return "-".join(meaningful_words[:max_words]) + + cleaned = clean_branch_name(description) + return "-".join([part for part in cleaned.split("-") if part][:3]) + + +def branch_token(value: str, fallback: str) -> str: + cleaned = clean_branch_name(value) + return cleaned if cleaned else fallback + + +def get_author_token(repo_root: Path) -> str: + author = "" + if shutil.which("git") is not None: + lines = _git_lines(repo_root, "config", "user.name") + author = lines[0] if lines else "" + if not author: + lines = _git_lines(repo_root, "config", "user.email") + email = lines[0] if lines else "" + author = email.split("@")[0] + if not author: + author = os.environ.get("USER") or os.environ.get("USERNAME") or "unknown" + return branch_token(author, "unknown") + + +def get_app_token(repo_root: Path) -> str: + return branch_token(repo_root.name, "app") + + +def read_git_config_value(config_file: Path, key: str) -> str: + if not config_file.is_file(): + return "" + try: + lines = config_file.read_text(encoding="utf-8").splitlines() + except (OSError, UnicodeDecodeError): + return "" + for line in lines: + if re.match(rf"^\s*{re.escape(key)}:", line): + value = re.sub(rf"^\s*{re.escape(key)}:\s*", "", line) + value = re.sub(r"\s+#.*$", "", value) + value = value.strip() + value = re.sub(r'^"|"$', "", value) + value = re.sub(r"^'|'$", "", value) + return value + return "" + + +def resolve_branch_template(config_file: Path) -> str: + template = read_git_config_value(config_file, "branch_template") + if template: + return template + + prefix = read_git_config_value(config_file, "branch_prefix") + if not prefix: + return "" + if prefix.endswith("/"): + return f"{prefix}{{number}}-{{slug}}" + return f"{prefix}/{{number}}-{{slug}}" + + +def validate_branch_template(template: str) -> None: + if not template: + return + if "{number}" not in template: + _err( + "Error: branch_template must include the {number} token so generated " + "branches remain valid feature branches." + ) + raise SystemExit(1) + slug_index = template.find("{slug}") + if slug_index != -1 and "{number}" in template[slug_index:]: + _err( + "Error: branch_template must not place {slug} before {number}; " + "use {slug} only in the final feature segment." + ) + raise SystemExit(1) + feature_segment = template.rsplit("/", 1)[-1] + if not feature_segment.startswith("{number}-"): + _err( + "Error: branch_template must put {number}- at the start of the final " + "path segment so generated branches remain valid feature branches." + ) + raise SystemExit(1) + + +def render_branch_template( + template: str, feature_num: str, branch_suffix: str, author_token: str, app_token: str +) -> str: + rendered = template + rendered = rendered.replace("{author}", author_token) + rendered = rendered.replace("{app}", app_token) + rendered = rendered.replace("{number}", feature_num) + rendered = rendered.replace("{slug}", branch_suffix) + return rendered + + +def extract_feature_num_from_branch(branch_name: str) -> str: + feature_segment = branch_name.rsplit("/", 1)[-1] + match = re.match(r"^[0-9]{8}-[0-9]{6}-", feature_segment) + if match: + return match.group(0).rstrip("-") + match = re.match(r"^[0-9]+-", feature_segment) + if match: + return match.group(0).rstrip("-") + return branch_name + + +def _byte_length(value: str) -> int: + return len(value.encode("utf-8")) + + +# ── Main ───────────────────────────────────────────────────────────────────── + + +def main(argv: list[str]) -> int: + args = parse_args(argv) + + feature_description = " ".join(args.description_parts) + if not feature_description: + _err(USAGE) + return 1 + feature_description = feature_description.strip() + if not feature_description: + _err("Error: Feature description cannot be empty or contain only whitespace") + return 1 + + project_root = _find_project_root(SCRIPT_DIR) + core = _load_core_common(project_root) + + # SPECIFY_INIT_DIR is resolved (and validated) by the core resolver. If the + # core helpers were not found, refuse rather than silently falling back to + # the wrong root. + if os.environ.get("SPECIFY_INIT_DIR") and ( + core is None or not hasattr(core, "resolve_specify_init_dir") + ): + _err( + "Error: SPECIFY_INIT_DIR requires updated Spec Kit core scripts " + "(common.py with resolve_specify_init_dir), which were not found." + ) + return 1 + + if core is not None and hasattr(core, "get_repo_root"): + # Pass script path so cwd-outside-repo callers land on the same + # fallback the bash twin does. Older cores don't accept the kwarg — + # fall back to the no-arg call for compatibility. + try: + repo_root = core.get_repo_root(script_file=Path(__file__)) + except TypeError: + repo_root = core.get_repo_root() + else: + toplevel = _git_lines(Path.cwd(), "rev-parse", "--show-toplevel") + if toplevel: + repo_root = Path(toplevel[0]) + elif project_root is not None: + repo_root = project_root + else: + _err("Error: Could not determine repository root.") + return 1 + repo_root = Path(repo_root) + + has_git_repo = _local_has_git(repo_root) + + specs_dir = repo_root / "specs" + config_file = repo_root / ".specify" / "extensions" / "git" / "git-config.yml" + + author_token = get_author_token(repo_root) + app_token = get_app_token(repo_root) + branch_template = resolve_branch_template(config_file) + validate_branch_template(branch_template) + + def build_branch_name(feature_num: str, branch_suffix: str) -> str: + if branch_template: + return render_branch_template( + branch_template, feature_num, branch_suffix, author_token, app_token + ) + return f"{feature_num}-{branch_suffix}" + + branch_number = args.branch_number + + # Check for GIT_BRANCH_NAME env var override (exact name, no prefix/suffix) + env_branch_name = os.environ.get("GIT_BRANCH_NAME", "") + if env_branch_name: + branch_name = env_branch_name + feature_num = extract_feature_num_from_branch(branch_name) + branch_suffix = branch_name + else: + if args.short_name: + branch_suffix = clean_branch_name(args.short_name) + else: + branch_suffix = generate_branch_name(feature_description) + + if args.use_timestamp and branch_number: + _err("[specify] Warning: --number is ignored when --timestamp is used") + branch_number = "" + + if args.use_timestamp: + feature_num = datetime.now().strftime("%Y%m%d-%H%M%S") + branch_name = build_branch_name(feature_num, branch_suffix) + else: + scope_prefix = "" + if branch_template: + prefix_template = branch_template.split("{number}")[0] + scope_prefix = render_branch_template( + prefix_template, "", branch_suffix, author_token, app_token + ) + if not branch_number: + if args.dry_run and has_git_repo: + branch_number = check_existing_branches( + repo_root, specs_dir, True, scope_prefix + ) + elif args.dry_run: + branch_number = get_highest_from_specs(specs_dir) + 1 + elif has_git_repo: + branch_number = check_existing_branches( + repo_root, specs_dir, False, scope_prefix + ) + else: + branch_number = get_highest_from_specs(specs_dir) + 1 + + feature_num = f"{int(branch_number):03d}" + branch_name = build_branch_name(feature_num, branch_suffix) + + branch_byte_len = _byte_length(branch_name) + if env_branch_name and branch_byte_len > MAX_BRANCH_LENGTH: + _err( + "Error: GIT_BRANCH_NAME must be 244 bytes or fewer in UTF-8. " + f"Provided value is {branch_byte_len} bytes." + ) + return 1 + if branch_byte_len > MAX_BRANCH_LENGTH: + original_branch_name = branch_name + truncated_suffix = branch_suffix + while _byte_length(branch_name) > MAX_BRANCH_LENGTH and truncated_suffix: + truncated_suffix = truncated_suffix[:-1] + truncated_suffix = truncated_suffix.rstrip("-") + branch_name = build_branch_name(feature_num, truncated_suffix) + if _byte_length(branch_name) > MAX_BRANCH_LENGTH: + _err("Error: Branch template prefix exceeds GitHub's 244-byte branch name limit.") + return 1 + + _err("[specify] Warning: Branch name exceeded GitHub's 244-byte limit") + _err( + f"[specify] Original: {original_branch_name} " + f"({_byte_length(original_branch_name)} bytes)" + ) + _err(f"[specify] Truncated to: {branch_name} ({_byte_length(branch_name)} bytes)") + + if not args.dry_run: + if has_git_repo: + create = subprocess.run( + ["git", "checkout", "-q", "-b", branch_name], + cwd=repo_root, + capture_output=True, + text=True, + ) + if create.returncode != 0: + current_branch_lines = _git_lines( + repo_root, "rev-parse", "--abbrev-ref", "HEAD" + ) + current_branch = current_branch_lines[0] if current_branch_lines else "" + branch_exists = bool( + _git_lines(repo_root, "branch", "--list", branch_name) + ) + if branch_exists: + if args.allow_existing: + if current_branch != branch_name: + switch = subprocess.run( + ["git", "checkout", "-q", branch_name], + cwd=repo_root, + capture_output=True, + text=True, + ) + if switch.returncode != 0: + _err( + f"Error: Failed to switch to existing branch '{branch_name}'. " + "Please resolve any local changes or conflicts and try again." + ) + if switch.stderr.strip(): + _err(switch.stderr.strip()) + return 1 + elif args.use_timestamp: + _err( + f"Error: Branch '{branch_name}' already exists. Rerun to get " + "a new timestamp or use a different --short-name." + ) + return 1 + else: + _err( + f"Error: Branch '{branch_name}' already exists. Please use a " + "different feature name or specify a different number with --number." + ) + return 1 + else: + _err(f"Error: Failed to create git branch '{branch_name}'.") + if create.stderr.strip(): + _err(create.stderr.strip()) + else: + _err("Please check your git configuration and try again.") + return 1 + else: + _err( + "[specify] Warning: Git repository not detected; skipped branch " + f"creation for {branch_name}" + ) + + _err(f"# To persist: {_persist_hint('SPECIFY_FEATURE', branch_name)}") + + if args.json_mode: + payload: dict[str, object] = { + "BRANCH_NAME": branch_name, + "FEATURE_NUM": feature_num, + } + if args.dry_run: + payload["DRY_RUN"] = True + print(json.dumps(payload, ensure_ascii=False, separators=(",", ":"))) + else: + print(f"BRANCH_NAME: {branch_name}") + print(f"FEATURE_NUM: {feature_num}") + if not args.dry_run: + print( + "# To persist in your shell: " + f"{_persist_hint('SPECIFY_FEATURE', branch_name)}" + ) + + return 0 + + +if __name__ == "__main__": + raise SystemExit(main(sys.argv[1:])) diff --git a/extensions/git/scripts/python/git_common.py b/extensions/git/scripts/python/git_common.py new file mode 100644 index 0000000000..9b23fbaa06 --- /dev/null +++ b/extensions/git/scripts/python/git_common.py @@ -0,0 +1,81 @@ +#!/usr/bin/env python3 +"""Git-specific common helpers for the git extension. + +Python port of ``git-common.sh`` / ``git-common.ps1`` — contains only +git-specific branch validation and detection logic. +""" + +from __future__ import annotations + +import re +import shutil +import subprocess +import sys +from pathlib import Path + + +def has_git(repo_root: Path | None = None) -> bool: + """Check if we have git available at the repo root.""" + root = Path(repo_root) if repo_root is not None else Path.cwd() + git_marker = root / ".git" + if not (git_marker.is_dir() or git_marker.is_file()): + return False + if shutil.which("git") is None: + return False + result = subprocess.run( + ["git", "-C", str(root), "rev-parse", "--is-inside-work-tree"], + capture_output=True, + text=True, + ) + return result.returncode == 0 + + +def effective_branch_name(raw: str) -> str: + """Strip a single optional path segment (e.g. gitflow "feat/004-name" -> "004-name"). + + Only when the full name is exactly two slash-free segments; otherwise + returns the raw name. + """ + match = re.fullmatch(r"([^/]+)/([^/]+)", raw) + if match: + return match.group(2) + return raw + + +def check_feature_branch(raw: str, has_git_repo: bool) -> bool: + """Validate that a branch name matches the expected feature branch pattern. + + Accepts sequential (###-* with >=3 digits) or timestamp (YYYYMMDD-HHMMSS-*) + formats, either at the start of the branch or after path-style namespace + prefixes. Logic aligned with the bash/PowerShell twins. + """ + if not has_git_repo: + print( + "[specify] Warning: Git repository not detected; skipped branch validation", + file=sys.stderr, + ) + return True + + branch = effective_branch_name(raw) + feature_segment = branch.rsplit("/", 1)[-1] + + # Accept sequential prefix (3+ digits) but exclude malformed timestamps: + # 7-or-8 digit date + 6-digit time with no trailing slug. + is_sequential = bool( + re.match(r"^[0-9]{3,}-", feature_segment) + and not re.match(r"^[0-9]{7}-[0-9]{6}-", feature_segment) + and not re.fullmatch(r"[0-9]{7,8}-[0-9]{6}", feature_segment) + ) + is_timestamp = bool(re.match(r"^[0-9]{8}-[0-9]{6}-", feature_segment)) + + if not is_sequential and not is_timestamp: + print(f"ERROR: Not on a feature branch. Current branch: {raw}", file=sys.stderr) + print( + "Feature branches should be named like: 001-feature-name, " + "1234-feature-name, 20260319-143022-feature-name, or " + "/001-feature-name", + file=sys.stderr, + ) + return False + + return True diff --git a/extensions/git/scripts/python/initialize_repo.py b/extensions/git/scripts/python/initialize_repo.py new file mode 100644 index 0000000000..eaf604c673 --- /dev/null +++ b/extensions/git/scripts/python/initialize_repo.py @@ -0,0 +1,89 @@ +#!/usr/bin/env python3 +"""Git extension: initialize_repo.py + +Initialize a Git repository with an initial commit. +Python port of ``initialize-repo.sh`` / ``initialize-repo.ps1``. +Customizable — replace this script to add .gitignore templates, +default branch config, git-flow, LFS, signing, etc. +""" + +from __future__ import annotations + +import re +import shutil +import subprocess +import sys +from pathlib import Path + + +def _find_project_root(start: Path) -> Path | None: + current = start + while True: + if (current / ".specify").is_dir() or (current / ".git").exists(): + return current + if current.parent == current: + return None + current = current.parent + + +def _read_commit_message(repo_root: Path) -> str: + """Read init_commit_message from git-config.yml, mirroring the bash sed pipeline.""" + default = "[Spec Kit] Initial commit" + config_file = repo_root / ".specify" / "extensions" / "git" / "git-config.yml" + if not config_file.is_file(): + return default + try: + lines = config_file.read_text(encoding="utf-8").splitlines() + except (OSError, UnicodeDecodeError): + return default + for line in lines: + if line.startswith("init_commit_message:"): + value = re.sub(r"^init_commit_message:\s*", "", line) + value = re.sub(r"^[\"']", "", value) + value = re.sub(r"[\"']*$", "", value) + if value: + return value + return default + + +def main() -> int: + script_dir = Path(__file__).resolve().parent + repo_root = _find_project_root(script_dir) or Path.cwd() + + commit_msg = _read_commit_message(repo_root) + + if shutil.which("git") is None: + print( + "[specify] Warning: Git not found; skipped repository initialization", + file=sys.stderr, + ) + return 0 + + probe = subprocess.run( + ["git", "rev-parse", "--is-inside-work-tree"], + cwd=repo_root, + capture_output=True, + text=True, + ) + if probe.returncode == 0: + print("[specify] Git repository already initialized; skipping", file=sys.stderr) + return 0 + + steps = [ + (["git", "init", "-q"], "git init"), + (["git", "add", "."], "git add"), + (["git", "commit", "--allow-empty", "-q", "-m", commit_msg], "git commit"), + ] + for cmd, label in steps: + result = subprocess.run(cmd, cwd=repo_root, capture_output=True, text=True) + if result.returncode != 0: + output = (result.stdout + result.stderr).strip() + print(f"[specify] Error: {label} failed: {output}", file=sys.stderr) + return 1 + + print("[OK] Git repository initialized", file=sys.stderr) + return 0 + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/extensions/selftest/commands/selftest.md b/extensions/selftest/commands/selftest.md index 6f5655edd5..4c3d281aa8 100644 --- a/extensions/selftest/commands/selftest.md +++ b/extensions/selftest/commands/selftest.md @@ -48,7 +48,7 @@ cat .specify/extensions/.registry/$ARGUMENTS.json ### Step 4: Verification Report -Analyze the standard output of the three steps. +Analyze the standard output of the three steps. Generate a terminal-style test output format detailing the results of discovery, installation, and registration. Return this directly to the user. Example output format: diff --git a/integrations/catalog.json b/integrations/catalog.json index 601ae0ad92..40dc13d84c 100644 --- a/integrations/catalog.json +++ b/integrations/catalog.json @@ -1,6 +1,6 @@ { "schema_version": "1.0", - "updated_at": "2026-06-23T00:00:00Z", + "updated_at": "2026-07-15T00:00:00Z", "catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/integrations/catalog.json", "integrations": { "claude": { @@ -282,6 +282,15 @@ "repository": "https://github.com/github/spec-kit", "tags": ["cli"] }, + "grok": { + "id": "grok", + "name": "Grok Build", + "version": "1.0.0", + "description": "xAI Grok Build CLI skills-based integration", + "author": "spec-kit-core", + "repository": "https://github.com/github/spec-kit", + "tags": ["cli", "skills", "xai"] + }, "hermes": { "id": "hermes", "name": "Hermes Agent", diff --git a/llms.txt b/llms.txt index e7f0f6d11b..1c4f4cce06 100644 --- a/llms.txt +++ b/llms.txt @@ -7,8 +7,8 @@ It is IPADP project #6 in the satware AG ecosystem. ## Status -- Fork version: satware-v0.12.4+1 -- Upstream version: 0.12.4 +- Fork version: satware-v0.12.17 +- Upstream version: 0.12.17 - IPADP conformance level: L3 (AGENTS.md + specs/metadata.json + privacy validation + morning protocol) ## Docs diff --git a/newsletters/2026-March.md b/newsletters/2026-March.md index d97ca3960f..402539e58e 100644 --- a/newsletters/2026-March.md +++ b/newsletters/2026-March.md @@ -76,5 +76,3 @@ Areas under discussion or in progress for future development: - **Continued agent expansion** -- seven new agents were added in March alone. The agent-agnostic design means support for emerging tools can be added by anyone. [\[byteiota.com\]](https://byteiota.com/spec-driven-development-kills-vibe-coding-march-2026/) - **Experience simplification** -- the preset system, custom workflows, and growing walkthrough library lower the learning curve, but extension discoverability will need a more robust solution as the catalog grows. [\[github.com\]](https://github.com/github/spec-kit/releases) - **Toward a stable release** -- nine releases in one month reflects pre-1.0 momentum. Reaching 1.0 will require stabilizing the extension and preset APIs and ensuring backward compatibility across the agent and extension surface area. [\[github.com\]](https://github.com/github/spec-kit/blob/main/newsletters/2026-February.md) - - diff --git a/presets/ARCHITECTURE.md b/presets/ARCHITECTURE.md index 85e9dea3c7..c533976b8a 100644 --- a/presets/ARCHITECTURE.md +++ b/presets/ARCHITECTURE.md @@ -158,8 +158,7 @@ presets/ ├── plan-template.md ├── tasks-template.md ├── checklist-template.md - ├── constitution-template.md - └── agent-file-template.md + └── constitution-template.md ``` ## Module Structure diff --git a/presets/catalog.community.json b/presets/catalog.community.json index 24c312195c..94573625d5 100644 --- a/presets/catalog.community.json +++ b/presets/catalog.community.json @@ -1,6 +1,6 @@ { "schema_version": "1.0", - "updated_at": "2026-06-30T00:00:00Z", + "updated_at": "2026-07-14T00:00:00Z", "catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/presets/catalog.community.json", "presets": { "a11y-governance": { @@ -131,6 +131,35 @@ "created_at": "2026-04-27T00:00:00Z", "updated_at": "2026-06-14T00:00:00Z" }, + "autonomous-run-governance": { + "name": "Autonomous Run Governance", + "id": "autonomous-run-governance", + "version": "0.1.4", + "description": "Adds permission-bounded, evidence-first governance for autonomous Spec Kit delivery, convergence, resume, closeout, and retrospective learning.", + "author": "Thorsten Hindermann", + "repository": "https://github.com/hindermath/spec-kit-preset-autonomous-run-governance", + "download_url": "https://github.com/hindermath/spec-kit-preset-autonomous-run-governance/archive/refs/tags/v0.1.4.zip", + "homepage": "https://github.com/hindermath/spec-kit-preset-autonomous-run-governance", + "documentation": "https://github.com/hindermath/spec-kit-preset-autonomous-run-governance/blob/v0.1.4/README.md", + "license": "MIT", + "requires": { + "speckit_version": ">=0.8.3" + }, + "provides": { + "templates": 12, + "commands": 2, + "scripts": 2 + }, + "tags": [ + "autonomous", + "governance", + "evidence", + "permissions", + "retrospective" + ], + "created_at": "2026-07-13T00:00:00Z", + "updated_at": "2026-07-14T00:00:00Z" + }, "canon-core": { "name": "Canon Core", "id": "canon-core", @@ -618,6 +647,34 @@ "created_at": "2026-04-30T00:00:00Z", "updated_at": "2026-04-30T00:00:00Z" }, + "test-first-governance": { + "name": "Test-First Governance", + "id": "test-first-governance", + "version": "1.3.0", + "description": "Governs TDD with coverage-complete BDD/ATDD Gherkin scenarios, explicit suite ownership, professional test reports, traceability, and risk-based quality gates.", + "author": "Zoltán Katona, PhD", + "repository": "https://github.com/ka-zo/spec-kit-preset-test-first-governance", + "download_url": "https://github.com/ka-zo/spec-kit-preset-test-first-governance/archive/refs/tags/1.3.0.zip", + "homepage": "https://github.com/ka-zo/spec-kit-preset-test-first-governance", + "documentation": "https://github.com/ka-zo/spec-kit-preset-test-first-governance/blob/main/README.md", + "license": "MIT", + "requires": { + "speckit_version": ">=0.12.11" + }, + "provides": { + "templates": 10, + "commands": 8 + }, + "tags": [ + "tdd", + "bdd", + "atdd", + "quality-gates", + "traceability" + ], + "created_at": "2026-07-13T00:00:00Z", + "updated_at": "2026-07-13T00:00:00Z" + }, "toc-navigation": { "name": "Table of Contents Navigation", "id": "toc-navigation", diff --git a/presets/self-test/preset.yml b/presets/self-test/preset.yml index 8e718430aa..7a9db93b0a 100644 --- a/presets/self-test/preset.yml +++ b/presets/self-test/preset.yml @@ -44,12 +44,6 @@ provides: description: "Self-test constitution template" replaces: "constitution-template" - - type: "template" - name: "agent-file-template" - file: "templates/agent-file-template.md" - description: "Self-test agent file template" - replaces: "agent-file-template" - - type: "command" name: "speckit.specify" file: "commands/speckit.specify.md" diff --git a/presets/self-test/templates/agent-file-template.md b/presets/self-test/templates/agent-file-template.md deleted file mode 100644 index 7b9267bade..0000000000 --- a/presets/self-test/templates/agent-file-template.md +++ /dev/null @@ -1,9 +0,0 @@ -# Agent File (Self-Test Preset) - - - -> This template is provided by the self-test preset. - -## Agent Instructions - -Follow these guidelines when working on this project. diff --git a/pyproject.toml b/pyproject.toml index 6a396d8148..640e3ac718 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "specify-cli" -version = "0.12.4" +version = "0.12.17" description = "Specify CLI, part of GitHub Spec Kit. A tool to bootstrap your projects for Spec-Driven Development (SDD)." readme = "README.md" requires-python = ">=3.11" diff --git a/scripts/bash/check-prerequisites.sh b/scripts/bash/check-prerequisites.sh index 1d24336327..b9688d6742 100755 --- a/scripts/bash/check-prerequisites.sh +++ b/scripts/bash/check-prerequisites.sh @@ -57,13 +57,13 @@ OPTIONS: EXAMPLES: # Check task prerequisites (plan.md required) ./check-prerequisites.sh --json - + # Check implementation prerequisites (plan.md + tasks.md required) ./check-prerequisites.sh --json --require-tasks --include-tasks - + # Get feature paths only (no validation) ./check-prerequisites.sh --paths-only - + EOF exit 0 ;; @@ -182,13 +182,13 @@ else # Text output echo "FEATURE_DIR:$FEATURE_DIR" echo "AVAILABLE_DOCS:" - + # Show status of each potential document check_file "$RESEARCH" "research.md" check_file "$DATA_MODEL" "data-model.md" check_dir "$CONTRACTS_DIR" "contracts/" check_file "$QUICKSTART" "quickstart.md" - + if $INCLUDE_TASKS; then check_file "$TASKS" "tasks.md" fi diff --git a/scripts/bash/common.sh b/scripts/bash/common.sh index 609729cbfa..dc60f9ff5d 100755 --- a/scripts/bash/common.sh +++ b/scripts/bash/common.sh @@ -97,17 +97,26 @@ read_feature_json_feature_directory() { local fj="$repo_root/.specify/feature.json" [[ -f "$fj" ]] || { printf '%s' ''; return 0; } + # Try parsers in order (jq -> python3 -> grep/sed), falling through on + # failure. Selection is by *parse success*, not mere availability: on + # Windows `python3` commonly resolves to the Microsoft Store App Execution + # Alias stub, which passes `command -v` but fails at runtime (exit 49), so + # an availability-gated `elif` would pick python3, swallow its failure, and + # never reach the grep/sed fallback -- leaving feature.json unreadable even + # though it is valid (issue #3304). local _fd='' if command -v jq >/dev/null 2>&1; then if ! _fd=$(jq -r '.feature_directory // empty' "$fj" 2>/dev/null); then _fd='' fi - elif command -v python3 >/dev/null 2>&1; then + fi + if [[ -z "$_fd" ]] && command -v python3 >/dev/null 2>&1; then # Use Python so pretty-printed/multi-line JSON still parses correctly. if ! _fd=$(python3 -c "import json,sys; d=json.load(open(sys.argv[1])); v=d.get('feature_directory'); print(v if v else '')" "$fj" 2>/dev/null); then _fd='' fi - else + fi + if [[ -z "$_fd" ]]; then # Last-resort single-line grep/sed fallback. The `|| true` guards against # grep returning 1 (no match) aborting under `set -e` / `pipefail`. _fd=$( { grep -E '"feature_directory"[[:space:]]*:' "$fj" 2>/dev/null || true; } \ @@ -235,21 +244,29 @@ get_invoke_separator() { local integration_json="$repo_root/.specify/integration.json" local separator="." - local parsed_with_jq=0 + local parsed=0 if [[ -f "$integration_json" ]]; then + # Try parsers in order (jq -> python3 -> awk), falling through on + # failure. Selection is by *parse success*, not mere availability: on + # Windows `python3` commonly resolves to the Microsoft Store App + # Execution Alias stub, which passes `command -v` but fails at runtime + # (exit 49). An availability-gated branch would pick python3, swallow + # its failure, and — because this function historically had no text + # fallback — silently return "." even for `-`-separator integrations + # (e.g. forge, cline), yielding wrong command hints (issue #3304). if command -v jq >/dev/null 2>&1; then local jq_separator if jq_separator=$(jq -r '(.default_integration // .integration // "") as $k | if $k == "" then "." else (.integration_settings[$k].invoke_separator // ".") end' "$integration_json" 2>/dev/null); then - parsed_with_jq=1 case "$jq_separator" in - "."|"-") separator="$jq_separator" ;; + "."|"-") separator="$jq_separator"; parsed=1 ;; esac fi fi - if [[ "$parsed_with_jq" -eq 0 ]] && command -v python3 >/dev/null 2>&1; then - if separator=$(python3 - "$integration_json" <<'PY' 2>/dev/null + if [[ "$parsed" -eq 0 ]] && command -v python3 >/dev/null 2>&1; then + local py_separator + if py_separator=$(python3 - "$integration_json" <<'PY' 2>/dev/null import json import sys @@ -265,17 +282,64 @@ try: separator = entry["invoke_separator"] print(separator) except Exception: - print(".") + sys.exit(1) PY ); then - case "$separator" in - "."|"-") ;; - *) separator="." ;; + case "$py_separator" in + "."|"-") separator="$py_separator"; parsed=1 ;; esac - else - separator="." fi fi + + if [[ "$parsed" -eq 0 ]]; then + # Last-resort text fallback for environments with neither jq nor a + # working python3 (e.g. stock Windows + Git Bash). Reads the active + # integration key (default_integration, else integration) and its + # invoke_separator from within the integration_settings object. + # Handles both pretty-printed (the written form) and compact JSON. + # Accumulate all lines into one buffer in END rather than using + # gawk-only whole-file slurp (RS="^$"), so this stays portable to + # the BSD awk on macOS. + local awk_separator + awk_separator=$(awk ' + function keyval(d, name, v) { + if (match(d, "\"" name "\"[ \t\r\n]*:[ \t\r\n]*\"[^\"]*\"")) { + v=substr(d,RSTART,RLENGTH); sub(/^.*:[ \t\r\n]*"/,"",v); sub(/"$/,"",v); return v + } + return "" + } + { doc = doc $0 "\n" } + END { + key=keyval(doc,"default_integration"); if (key=="") key=keyval(doc,"integration") + sep="." + if (key!="") { + settings=doc + if (match(doc, /"integration_settings"[ \t\r\n]*:[ \t\r\n]*[{]/)) { + settings=substr(doc, RSTART+RLENGTH-1) + } + if (match(settings, "\"" key "\"[ \t\r\n]*:[ \t\r\n]*[{]")) { + start=RSTART+RLENGTH-1 + depth=0 + obj="" + for (i=start; i<=length(settings); i++) { + c=substr(settings,i,1) + obj=obj c + if (c=="{") depth++ + else if (c=="}") { depth--; if (depth==0) break } + } + if (match(obj, /"invoke_separator"[ \t\r\n]*:[ \t\r\n]*"[-.]"/)) { + tok=substr(obj,RSTART,RLENGTH); s=substr(tok,length(tok)-1,1) + if (s=="." || s=="-") sep=s + } + } + } + print sep + } + ' "$integration_json" 2>/dev/null) + case "$awk_separator" in + "."|"-") separator="$awk_separator" ;; + esac + fi fi _SPECIFY_INVOKE_SEPARATOR_CACHE_REPO_ROOT="$repo_root" diff --git a/scripts/bash/create-new-feature.sh b/scripts/bash/create-new-feature.sh index 3cffce8602..50b2ce08de 100755 --- a/scripts/bash/create-new-feature.sh +++ b/scripts/bash/create-new-feature.sh @@ -94,7 +94,7 @@ fi get_highest_from_specs() { local specs_dir="$1" local highest=0 - + if [ -d "$specs_dir" ]; then for dir in "$specs_dir"/*; do [ -d "$dir" ] || continue @@ -109,7 +109,7 @@ get_highest_from_specs() { fi done fi - + echo "$highest" } @@ -135,19 +135,19 @@ fi # Function to generate branch name with stop word filtering and length filtering generate_branch_name() { local description="$1" - + # Common stop words to filter out local stop_words="^(i|a|an|the|to|for|of|in|on|at|by|with|from|is|are|was|were|be|been|being|have|has|had|do|does|did|will|would|should|could|can|may|might|must|shall|this|that|these|those|my|your|our|their|want|need|add|get|set)$" - + # Convert to lowercase and split into words local clean_name=$(printf '%s' "$description" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9]/ /g') - + # Filter words: remove stop words and words shorter than 3 chars (unless they're uppercase acronyms in original) local meaningful_words=() for word in $clean_name; do # Skip empty words [ -z "$word" ] && continue - + # Keep words that are NOT stop words AND (length >= 3 OR are potential acronyms) if ! echo "$word" | grep -qiE "$stop_words"; then if [ ${#word} -ge 3 ]; then @@ -160,12 +160,12 @@ generate_branch_name() { fi fi done - + # If we have meaningful words, use first 3-4 of them if [ ${#meaningful_words[@]} -gt 0 ]; then local max_words=3 if [ ${#meaningful_words[@]} -eq 4 ]; then max_words=4; fi - + local result="" local count=0 for word in "${meaningful_words[@]}"; do @@ -221,15 +221,15 @@ if [ ${#BRANCH_NAME} -gt $MAX_BRANCH_LENGTH ]; then # Account for prefix length: timestamp (15) + hyphen (1) = 16, or sequential (3) + hyphen (1) = 4 PREFIX_LENGTH=$(( ${#FEATURE_NUM} + 1 )) MAX_SUFFIX_LENGTH=$((MAX_BRANCH_LENGTH - PREFIX_LENGTH)) - + # Truncate suffix at word boundary if possible TRUNCATED_SUFFIX=$(echo "$BRANCH_SUFFIX" | cut -c1-$MAX_SUFFIX_LENGTH) # Remove trailing hyphen if truncation created one TRUNCATED_SUFFIX=$(echo "$TRUNCATED_SUFFIX" | sed 's/-$//') - + ORIGINAL_BRANCH_NAME="$BRANCH_NAME" BRANCH_NAME="${FEATURE_NUM}-${TRUNCATED_SUFFIX}" - + >&2 echo "[specify] Warning: Branch name exceeded GitHub's 244-byte limit" >&2 echo "[specify] Original: $ORIGINAL_BRANCH_NAME (${#ORIGINAL_BRANCH_NAME} bytes)" >&2 echo "[specify] Truncated to: $BRANCH_NAME (${#BRANCH_NAME} bytes)" diff --git a/scripts/bash/setup-plan.sh b/scripts/bash/setup-plan.sh index cb679437a9..e01dc44bce 100755 --- a/scripts/bash/setup-plan.sh +++ b/scripts/bash/setup-plan.sh @@ -8,17 +8,17 @@ ARGS=() for arg in "$@"; do case "$arg" in - --json) - JSON_MODE=true + --json) + JSON_MODE=true ;; - --help|-h) + --help|-h) echo "Usage: $0 [--json]" echo " --json Output results in JSON format" echo " --help Show this help message" - exit 0 + exit 0 ;; - *) - ARGS+=("$arg") + *) + ARGS+=("$arg") ;; esac done @@ -77,8 +77,7 @@ if $JSON_MODE; then fi else echo "FEATURE_SPEC: $FEATURE_SPEC" - echo "IMPL_PLAN: $IMPL_PLAN" + echo "IMPL_PLAN: $IMPL_PLAN" echo "SPECS_DIR: $FEATURE_DIR" echo "BRANCH: $CURRENT_BRANCH" fi - diff --git a/scripts/powershell/check-prerequisites.ps1 b/scripts/powershell/check-prerequisites.ps1 index 2a424b49a8..07ece76e21 100644 --- a/scripts/powershell/check-prerequisites.ps1 +++ b/scripts/powershell/check-prerequisites.ps1 @@ -42,10 +42,10 @@ OPTIONS: EXAMPLES: # Check task prerequisites (plan.md required) .\check-prerequisites.ps1 -Json - + # Check implementation prerequisites (plan.md + tasks.md required) .\check-prerequisites.ps1 -Json -RequireTasks -IncludeTasks - + # Get feature paths only (no validation) .\check-prerequisites.ps1 -PathsOnly @@ -118,35 +118,35 @@ if (Test-Path $paths.RESEARCH) { $docs += 'research.md' } if (Test-Path $paths.DATA_MODEL) { $docs += 'data-model.md' } # Check contracts directory (only if it exists and has files) -if ((Test-Path $paths.CONTRACTS_DIR) -and (Get-ChildItem -Path $paths.CONTRACTS_DIR -ErrorAction SilentlyContinue | Select-Object -First 1)) { - $docs += 'contracts/' +if ((Test-Path $paths.CONTRACTS_DIR) -and (Get-ChildItem -Path $paths.CONTRACTS_DIR -ErrorAction SilentlyContinue | Select-Object -First 1)) { + $docs += 'contracts/' } if (Test-Path $paths.QUICKSTART) { $docs += 'quickstart.md' } # Include tasks.md if requested and it exists -if ($IncludeTasks -and (Test-Path $paths.TASKS)) { - $docs += 'tasks.md' +if ($IncludeTasks -and (Test-Path $paths.TASKS)) { + $docs += 'tasks.md' } # Output results if ($Json) { # JSON output - [PSCustomObject]@{ + [PSCustomObject]@{ FEATURE_DIR = $paths.FEATURE_DIR - AVAILABLE_DOCS = $docs + AVAILABLE_DOCS = $docs } | ConvertTo-Json -Compress } else { # Text output Write-Output "FEATURE_DIR:$($paths.FEATURE_DIR)" Write-Output "AVAILABLE_DOCS:" - + # Show status of each potential document Test-FileExists -Path $paths.RESEARCH -Description 'research.md' | Out-Null Test-FileExists -Path $paths.DATA_MODEL -Description 'data-model.md' | Out-Null Test-DirHasFiles -Path $paths.CONTRACTS_DIR -Description 'contracts/' | Out-Null Test-FileExists -Path $paths.QUICKSTART -Description 'quickstart.md' | Out-Null - + if ($IncludeTasks) { Test-FileExists -Path $paths.TASKS -Description 'tasks.md' | Out-Null } diff --git a/scripts/powershell/common.ps1 b/scripts/powershell/common.ps1 index a6e1b631b7..bb9d19062b 100644 --- a/scripts/powershell/common.ps1 +++ b/scripts/powershell/common.ps1 @@ -191,7 +191,7 @@ function Get-FeaturePathsEnv { [Console]::Error.WriteLine("ERROR: Feature directory not found. Set SPECIFY_FEATURE_DIRECTORY or run the specify command to create .specify/feature.json.") exit 1 } - + # When no branch context exists (no SPECIFY_FEATURE, feature resolved via # SPECIFY_FEATURE_DIRECTORY or feature.json), fall back to the feature # directory basename so CURRENT_BRANCH is a usable identifier rather than diff --git a/scripts/powershell/setup-plan.ps1 b/scripts/powershell/setup-plan.ps1 index 0ebd591c87..9e0403eba6 100644 --- a/scripts/powershell/setup-plan.ps1 +++ b/scripts/powershell/setup-plan.ps1 @@ -63,7 +63,7 @@ if (Test-Path $paths.IMPL_PLAN -PathType Leaf) { # Output results if ($Json) { - $result = [PSCustomObject]@{ + $result = [PSCustomObject]@{ FEATURE_SPEC = $paths.FEATURE_SPEC IMPL_PLAN = $paths.IMPL_PLAN SPECS_DIR = $paths.FEATURE_DIR diff --git a/scripts/python/check_prerequisites.py b/scripts/python/check_prerequisites.py new file mode 100644 index 0000000000..50c31cb513 --- /dev/null +++ b/scripts/python/check_prerequisites.py @@ -0,0 +1,207 @@ +#!/usr/bin/env python3 +"""Consolidated prerequisite checking script.""" + +from __future__ import annotations + +import json +import sys +from dataclasses import dataclass +from pathlib import Path + +try: + from common import FeaturePaths, format_speckit_command, get_feature_paths +except ImportError: # pragma: no cover - direct execution from unusual cwd + sys.path.insert(0, str(Path(__file__).resolve().parent)) + from common import FeaturePaths, format_speckit_command, get_feature_paths + + +def _json_line(payload: object) -> str: + return json.dumps(payload, ensure_ascii=False, separators=(",", ":")) + "\n" + + +HELP_TEXT = """Usage: check_prerequisites.py [OPTIONS] + +Consolidated prerequisite checking for Spec-Driven Development workflow. + +OPTIONS: + --json Output in JSON format + --require-tasks Require tasks.md to exist (for implementation phase) + --include-tasks Include tasks.md in AVAILABLE_DOCS list + --paths-only Only output path variables (no prerequisite validation) + --help, -h Show this help message + +EXAMPLES: + # Check task prerequisites (plan.md required) + ./check_prerequisites.py --json + + # Check implementation prerequisites (plan.md + tasks.md required) + ./check_prerequisites.py --json --require-tasks --include-tasks + + # Get feature paths only (no validation) + ./check_prerequisites.py --paths-only + +""" + + +@dataclass(frozen=True) +class Args: + json_mode: bool = False + require_tasks: bool = False + include_tasks: bool = False + paths_only: bool = False + + +def _parse_args(argv: list[str]) -> Args: + json_mode = False + require_tasks = False + include_tasks = False + paths_only = False + + for arg in argv: + if arg == "--json": + json_mode = True + elif arg == "--require-tasks": + require_tasks = True + elif arg == "--include-tasks": + include_tasks = True + elif arg == "--paths-only": + paths_only = True + elif arg in {"--help", "-h"}: + sys.stdout.write(HELP_TEXT) + raise SystemExit(0) + else: + print( + f"ERROR: Unknown option '{arg}'. Use --help for usage information.", + file=sys.stderr, + ) + raise SystemExit(1) + + return Args( + json_mode=json_mode, + require_tasks=require_tasks, + include_tasks=include_tasks, + paths_only=paths_only, + ) + + +def _dir_has_entries(path: Path) -> bool: + try: + return path.is_dir() and any(path.iterdir()) + except OSError: + return False + + +def _available_docs(paths: FeaturePaths, include_tasks: bool) -> list[str]: + docs: list[str] = [] + if paths.research.is_file(): + docs.append("research.md") + if paths.data_model.is_file(): + docs.append("data-model.md") + if _dir_has_entries(paths.contracts_dir): + docs.append("contracts/") + if paths.quickstart.is_file(): + docs.append("quickstart.md") + if include_tasks and paths.tasks.is_file(): + docs.append("tasks.md") + return docs + + +def _print_paths_only(paths: FeaturePaths, json_mode: bool) -> None: + if json_mode: + sys.stdout.write( + _json_line( + { + "REPO_ROOT": str(paths.repo_root), + "BRANCH": paths.current_branch, + "FEATURE_DIR": str(paths.feature_dir), + "FEATURE_SPEC": str(paths.feature_spec), + "IMPL_PLAN": str(paths.impl_plan), + "TASKS": str(paths.tasks), + } + ) + ) + return + + print(f"REPO_ROOT: {paths.repo_root}") + print(f"BRANCH: {paths.current_branch}") + print(f"FEATURE_DIR: {paths.feature_dir}") + print(f"FEATURE_SPEC: {paths.feature_spec}") + print(f"IMPL_PLAN: {paths.impl_plan}") + print(f"TASKS: {paths.tasks}") + + +def _check_file(path: Path, description: str) -> None: + marker = "✓" if path.is_file() else "✗" + print(f" {marker} {description}") + + +def _check_dir(path: Path, description: str) -> None: + marker = "✓" if _dir_has_entries(path) else "✗" + print(f" {marker} {description}") + + +def _print_text_results(paths: FeaturePaths, include_tasks: bool) -> None: + print(f"FEATURE_DIR:{paths.feature_dir}") + print("AVAILABLE_DOCS:") + _check_file(paths.research, "research.md") + _check_file(paths.data_model, "data-model.md") + _check_dir(paths.contracts_dir, "contracts/") + _check_file(paths.quickstart, "quickstart.md") + if include_tasks: + _check_file(paths.tasks, "tasks.md") + + +def main(argv: list[str] | None = None) -> int: + args = _parse_args(list(argv if argv is not None else sys.argv[1:])) + + try: + paths = get_feature_paths( + no_persist=args.paths_only, + script_file=Path(__file__), + ) + except SystemExit as exc: + if exc.code == 0: + return 0 + print("ERROR: Failed to resolve feature paths", file=sys.stderr) + return int(exc.code) if isinstance(exc.code, int) else 1 + + if args.paths_only: + _print_paths_only(paths, args.json_mode) + return 0 + + if not paths.feature_dir.is_dir(): + print(f"ERROR: Feature directory not found: {paths.feature_dir}", file=sys.stderr) + print( + f"Run {format_speckit_command('specify', paths.repo_root)} first to create the feature structure.", + file=sys.stderr, + ) + return 1 + + if not paths.impl_plan.is_file(): + print(f"ERROR: plan.md not found in {paths.feature_dir}", file=sys.stderr) + print( + f"Run {format_speckit_command('plan', paths.repo_root)} first to create the implementation plan.", + file=sys.stderr, + ) + return 1 + + if args.require_tasks and not paths.tasks.is_file(): + print(f"ERROR: tasks.md not found in {paths.feature_dir}", file=sys.stderr) + print( + f"Run {format_speckit_command('tasks', paths.repo_root)} first to create the task list.", + file=sys.stderr, + ) + return 1 + + docs = _available_docs(paths, args.include_tasks) + if args.json_mode: + sys.stdout.write( + _json_line({"FEATURE_DIR": str(paths.feature_dir), "AVAILABLE_DOCS": docs}) + ) + else: + _print_text_results(paths, args.include_tasks) + return 0 + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/scripts/python/common.py b/scripts/python/common.py new file mode 100644 index 0000000000..77c13eefbb --- /dev/null +++ b/scripts/python/common.py @@ -0,0 +1,210 @@ +"""Shared helpers for Spec Kit Python scripts.""" + +from __future__ import annotations + +import json +import os +import sys +from dataclasses import dataclass +from pathlib import Path + + +def _trim_trailing_separators(value: Path) -> str: + text = str(value) + while len(text) > 1 and text.endswith((os.sep, "/")): + text = text[:-1] + return text + + +def find_specify_root(start_dir: Path | None = None) -> Path | None: + current = (start_dir or Path.cwd()).resolve() + while True: + if (current / ".specify").is_dir(): + return current + parent = current.parent + if parent == current: + return None + current = parent + + +def resolve_specify_init_dir() -> Path: + raw = os.environ.get("SPECIFY_INIT_DIR", "") + candidate = Path(raw) + if not candidate.is_absolute(): + candidate = Path.cwd() / candidate + try: + init_root = candidate.resolve(strict=True) + except OSError: + print( + f"ERROR: SPECIFY_INIT_DIR does not point to an existing directory: {raw}", + file=sys.stderr, + ) + raise SystemExit(1) + if not init_root.is_dir(): + print( + f"ERROR: SPECIFY_INIT_DIR does not point to an existing directory: {raw}", + file=sys.stderr, + ) + raise SystemExit(1) + if not (init_root / ".specify").is_dir(): + print( + "ERROR: SPECIFY_INIT_DIR is not a Spec Kit project " + f"(no .specify/ directory): {init_root}", + file=sys.stderr, + ) + raise SystemExit(1) + return init_root + + +def get_repo_root(script_file: Path | None = None) -> Path: + if os.environ.get("SPECIFY_INIT_DIR"): + return resolve_specify_init_dir() + + specify_root = find_specify_root() + if specify_root is not None: + return specify_root + + if script_file is not None: + script_root = find_specify_root(script_file.resolve().parent) + if script_root is not None: + return script_root + + # Installed scripts live at .specify/scripts/python/