Compare commits

...
Author SHA1 Message Date
Clay Good cd5083dcb8 docs(root): propose custom OpenSpec directory 2026-09-28 15:55:25 -05:00
Clay GoodandClaude Opus 5.5 79b6aa9c98 test: stop two Windows subprocess tests timing out at 10s (#1981)
* test(flake): give the bash-spawning scope test a 60s timeout

The Windows runner took 13.1s to spawn bash three times on the Version
Packages push to main, tripping the 10s default. The same test ran in
0.3s and 4.2s on the two previous main runs; nothing in the code changed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* test(e2e): give the git-clone init test a 60s timeout

Timed out at the 10s default on windows-pwsh three times (#1953 merge
queue, two changeset-release runs); it normally takes ~2.6s there.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 17:12:24 +00:00
openspec-release-bot[bot]andgithub-actions[bot] db23097835 Version Packages (#1953)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-09-23 21:33:22 +00:00
Clay GoodandClaude Opus 5.5 7ac58dc790 chore(changeset): track Kilo Code and Continue fixes for 1.13.2 (#1964)
* chore(changeset): track Kilo Code and Continue fixes for 1.13.2

#1938 and #1944 merged without changesets, so their user-visible
fixes would be missing from the 1.13.2 release notes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* chore(changeset): describe Kilo cleanup by file name

Cleanup deletes the known legacy file names without checking content, so
an edited copy is removed too; drop the claim that user files are kept.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 20:56:54 +00:00
336414665f fix(verify): stop reporting removed requirements as missing (#1962)
* fix(verify): stop reporting removed requirements as missing

Verify walked every "### Requirement:" in the delta specs and looked for
an implementation of each one, whatever section it sat under. A REMOVED
requirement that the change had removed correctly came back as CRITICAL
"Requirement not found", with a recommendation to implement it. An agent
that follows the report puts back the behavior the change just deleted.

Verify now notes the delta section of each requirement first. ADDED and
MODIFIED keep the existing checks. REMOVED is checked the other way
round: finding nothing is the expected result, and it is only critical
while the behavior is still in the code. RENAMED only changes a name, so
the old name is not reported as missing. Scenario coverage skips removed
requirements, since there is nothing left to cover.

Archive and sync already handle each section on its own terms; verify
was the one step in the loop that did not.

Closes #1959

* docs(specs): scope the general verify scenarios to ADDED and MODIFIED

The Spec coverage, Requirement implementation mapping and Scenario
coverage scenarios still told the verifier to check every requirement
in the delta specs, which contradicts the Removed requirement scenario
added in the previous commit. A verifier following them would repeat
the #1959 failure.

* fix(verify): report a removal-only change as ready when nothing remains

With #1732 merged, a change whose delta specs only remove or rename
requirements left Requirement Implementation Mapping and Scenario
Coverage with nothing to check. The "no usable requirements" rule then
marked them not verified, so verify never reported the change ready,
the exact case #1959 describes. Those two checks are now not applicable
when the readable delta specs hold REMOVED or RENAMED requirements and
no ADDED or MODIFIED ones. An empty or unparseable delta still marks
them not verified.

Keyword matches in openspec/ artifacts, docs, or code that serves only
the Migration note or an ADDED requirement are no longer evidence by
themselves that a removed requirement is still implemented; a code path
that still delivers the removed behavior is reported even when shared.
The summary counts removals separately from covered requirements.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(verify): check a renamed requirement's behavior against its baseline

A RENAMED entry only told verify not to report the FROM name as
missing, and a rename-only change marked the correctness checks not
applicable. Nothing checked that the renamed requirement's behavior was
still implemented, so verify could report readiness unchecked.

Spec Coverage now reads the baseline requirement from the main spec
(under the FROM name, or the TO name once synced) and checks that its
behavior is still implemented, without requiring code symbols to be
renamed. A missing behavior is CRITICAL "Renamed requirement not
found"; an unreadable baseline marks the entry not verified. A TO name
that also appears under MODIFIED is still checked there.

Regression tests cover the skill template, the command template, and
the committed skills/ mirror.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 19:28:55 +00:00
072de6bc39 fix(verify): do not report unverified dimensions as passing (#1732)
* fix(verify): do not report unverified dimensions as passing

Step 5 gates task and spec coverage on `contextFiles.tasks` and
`contextFiles.specs`. `contextFiles` is an artifact-id map and artifact
ids come from the active schema, so on a schema that defines neither, both
branches are no-ops: nothing is checked, no issues are raised, and step 8
concludes "All checks passed. Ready for archive."

The Graceful Degradation guardrail already asks the agent to note skipped
checks, but nothing stopped the all-clear verdict. Mark an unchecked
dimension `Not verified` in the scorecard and require the final assessment
to name it.

* fix(verify): map skipped checks to report outcomes

* fix(verify): retain no-task and skipped-check context

* fix(verify): harden evidence gaps and final assessments

* fix(verify): preserve optional workflows and task artifact fallback

* fix(apply): resolve tracked task globs by schema path

* fix(verify): preserve unavailable task evidence

* fix(verify): distinguish untracked tasks from missing evidence

* docs(apply): document tracked globs and JSON evidence

* test(parity): regenerate hashes after merging #1940

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(parity): restore the #1837 regression tests dropped in the merge

The earlier conflict resolution took our whole side of the parity file,
which discarded the two threshold tests main gained in #1940. Take main's
file verbatim and regenerate the hashes instead.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(parity): regenerate hashes after merging #1955

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(parity): regenerate hashes after merging #1795 and #1926

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(parity): regenerate hashes after merging #1731

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-23 17:38:11 +00:00
d6bdef6577 fix(workflows): stop reading schema from list output (#1731)
* fix(workflows): resolve the change picker's schema label from status

The update and continue templates tell the agent to read a `schema` field
from `openspec list --json` and fall back to "spec-driven" when it is
absent. `list --json` returns only `name`, `completedTasks`,
`totalTasks`, `lastModified`, and `status` (docs/agent-contract.md 4.1),
so the field is never present and the fallback fires every time: a change on
a custom schema is shown to the user as `spec-driven`.

Make the schema line optional and, when shown, resolve it from
`openspec status --change "<name>" --json` (`schemaName`).

* fix(workflows): align list prompts with JSON fields

* test(workflows): verify list and status schema contracts

* fix(workflows): keep bulk archive sync available in custom profiles

* test(parity): regenerate hashes after merging #1940

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(parity): restore the #1837 regression tests dropped in the merge

The earlier conflict resolution took our whole side of the parity file,
which discarded the two threshold tests main gained in #1940. Take main's
file verbatim and regenerate the hashes instead.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(parity): regenerate hashes after merging #1955

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(parity): regenerate hashes after merging #1733

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(archive-progress): resolve optional-workflow blocks before generating

This change makes the bulk-archive surfaces conditional on the sync
workflow being installed. #1795's task-progress test built them from the
raw templates, which leaves the [[opsx:if-workflow ...]] markers in the
text and makes skill generation throw.

Build both surfaces through getSkillTemplates/getCommandTemplates, which
resolve the blocks against an installed set, and name sync in that set so
the assertions keep testing the wording they were written for.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-23 16:59:45 +00:00
fb1b87613b fix(archive): use schema-aware task progress in workflows (#1795)
* fix(archive): use schema-aware task progress in workflows

* test(archive): verify task lookup follows the selected store

* fix(archive): reject invalid task progress in workflows

* test(parity): regenerate hashes after merging #1940

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(parity): restore the #1837 regression tests dropped in the merge

The earlier conflict resolution took our whole side of the parity file,
which discarded the two threshold tests main gained in #1940. Take main's
file verbatim and regenerate the hashes instead.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(parity): regenerate hashes after merging #1955

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-23 16:25:32 +00:00
f2812f6d18 fix(archive): copy without staging when Windows EPERM blocks rename (#1926)
* fix(archive): copy without staging when Windows EPERM blocks rename

fs.rename of a non-leaf change directory fails with EPERM on Windows
when a watcher holds a handle. The fallback required a staging rename
of the same directory, so it never ran: specs were rolled back after
printing success, and a newly created capability was left as an empty
folder git cannot see. Copy from the original source when staging also
fails with EPERM/EXDEV, and prune empty capability dirs on rollback.

Closes #1895

AI-assisted (Grok)

* fix(archive): bound the unstaged cleanup to what it verified

Addresses both review findings on the copy fallback.

The staging rename was what claimed the source before it was deleted.
Falling back without it means copy-then-remove now runs against the live
change directory, which the archive claim does not cover, and a recursive
remove deletes whatever is there at that moment - including a file
written after the final fingerprint, which never reached the destination.

Cleanup now removes a named set: the entries listed after the last
verification, deepest first. A later arrival is not in that set, so it is
never deleted, and the rmdir of its parent fails with ENOTEMPTY, which
the caller already reports as a retained destination. The move fails
loudly rather than completing with data missing.

Rollback of a created spec pruned the capability directory unconditionally,
which also removed one the user already had, along with its mode and ACLs.
The snapshot now records whether that parent existed, and only a directory
this write created is pruned.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(archive): close the listing window and the nested prune boundary

Both follow-ups from CodeRabbit's second pass, and both are right.

The removal listing was taken after the final fingerprint, which left the
window it was meant to close: a file arriving between the fingerprint and
the listing landed in the set and was deleted, having never reached the
destination. Listing before the verification makes the two orderings
exhaustive - an arrival either changes the fingerprint and aborts the
move, or is absent from the set and survives. The one case this cannot
cover, an edit to an already-listed file, is now stated in the comment.

`parentExisted` only described the target's direct parent, so a nested
capability id whose intermediate directory already existed still lost it:
the prune walked to the specs root. The snapshot now records the deepest
pre-existing ancestor and passes it as the prune boundary, which
pruneEmptyDirs never removes. That one mechanism covers the flat case too.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(archive): claim each entry before removing it in the unstaged fallback

An editor could rewrite an already-verified file between the final
fingerprint and its removal. The destination held the older bytes, the
newer ones were deleted with the source, and archive reported success.

Cleanup now renames each entry to a private claim name before reading it.
rename is atomic, so a rewrite that lands after the claim creates a new
file at the original path, which is not in the verified set, is never
deleted, and makes the parent rmdir fail. A rewrite that lands first is
caught by comparing the claimed entry against the copy, which puts the
file back and abandons the move with both trees intact.

Symlinks are compared by their target rather than by reading them, since
a link to a directory is not a directory entry and reading one is EISDIR.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(archive): draw the cleanup claim suffix per move

A fixed '.openspec-claim' suffix collided with a source file that
legitimately ends in it: claiming 'collision' renamed it over a real
'collision.openspec-claim', and that file's own turn then failed with
ENOENT after part of the live source had already been removed. A valid
tree could not archive, and its source was damaged for nothing.

The suffix is now drawn per move and checked against the entries being
removed, so no claim of one entry can land on another.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-23 16:11:13 +00:00
72fbe4c904 fix(update): close the dead end for partially populated glob artifacts (#1733)
* fix(update): close the dead end for partially populated glob artifacts

`artifactOutputExists` returns true as soon as a single file matches a glob
`generates`, so a `specs/**/*.md` artifact is `done` after the first
delta spec. `/opsx:continue` selects only `ready` artifacts and never
revisits it.

The update templates forbid creating new files under a glob artifact and
point the user to `/opsx:continue` instead, which cannot act on it. A
capability spec the coherence review finds missing therefore has no
supported way to be created.

Allow update to write that file: concrete path only, rules fetched from
`openspec instructions`, and the same confirm-before-write rule as every
other revision. Creating an artifact that has no files at all stays out of
scope - that one is genuinely `/opsx:continue`'s job.

* fix(update): tighten glob gap write guardrails

* fix(update): narrow continue handoff to empty artifacts

* fix(update): harden glob gap creation guidance

* fix(update): preserve creation safeguards for glob companions

* fix(update): integrate glob guidance with current workflows

* docs(skills): note update's glob companion-file exception

docs-lab/reference/skills.md said update creates nothing new, which this
change makes false for glob artifacts.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(parity): restore the #1837 regression tests dropped in the merge

The earlier conflict resolution took our whole side of the parity file,
which discarded the two threshold tests main gained in #1940. Take main's
file verbatim and regenerate the hashes instead.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(explore-docs): allow the update guidance line that says "no files yet"

main's #1833 guard flags any docs line containing "no files". The new
/opsx:update guidance describes which artifacts update leaves to
continue, not what explore writes, so allow that exact line.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-23 15:55:52 +00:00
Clay GoodandClaude Opus 5 ed5d386a55 fix(tasks): keep tests and docs inside each task group (#1955)
* fix(tasks): keep tests and docs inside each task group

Closes #1952

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(tasks): carry the per-group rule to onboarding and the docs

Teach the same rule where a user first meets task groups, and stop the
published schema reference from quoting instruction text that drifted two
revisions behind schema.yaml.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(tasks): scope the per-group rule to the work each group does

The MUST read as an absolute per-group requirement while the worked
example's Setup group carries neither tests nor docs. Scope the rule to
what a group's work calls for and name the scaffolding case explicitly,
so the rule and its example agree.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-23 15:04:37 +00:00
1d35e90880 fix(windows): preserve a file's existing line endings on rewrite (#1958)
* fix(windows): preserve a file's existing line endings on rewrite

The parsers normalize CRLF to LF on read, but nothing restored it on
write. On a Windows checkout (core.autocrlf=true) that turned every
rewrite into a whole-file change: applying a delta that added one
requirement produced a diff of 21 insertions and 14 deletions, burying
the real change. Archiving the same spec now writes 7 insertions and 0
deletions.

- specs-apply: write an updated spec back with the convention the file
  already used; a spec that does not exist yet stays LF.
- file-system: same fix for updateFileWithMarkers, so installing shell
  completions into a CRLF .bashrc/.zshrc no longer leaves mixed endings,
  which bash reports as "$'\r': command not found".
- pack-version-check: spawn npm through cross-spawn, since execFile
  cannot resolve npm.cmd on Windows.

Adds src/utils/line-endings.ts for the detect/restore pair, plus tests
pinning the CRLF round trip through the real write paths. Also adds
regression tests for path containment under Windows case variance:
path.win32.relative already folds case, and those tests pin both halves
of the contract so a future "case-insensitive" change cannot quietly
loosen the traversal guard.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* fix(windows): keep removeMarkerBlock on the file's own newline

Addresses the two review points and one more instance of the same bug.

`removeMarkerBlock` collapses a run of blank lines, and rebuilt the
separator as a bare '\n' regardless of the file it came from. Removing a
managed block from a CRLF CLAUDE.md or rc file therefore left a lone LF
behind - the mixed ending this PR exists to prevent. It now uses the
newline it already detects for the trailing ending.

Test fixes:

- `marker-updates.test.ts`: close `describe('line endings')` so
  `removeMarkerBlock` is no longer nested inside `updateFileWithMarkers`.
- `path-containment.test.ts`: exercise `FileSystemUtils.assertPathWithin`
  and `resolveProjectArtifactPath` instead of a private copy of the
  containment logic, which passed whatever the production guard did. The
  guard had no coverage at all; a prefix-comparison regression now fails
  the sibling case.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(windows): read the file's convention consistently, and only ENOENT as absent

Three follow-ups from CodeRabbit's pass on the superseding PR.

`writeUpdatedSpec` turned every read error into "no previous file", so an
existing but unreadable spec was treated as absent and rewritten as LF.
Only ENOENT means absent now; everything else propagates.

`removeMarkerBlock` chose CRLF whenever the content held one anywhere, so
a single stray CRLF in an otherwise-LF file pulled the whole rewrite to
CRLF. It now uses detectLineEnding, the same dominant-ending reading
matchLineEnding uses, so both write paths agree.

Added the alias-path case the containment suite was missing: a directory
link inside the root that resolves outside it. That exercises the
canonicalization half of the guard, which a lexical check cannot do - the
link's own path looks contained. Skipped where creating a directory link
needs a privilege the runner lacks.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Travis James <travis@tribehealthsolutions.com>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-23 14:30:24 +00:00
8826c0c4a1 fix(validate): require marker punctuation after a leading TBD/TODO (#1912)
* fix(validate): require marker punctuation after a leading TBD/TODO

Closes #1897

* fix(validate): keep a shouted TODO a placeholder marker

Requiring marker punctuation after a leading TBD/TODO fixed the Spanish
and Portuguese false positive, but it also stopped reporting the plainest
unwritten Purpose there is: `TODO write this once the capability settles
down.`

Case is what actually separates the marker from the word. In capitals it
is the marker whatever follows it. In any other case it is a marker only
when punctuation or the end of the line says so, which is how the
lowercase forms an agent leaves behind are written (`todo - `, `tbd.`)
and is not how a Spanish sentence opens.

Covers `todo el ...` in lowercase too, which the capitals-only reading of
the original fix would have reported.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(changeset): drop the trailing space inside a code span

markdownlint MD038. Changeset text only; no behaviour change.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-23 14:30:07 +00:00
Clay GoodandClaude Opus 5 f179ed4e40 chore(deps): bump @inquirer/core to 12.0.0 and @changesets/cli to 3.0.3 (#1954)
* chore(deps): bump @inquirer/core to 12.0.0 and @changesets/cli to 3.0.3

Consolidates Dependabot #1930 and #1931 into one PR so the flake.nix
pnpmDeps hash is computed once against the final lockfile.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(nix): refresh pnpmDeps hash for the new lockfile

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-22 23:35:21 +00:00
1515edbbbd docs(community): add openspec-guard (#1845)
* docs(community): add openspec-guard

A CLI and GitHub Action that reports which OpenSpec scenarios are covered by a
Vitest or Jest test, without running the tests.

Closes #1844.

* docs(community): update spec-guard link

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-22 23:35:18 +00:00
Clay Good 02d8c243c4 docs(troubleshooting): explain missing workflow commands (#1941)
* docs(troubleshooting): explain missing workflow commands

* test(docs): guard command troubleshooting guidance

* docs(setup): move workflow recovery to docs lab

* test(docs): scope core workflow assertions
2026-09-22 23:35:16 +00:00
fd56e12c9e fix(artifact-graph): support brace expansion and extglob output patterns (#1885)
* fix(artifact-graph): support brace expansion and extglob output patterns (#1854)

* fix(artifact-graph): preserve literal output filenames

* fix(artifact-graph): confine expanded brace patterns

* test(artifact-graph): cover later brace ranges and specify glob contract

* test(artifact-graph): resolve brace globs with Windows separators

---------

Co-authored-by: 胥寅 <xuuyin@dingtalk.com>
Co-authored-by: Clay Good <hi@claygood.com>
2026-09-22 18:09:53 +00:00
Clay Good 0b5ce44b55 fix(templates): align approval thresholds (#1940)
* fix(templates): align approval thresholds

* fix(onboard): preserve implementation choice

* test(onboard): reject premature implementation prompt
2026-09-22 17:30:19 +00:00
dependabot[bot]andClay Good fe81461d51 chore(deps): bump the production-dependencies group with 2 updates (#1929)
* chore(deps): bump the production-dependencies group with 2 updates

Bumps the production-dependencies group with 2 updates: [yaml](https://github.com/eemeli/yaml) and [zod](https://github.com/colinhacks/zod).


Updates `yaml` from 2.9.0 to 2.9.1
- [Release notes](https://github.com/eemeli/yaml/releases)
- [Commits](https://github.com/eemeli/yaml/compare/v2.9.0...v2.9.1)

Updates `zod` from 4.5.4 to 4.6.5
- [Release notes](https://github.com/colinhacks/zod/releases)
- [Commits](https://github.com/colinhacks/zod/compare/v4.5.4...v4.6.5)

---
updated-dependencies:
- dependency-name: yaml
  dependency-version: 2.9.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: production-dependencies
- dependency-name: zod
  dependency-version: 4.6.5
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: production-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>

* chore(nix): update pnpm dependency hash

Matches the production dependency lockfile update and fixes Nix Flake Validation.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Clay Good <hi@claygood.com>
2026-09-22 17:30:17 +00:00
dependabot[bot]andClay Good 2a8500a849 chore(deps): bump the website-dependencies group across 1 directory with 3 updates (#1932)
* chore(deps): bump the website-dependencies group across 1 directory with 3 updates

Bumps the website-dependencies group with 3 updates in the /website directory: [fumadocs-core](https://github.com/fuma-nama/fumadocs), [fumadocs-ui](https://github.com/fuma-nama/fumadocs) and [next](https://github.com/vercel/next.js).


Updates `fumadocs-core` from 16.15.5 to 16.15.11
- [Release notes](https://github.com/fuma-nama/fumadocs/releases)
- [Commits](https://github.com/fuma-nama/fumadocs/compare/fumadocs@16.15.5...fumadocs@16.15.11)

Updates `fumadocs-ui` from 16.15.5 to 16.15.11
- [Release notes](https://github.com/fuma-nama/fumadocs/releases)
- [Commits](https://github.com/fuma-nama/fumadocs/compare/fumadocs@16.15.5...fumadocs@16.15.11)

Updates `next` from 16.3.4 to 16.3.5
- [Release notes](https://github.com/vercel/next.js/releases)
- [Commits](https://github.com/vercel/next.js/compare/v16.3.4...v16.3.5)

---
updated-dependencies:
- dependency-name: fumadocs-core
  dependency-version: 16.15.11
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: website-dependencies
- dependency-name: fumadocs-ui
  dependency-version: 16.15.11
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: website-dependencies
- dependency-name: next
  dependency-version: 16.3.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: website-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>

* fix(website): await llms index generation

Adapts the llms.txt route to the asynchronous Fumadocs 16.15.11 API and restores the production build.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Clay Good <hi@claygood.com>
2026-09-22 17:30:15 +00:00
VeryComplexAndLongName 1d2f8f2b75 OpenSpec-UI -> OpenSpec Workbench (#1934) 2026-09-22 17:29:11 +00:00
Clay Good fe429a13dc fix(kilocode): generate commands in canonical directory (#1938)
* fix(kilocode): generate commands in canonical directory

* fix(kilocode): preserve unrelated legacy workflows
2026-09-22 17:29:09 +00:00
Javier GomezandClay Good 5b55263775 fix(init): clarify Codex desktop skill usage (#1744)
* fix(init): clarify Codex desktop skill usage

* fix(init): clarify Codex desktop skill usage

* test(init): cover Codex hints across delivery modes

---------

Co-authored-by: Clay Good <hi@claygood.com>
2026-09-22 17:29:07 +00:00
Ryan de MeloandClay Good a5ceea32cf fix(validate): report what a MODIFIED block adds, not only what it drops (#1809)
* fix(validate): report what a MODIFIED block adds, not only what it drops

When the scenario-loss guard fires it names the scenarios the block omits,
which is the whole message. A reader's next question is what the block put
there instead, and answering it separates the two cases the guard cannot:
a block that omits two names and introduces two is shaped like a rename,
one that omits two and introduces none is shaped like a truncation. Today
that costs opening both files.

Add the counts and the introduced names to the message. This decides
nothing. Intent is not recoverable from structure, the guard fires exactly
as before, and the exit code is unchanged.

The comparison already walked one direction, so the other is the same pass
run the other way. Both directions now come from diffScenarioNames, and
both commands print one shared sentence, so archive and validate cannot
drift on what they report any more than they can on what they catch.
findMissingCurrentScenarios stays as its missing half.

Also names the antecedent in validate's fix instruction, which became
ambiguous once a second list of scenarios appeared before it.

* chore(changeset): track the scenario balance in the loss guard message

* fix(validate): clarify scenario balance diagnostic

* test(validate): cover one-to-two scenario replacement

---------

Co-authored-by: Clay Good <hi@claygood.com>
2026-09-22 17:29:05 +00:00
d3d770736f fix: release archive lock on Windows (#1769)
* fix: release archive lock on Windows

* test(archive): make the Windows claim-release regression actually fail

The new test compared the lstat target against the temp-dir claim path
verbatim. The command stats the resolved real path, so on macOS
(/var -> /private/var) the comparison never matched, `dev: 0n` was never
injected, and the test only asserted that an ordinary archive releases its
claim — which already passed before the fix. Verified: it passed with the
source change reverted.

Match the claim by file name instead, and count the interceptions so the
test fails loudly if the mock ever goes inert again rather than silently
passing. With the source change reverted the test now fails as intended.

Also add the missing changeset for the user-visible fix.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(archive): keep replaced claims with absent device ids

* test(archive): retain claim when zero-device path identity changes

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-22 17:29:03 +00:00
summerandClay Good e09916e232 docs(start): explain the first change in a new project (#1146)
* docs: add beginner workflow guide

* docs(start): guide the first change in a new project

* docs(start): make greenfield guidance tool-neutral

* docs(start): use portable first-change prompts

---------

Co-authored-by: Clay Good <hi@claygood.com>
2026-09-22 17:29:01 +00:00
Clay Good c681df7058 docs(install): document Homebrew (#1946)
* docs(install): document Homebrew

* docs(install): clarify the Node prerequisite
2026-09-22 17:28:58 +00:00
Clay Good 91f2925c63 docs(config): document opener settings (#1945)
* docs(config): document opener settings

* test(config): harden opener argument contract
2026-09-22 17:28:56 +00:00
Clay Good 416599a85e docs(copilot): document workflow rediscovery (#1943)
* docs(copilot): document workflow rediscovery

* test(copilot): pair discovery claims

* docs(copilot): harden workflow recovery guidance
2026-09-22 17:28:55 +00:00
Clay Good 0dde57b401 fix(continue): keep active prompts from becoming tool calls (#1944) 2026-09-22 17:28:53 +00:00
Clay Good a64303fe1e fix(update): report legacy Codex bootstrap failures (#1939)
* fix(update): report legacy Codex bootstrap failures

* fix(update): preserve failures after declined migrations

* test(update): cover every bootstrap failure exit
2026-09-22 17:28:51 +00:00
dependabot[bot] 02fade2077 ci: bump the github-actions group across 1 directory with 4 updates (#1928)
Bumps the github-actions group with 4 updates in the / directory: [pnpm/action-setup](https://github.com/pnpm/action-setup), [DeterminateSystems/nix-installer-action](https://github.com/determinatesystems/nix-installer-action), [DeterminateSystems/magic-nix-cache-action](https://github.com/determinatesystems/magic-nix-cache-action) and [changesets/action](https://github.com/changesets/action).


Updates `pnpm/action-setup` from 6.0.10 to 6.1.0
- [Release notes](https://github.com/pnpm/action-setup/releases)
- [Commits](https://github.com/pnpm/action-setup/compare/0977fd99725f1db4007ccb2928dbb4e90d06cc86...ea17c68df8912ef543352723c149a84f56e3d413)

Updates `DeterminateSystems/nix-installer-action` from 22 to 23
- [Release notes](https://github.com/determinatesystems/nix-installer-action/releases)
- [Commits](https://github.com/determinatesystems/nix-installer-action/compare/ef8a148080ab6020fd15196c2084a2eea5ff2d25...3138316df39ed29be04236d7ffc686fa525866aa)

Updates `DeterminateSystems/magic-nix-cache-action` from 14 to 15
- [Release notes](https://github.com/determinatesystems/magic-nix-cache-action/releases)
- [Commits](https://github.com/determinatesystems/magic-nix-cache-action/compare/908b263ff629f4cc17666315b7fd3ec127c6244d...84c0677f58dcedf3b91f8223ce36a9ea5b3c84b7)

Updates `changesets/action` from 2.1.1 to 2.1.2
- [Release notes](https://github.com/changesets/action/releases)
- [Changelog](https://github.com/changesets/action/blob/main/CHANGELOG.md)
- [Commits](https://github.com/changesets/action/compare/8488615a623b1b9c987934bb89eae8af6a946ac1...ae32849d5ba541f9ae29e40e22a623bc13562f51)

---
updated-dependencies:
- dependency-name: pnpm/action-setup
  dependency-version: 6.1.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions
- dependency-name: DeterminateSystems/nix-installer-action
  dependency-version: '23'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: DeterminateSystems/magic-nix-cache-action
  dependency-version: '15'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: changesets/action
  dependency-version: 2.1.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-22 17:28:49 +00:00
Clay GoodandClaude Opus 5 518e1a0124 fix(legacy-cleanup): read a legacy command through the handle it checks (#1905)
isGeneratedLegacyCommand lstat'ed a path and then re-read it by path, so the
file judged "generated" could differ from the file read (CodeQL
js/file-system-race, alert #524, added by #1874). Open once with
O_NOFOLLOW|O_NONBLOCK, fstat that handle, and read from it. Windows lacks
O_NOFOLLOW, so links are still refused there via lstat.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-22 17:26:31 +00:00
Tabish Bidiwale bae58cf614 docs: fix Docslab links to unfinished pages (#1903) 2026-09-17 06:31:19 +00:00
openspec-release-bot[bot]andgithub-actions[bot] 634c557bd0 Version Packages (#1896)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-09-17 01:01:33 +00:00
Clay GoodandClaude Opus 5 eb03b9e933 chore(changeset): track #1835 security hardening and #1785 nix completions (#1902)
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-17 00:39:28 +00:00
Clay GoodandClaude Opus 5 3312af4799 fix(templates): open generated artifacts with a top-level heading (#1777)
* fix(templates): open generated artifacts with a top-level heading

Generated proposal.md, design.md, spec.md and tasks.md started on a
section header, so every OpenSpec artifact tripped markdownlint MD041
("first line in a file should be a top-level heading") in editors that
run it. The files were also, literally, documents without a title.

Each packaged template now opens with `# Proposal`, `# Design`,
`# Spec Delta` or `# Tasks` followed by a blank line, and
`openspec schema init` scaffolds custom templates the same way. The
schema's own examples and the customization docs match.

Titles are inert to every reader downstream: the parsers anchor on `##`
and `###`, and archive builds a new main spec from the delta's sections,
so the main spec keeps its own generated `# <capability> Specification`
and only that one.

Closes #1138

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(templates): compare template headings on normalized line endings

The Windows runner checks out CRLF, so splitting the template on "\n"
left the blank second line as "\r" and the new guards failed there while
passing everywhere else. Normalize before splitting; verified against a
CRLF copy of the templates locally.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(templates): pin each template to its own title

Review feedback: the guards accepted any top-level heading, so a wrong
title would have passed, and the archive check counted `# ` lines only,
so a demoted `## Spec Delta` would have slipped through. Assert the exact
heading per artifact, the blank line under it in both guards, and that no
heading of any level named "Spec Delta" survives archive.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(workflows): teach the artifact titles everywhere the shape is shown

The templates were only half the story. The onboarding walkthrough drafts
each artifact in the conversation and then saves what it drafted, so its
previews would have written untitled proposal.md, spec.md, design.md and
tasks.md whatever the template said. The sync workflow's delta format
reference had the same gap, sitting directly beneath a main-spec
reference that does carry a title. Both now show the template's title,
and `docs/opsx.md` no longer documents a `template` value the CLI never
returned.

Guards added:

- The template guard now enumerates every artifact of every packaged
  schema from schema.yaml rather than a hardcoded list of four, and the
  exact-title table must name every artifact the schema declares.
- A drift guard reads the titles out of the packaged templates and
  requires the onboard and sync surfaces to show those same titles, so
  guidance and template cannot part ways again.
- Parser tests pin the claim the fix rests on: a title is inert, and a
  spec or proposal parses identically with and without one.

Regenerated the skill mirrors and parity hashes for the two workflows
touched; no other hash moved.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: move the artifact-title update to the canonical docs-lab tree

The live site builds from docs-lab/, so the exact-format page there is the
one readers see. It still showed all four templates opening on a section
header and described the delta as starting with `## Purpose`.

- reference/schemas/spec-driven/index.md: each template block now matches
  the shipped template byte for byte, and the quoted spec/tasks
  instructions match schema.yaml again.
- customize/schemas.md: one line telling fork authors to keep the `#`
  title on the first line.

Reverts the edits to docs/customization.md and docs/opsx.md: that tree is
no longer published and docs-lab/README.md keeps it as source material
only, so editing it would leave two versions of the same fact.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(show): keep the change id as title for a bare `# Proposal` heading

The packaged proposal template now opens with `# Proposal`, which
`extractTitle` read as the change's title, so `show --json` and
`change list --json/--long` titled every templated change "Proposal"
instead of its id. Treat that bare heading as untitled.

Also re-quote the proposal and specs instructions in the canonical
docs-lab schema page after #1700 changed schema.yaml.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-17 00:07:26 +00:00
Clay GoodandClaude Opus 5 5f5914e7f7 fix(skills): match natural "openspec <verb>" phrasing to its workflow (#1852)
* feat(skills): match natural "openspec <verb>" phrasing to its workflow

Users and agents say "openspec propose" / "openspec apply", but no workflow
skill description contained that phrasing, so an agent hearing it had nothing
to match and routinely hand-built the artifacts with the CLI instead of
running the workflow.

Each workflow skill's description now names the phrasings that should route
to it. `openspec update` is deliberately left unclaimed: it is a real CLI
command that refreshes generated files, unrelated to the update-change
workflow, so that skill claims "openspec update change" instead.

Descriptions are emitted as unquoted YAML plain scalars, so the new tests also
pin that the generated frontmatter still parses and the description round-trips.

Closes #1221

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): derive the CLI-collision guard instead of hardcoding it

Review found the guard codified the one exception rather than the rule, so it
could never catch the next collision. It now reads every command name the CLI
registers and fails on any claimed phrase that shadows one, unless the phrase
is listed in DELIBERATE_CLI_PHRASE_CLAIMS with a reason.

Two routing fixes fall out of stating the rule:

- bulk-archive also claims "openspec archive all", so an exact-phrase match on
  "openspec archive" no longer pulls a multi-change request to the
  single-change skill.
- update-change now disclaims the openspec update CLI command in prose, not
  only by avoiding the string.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): drop the trailing clause and close the plural-archive hole

Review found the "- follow this skill rather than doing the work by hand"
trailer was decoration that contradicted two of the skills it was appended to:
sync-specs opens "This is an agent-driven operation - you will read delta specs
and directly edit main specs", and explore says "This is a stance, not a
workflow. There are no fixed steps." A description is read at selection time,
so the clause could not reach the hand-building it targeted anyway; the bodies
already carry that guidance. Removing it from all 12 also drops ~800 chars of
identical boilerplate that made update-change's CLI redirect read as filler.

Routing fixes:

- bulk-archive claims the plural phrasings that do not contain "all", so
  "openspec archive these three changes" no longer loses to the single-change
  skill on the bare literal.
- update-change redirects to the CLI command positively instead of negating
  ("run that command instead"), which routers honor far better than "not for".
- apply also claims "openspec implement", the natural English verb for it,
  which shadows no CLI command.

Corrects the recorded reason for claiming "openspec archive": the CLI command
does merge delta specs (docs/cli.md:631, src/core/archive.ts:1402). The real
reason is that the workflow confirms and verifies the merge before anything
moves, where the bare command does it in one shot.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(quickstart): name the verb phrasing that now routes to a workflow

Also rewrites the changeset to house style: links the issue, names the
commands-only scope limit, and tells a reader they need `openspec update`
to pick it up.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): walk the real command tree instead of scanning the entrypoint

Mutation testing found the collision guard was a strict subset of reality,
not the superset its comment claimed. It scanned src/cli/index.ts for
`.command('…')`, but seven groups — spec, config, schema, store, doctor,
context, workset — are registered from their own modules, so 23 real command
names were invisible. A description claiming "openspec doctor" or
"openspec spec" passed 18/18 green.

It now walks the commander tree from the exported `program` (importing it does
not parse argv; runCli does that), and a sanity test pins the seven delegated
groups so the blind spot cannot come back.

Three more holes the same pass found, all confirmed by re-running the
mutations that previously slipped through:

- phrase extraction was case-sensitive and double-quote-only, so
  "Openspec update" and `openspec update` in backticks both evaded every
  guard. Matching is now case-insensitive and accepts either delimiter.
  Unquoted prose stays excluded on purpose: the update-change redirect names
  the CLI command in prose, and prose is not a routing trigger.
- prefix shadowing was unguarded, which is the exact shape of the
  archive/bulk-archive tension. A shorter phrase contained in another skill's
  longer phrase must now be declared in DELIBERATE_PHRASE_SHADOWING.
- both allowlists accepted an empty reason and never flagged stale entries.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(skills): let the CLI-collision guard ignore hidden workflow-verb hints

PR #1776 registers the workflow verbs (explore, propose, apply, ...) as
hidden CLI commands that only point the user at the workflow. Walking the
commander tree then saw "openspec explore" as a real command and failed
the collision guard for every skill trigger.

Skip a subcommand only when it is hidden AND named after a workflow.
Visible commands and hidden non-workflow commands are still guarded,
pinned by a synthetic commander tree.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(changeset): drop em dashes from the release note

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): drop the generic by-hand clause from the explore description

The other eleven descriptions dropped it; explore is a stance, not a
workflow, so telling the agent to follow it instead of doing the work
contradicts it. Adds a regression over every workflow description.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 23:34:57 +00:00
Clay GoodandClaude Opus 5 9827762d2d fix(skills): stop workflows from adopting a project that never ran init (#1787)
* fix(skills): stop workflows from adopting a project that never ran init

Generated skills and commands are installed once per machine and offered in
every repository the agent opens, including ones with no OpenSpec at all.
Nothing stopped the workflow there: root resolution falls back to an implicit
root at the current directory, so `openspec new change` quietly creates
`openspec/` in whatever repo the agent happened to be standing in (#1645).

Two changes, both in the generated instructions:

- Every workflow now carries a shared project check. Before the first step
  that writes, the agent reads `root.source` from `openspec status --json`;
  `implicit` (or a `No OpenSpec root found` error) means the project is not
  set up, and the agent stops and asks the user whether to run `openspec
  init`, target a store, or drop OpenSpec for that request. It may not
  initialize the project on its own or let a command create the root as a
  side effect.
- Every deployed skill description now names OpenSpec. Hosts pick skills by
  description, and "Enter explore mode - a thinking partner..." reads as a
  generic offer in a repository that has never heard of OpenSpec.

Closes #1645

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(changeset): note the uninitialized-project guard

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): let onboarding run init once the user asks for it

The guard read as an absolute ban on `openspec init`, which contradicts the
option it offers one sentence earlier and the onboard workflow's job.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(troubleshooting): explain an OpenSpec workflow starting in an unset-up project

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): check the root with a command that never fabricates one

`openspec status --json` demands --change once a project has changes, so the
guard's own check could fail in exactly the projects it should wave through.
`openspec list --json` answers in one shape everywhere: a root object when the
project is set up, `root: null` both when nothing is set up and when only
stores are registered.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(skills): pin the guard against every write, not the first fence

CodeRabbit's point: checking only the first ```bash fence would miss a write
outside a fence. Assert instead that nothing preceding the guard runs a
command or writes, and that the guard sits directly under the store-selection
guidance - both fail when the guard is moved down a workflow.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* feat(new-change): say when the command had to create the root itself

The generated workflows now check for a root before writing, but the guard is
instructions - an agent that ignores it, or a human running the CLI directly,
still turned an unset-up directory into an OpenSpec project without a word.
Creating the root stays zero-config; it is no longer silent.

Human output only: --json is unchanged, and `root.source` already carried the
same fact for programmatic callers.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): tell agents the root check's non-zero exit is the answer

`openspec list --json` exits 1 when there is no root. An agent that reads that
as a broken CLI is one step from hand-creating `openspec/` instead, which is
the failure the guard exists to prevent.

Also drops a vacuous assertion: the notice test now checks that the note names
the directory it created and that the change really landed there.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* style(skills): read the guard back and untangle its two 'in that case' clauses

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): carry the store flag into the root check; pin the notice path exactly

CodeRabbit, both valid:
- With a store selected the store IS the root, so the check has to run as
  `openspec list --json --store <id>`. The store-selection paragraph above
  already says to append the flag to every command it lists, but leaving it
  implicit here invited a check against the wrong directory.
- The notice assertion matched any `openspec/` suffix. It now pins the exact
  rendered path, and a new case runs the command from a subdirectory to show
  the note names the directory actually adopted (and that the repo above it
  is left alone).

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: move the no-root contract to the canonical docs-lab pages

alfred-openspec on #1787: docs-lab/README.md makes docs-lab/ canonical and the
old docs/ tree legacy, and the canonical pages were stale in the two places the
review named.

- docs-lab/reference/cli.md, 'openspec new': documents the implicit-root notice
  after the 'Next:' line, with the exact output the CLI prints, that it goes to
  stdout and never appears with --json, and that JSON carries the same fact as
  root.source: implicit. Verified against a real run in an empty directory with
  an isolated HOME.
- docs-lab/reference/skills.md: states the shared response and stop behavior
  once, above the index table, since it now holds for every skill: confirm the
  resolved root before the first write, stop when there is none, offer init, a
  store, or dropping OpenSpec, wait for the answer, never create openspec/ on
  its own.

Drops the legacy docs/troubleshooting.md addition.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): make the no-root answer depend on how the workflow was reached

alfred-openspec's product call on #1787. One answer could not serve both
arrivals: #1645 asks the workflow to get out of the way ('it can go through the
normal general propose not the openspec'), while a user who typed the skill's
name is owed an answer about OpenSpec.

The guard now branches after the same `openspec list --json` check:

- Auto-selected: the model picked this workflow without the user naming
  OpenSpec, naming the skill, or running its command. Drop OpenSpec and answer
  the request normally, with no setup question and no mention of OpenSpec.
- Explicit OpenSpec request: stop before writing and ask whether to run
  `openspec init`, target a store, or continue without OpenSpec, then wait.

Neither branch may create the root as a side effect, stated once for both.

One text serves both surfaces rather than a command-only variant, because
apply-change and onboard render a single body into the skill and the command
alike; a command-only constant would mean threading a surface flag through
bodies that deliberately have none (#1515). The bullets scope themselves
instead, and a slash command is an explicit invocation, so only the ask branch
can apply there. A test pins that branch reaching every generated opsx command.

Four regressions: the auto-selected branch (asserting it does not mention
`openspec init` or `--store`), the explicit branch, the explicit branch's
presence in every command file, and the shared no-side-effect rule.

docs-lab/reference/skills.md said every no-root invocation asks. It now carries
the same two branches as scan anchors.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): keep the root guard off store-only projects and fix its docs

A store-only project whose `store:` line names a store this machine has
not registered reports `"root": null` from `openspec list --json`, so the
guard read a real OpenSpec project as uninitialized. The guard now checks
for the `Declared in` status message first and shows the store error
instead. A stale global defaultStore reports the same codes in unrelated
repositories, which is why the message prefix, not the code, decides.

Propose's context step from #1657 offered `openspec init` on
`no_openspec_root` regardless of how the workflow was reached. It now
defers to the project check, so an auto-selected propose skill stays
silent.

The changeset names both no-root branches, and the `new change --json`
docs separate the initialized example from the verified `implicit` one.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(skills): keep the root guard off projects with a malformed store line

A config-only project whose `store:` line is malformed reports
`"root": null` with an `Invalid store declaration in` message, not
`Declared in`, so the project check read it as never initialized and
would drop OpenSpec or offer `openspec init` there. The guard now names
both prefixes, and a root-selection test pins that every declaration
failure starts with one of them while a stale global defaultStore
starts with neither.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(skills): check guard ordering in the skill body, not its frontmatter

A skill's YAML frontmatter is metadata a host reads to choose the skill,
not instructions the agent runs, so a description that quotes a command
name must not trip the ordering check. Scope the scan to the text after
the closing frontmatter delimiter; a command injected into the body ahead
of the guard still fails.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 23:05:28 +00:00
Clay GoodandClaude Opus 5 11a9691524 fix(tasks): count unrecognised checkbox markers as not done (#1773)
* fix(tasks): count unrecognised checkbox markers as not done

A checkbox marker the task parser did not recognise was dropped from
progress entirely: it counted toward neither the numerator nor the
denominator. A tasks.md whose remaining work was written `- [~] ...`
therefore reported `✓ Complete` in `openspec list`/`status`, and
`openspec archive` raised no incomplete-task warning for it. Marking
open items with such a marker *shrank* the denominator instead of
leaving them counted as not-done.

Widen the marker to any single non-`]` character and keep `x`/`X` as
the only done state, so an unrecognised marker reads as not-done - the
fail-safe direction the pattern's own docblock argues for. OpenSpec
adopts no new marker semantics; it just stops losing the line.

Closes #1761

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(tasks): close the remaining silent-loss holes in checkbox parsing

Hardening pass on the #1761 fix.

Parser: an empty `[]` and a padded `[ x]` were dropped exactly the way
`[~]` was - checkbox-like lines counting toward neither the numerator
nor the denominator, so archive stopped warning about them. The marker
is now "at most one non-whitespace token", which covers all three.
Multi-character brackets stay unmatched on purpose: widening to
`[^\]]*` would match `- [Some doc](./doc.md)`, whose `]` is followed by
`(` rather than a space, and turn every Markdown link list into phantom
unfinished work. The docblock states that boundary and a test pins it.

Guidance: archive, bulk-archive and verify told agents to count
`- [ ]` vs `- [x]` by hand, which reproduced the same bug one layer up -
an agent following it saw no incomplete tasks in a `[~]` file even with
the CLI fixed. All six bodies (skill + command per workflow) now state
the rule the parser implements; skills/ mirror and parity hashes
regenerated.

Coverage now spans every consumer of the shared counter: `openspec
list`, archive's gate, the apply task list, validate's task-numbering
check and the parser itself, including the reported 42-done/17-deferred
ratio. Reverting only src/utils/task-progress.ts fails 7 of them.

Verified empirically: the widened pattern newly matches 0 lines across
all 1090 .md/.ts files in the repo, templates and docs included.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(tasks): state the padded-tick rule in workflow guidance too

CodeRabbit review, verified and valid: the new guidance named only
exact `[x]`/`[X]` as complete, while the parser also counts `[ x]`,
`[x ]` and `[ x ]`. An agent hand-counting by that wording would have
reported a padded tick as unfinished work and disagreed with `openspec
list` - the same guidance/CLI split this PR set out to close.

All six bodies now phrase it as the parser implements it: complete
means the box holds only `x`/`X`, spacing inside the brackets ignored;
every other marker, including an empty box, is incomplete. skills/
mirror and parity hashes regenerated.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(tasks): keep one-character link bullets out of the task count

alfred-openspec on #1773: the widened marker class let a one-character
Markdown link label parse as a checkbox, so `- [A](https://example.com)` and
`- [1](./one)` read as unfinished tasks and made progress and archive report
phantom work. The multi-character guard did not cover them: a one-character
label is one token.

The closing bracket may now not be followed by `(` or `[`, the only two
characters that continue Markdown link syntax. Nothing that used to count is
lost: a checkbox is followed by its description or by end of line, and
`- [x]done` still parses. Regressions cover both link forms, the reference
form, and a link inside a real task description.

Also updates the canonical contract, which said tasks not written `- [ ]` are
not tracked while this change deliberately tracks `[~]`, `[-]`, `[]` and a
padded `x`. Fixed in schemas/spec-driven/schema.yaml and in the docs-lab page
that quotes it, so the quote stays faithful.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: say that a done checkbox is case-insensitive

CodeRabbit on #1773: the parser lowercases the marker before comparing it with
`x`, so `- [X]` is done, but the contract I added said only `- [x]` counts.
Corrected in both copies, which are the same text.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(tasks): keep empty boxes followed by link syntax in the task count

The one-character link guard also dropped `- [ ](...)` and `- [ ][...]`,
which the strict pre-#1761 pattern counted as unfinished tasks. A line the
parser drops is one archive stops warning about, so a whitespace-only box
now bypasses the guard. The canonical tasks instruction also names `[-]`
and the padded `x` rule, in schema.yaml and docs-lab in lockstep.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(changeset): drop em dashes and state the padded-x done rule

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 22:37:25 +00:00
Clay GoodandClaude Opus 5 62106f40e3 fix(explore): name the propose workflow at every handoff (#1788)
* fix(explore): name the propose workflow at every handoff

Explore mode refuses to implement, but nowhere named the workflow that
turns the discussion into a change. The refusal, the "flow into a
proposal" ending, the closing summary, and the do-not-implement
guardrail all described the next step as prose. With no named exit,
agents answered the discovery questions and then started writing code
(#869).

All four handoff points now point at `/opsx:propose`, written in the
canonical `/opsx:<id>` form so each tool renders the invocation it
actually registers. Skill and command bodies are patched together, the
skills.sh mirror is regenerated, and parity hashes are refreshed.

Closes #869

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(explore): name the continuation after a seamless capture

The capture path let explore scaffold a change and write artifacts, then
said nothing about what came next. An agent holding a fresh proposal
inside explore mode has an obvious wrong next move, and it is the one
#869 reported. The capture now ends by naming `/opsx:propose` for the
remaining planning artifacts and `/opsx:apply` for implementation, and
says plainly that capturing artifacts is not permission to implement
them.

Widen the rendering guard to walk the real registries instead of a
hand-picked few: every registered command adapter and every entry in
AI_TOOLS must rewrite every canonical reference in both bodies, with no
`/opsx:` form surviving on any skills surface. A new adapter or a
changed invocation shape now fails here rather than shipping a command
nobody answers to.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(changeset): cover the capture-path handoff

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(explore): resolve handoffs against the installed workflow set

A custom profile can install explore without propose or apply, and the
explore skill and command still named both. Handoffs are now authored with
optionalWorkflow() and resolved in getSkillTemplates()/getCommandTemplates()
against the workflow filter every init/update path already passes. Missing
workflows fall back to explore's own capture path and the openspec
instructions apply CLI. Output with every workflow installed is unchanged.

Uses the same API and marker syntax as #1775 so the two compose.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(changeset): drop em dashes from the release note

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 22:12:45 +00:00
e67ac47f3a fix(bulk-archive): check the archive target before moving changeRoot (#1829)
* fix(bulk-archive): check the archive target before moving changeRoot

Step 8c ran `mv` with no existence check. POSIX `mv` moves changeRoot
inside an existing target directory and exits 0, so a same-day name
collision produced archive/<target>/<target>/ and was recorded as a
successful archive.

The workflow already promised the opposite in three places: the guardrail
"If archive target exists, fail that change but continue with others" and
both failure output templates listing "Archive directory already exists".
The single-change archive workflow implements the check; the bulk path did
not.

Closes #1827

* fix(bulk-archive): check archive targets before the first spec write

The existence check at the move ran after step 8a had already synced the
change's delta specs, so a collision still left main specs rewritten for a
change that stayed active. `openspec archive` settles the destination before
touching any spec; the batch now does the same in step 3 (including two
selected changes that resolve to the same target), keeps blocked changes out
of sync, conflict resolution, and the archive-everything option, and
re-checks just before the move.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(changeset): describe the pre-sync archive target check

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(bulk-archive): undo a nested move and keep blocked changes failed

The last target check and `mv` are separate steps, so a target created in
between still nested the change with exit 0. Step 8c now confirms the move
did not land inside the target and moves the change back, recording
`Archive directory already exists`, instead of reporting success.

The ready-only option recorded every non-Ready change as Skipped, which
misreported archive collisions; Blocked changes now stay Failed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(bulk-archive): require the move before asserting the nest check follows it

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(bulk-archive): say the guardrail's dated target is the one step 3d recorded

The guardrail still read 'uses current date', which invites recomputing the
name at the move. It now points to the step 3d value, matching step 8c.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: choi138 <dev@silviahealth.com>
Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 22:12:42 +00:00
605d9e7a2b fix(config): leave an unparseable global config untouched (#1876)
* fix(config): leave an unparseable global config untouched

A typo in config.json made getGlobalConfig() fall back to defaults, which telemetry read as consent: any command, even a read-only list, minted a new anonymous id and wrote it over the whole file, dropping a telemetry.enabled false opt-out and every other setting. config set, unset and profile likewise saved the defaults over it.

saveGlobalConfig() and telemetry's writeConfig() now refuse to overwrite a file they cannot parse, telemetry and the update check treat such a file as opted out, and config set, unset and profile exit with an error pointing to config edit. config reset --all can still replace the file, and the existing warning is unchanged.

* fix(config): treat a non-object global config as unreadable

Valid JSON that is not an object (null, an array, a string) also makes
getGlobalConfig() fall back to defaults, silently, so `config set` still
saved those defaults over the user's file. isGlobalConfigUnreadable() now
reports such a file as unreadable, which keeps telemetry off and routes
every save through the same refusal as a parse failure. This matches how
completion-tip already treats a non-object config.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(config): document the refusal to rewrite an unparseable config

docs-lab/reference/cli.md said `config unset` always exits 0. With an
unparseable global config, `config set`, `config unset` and
`config profile` now exit 1 and leave the file unchanged; say so, show
the message and the two fixes, and note telemetry and the update check
stay off until it is fixed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(config): warn about an unparseable global config once per command

Telemetry, the update check and the command each read the global config,
and now that none of them rewrites the broken file, the "Invalid JSON"
warning printed two or three times per command. Warn once per path.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(migration): skip profile migration for a config that is not a JSON object

A global config holding [] reached saveGlobalConfig, which now refuses
it, so init and update failed. null already crashed on a property read.
migrateIfNeeded now skips such a file, as it does for a parse failure.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(telemetry): refuse to write over a non-object global config

The telemetry writer had its own notion of an unreadable config: only a
JSON parse failure counted. Valid JSON that is not an object slipped
through, so updateTelemetryConfig() merged into it and replaced the file
-- an array, a number or a boolean became a bare telemetry object, a
string spread into numeric character keys, and null threw a TypeError
instead of the actionable refusal every other writer reports.

Funnel both notions through one predicate: isConfigRootObject() in
core/global-config.ts now backs isGlobalConfigUnreadable() and the
telemetry reader, so every shape the global guard rejects is classified
invalid on read and refused on write. Both writers report the same
one-line message via unreadableGlobalConfigMessage().

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(config): read a non-object global config as plain defaults

getGlobalConfig() spread the parsed root into its result before the
unreadable predicate was consulted, so the shape of the root leaked to
every caller: a config of "abc" returned defaults plus the numeric
character keys 0, 1 and 2. Check isConfigRootObject() right after
parsing and answer with plain defaults, as for a file that did not parse
at all.

Reported by CodeRabbit as an outside-the-diff finding.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(config): stop `config list` crashing on a null config root

`config list` re-reads the raw file to mark each value explicit or
default, and assigned JSON.parse() straight to rawConfig. A root of
`null` then crashed the command with a TypeError stack trace, the one
failure mode this PR is meant to remove, and it did so on a read-only
command. Normalize a non-object root to {} through the shared
isConfigRootObject() predicate so the listing shows plain defaults.

Reported by CodeRabbit as an outside-the-diff finding.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(config): show the telemetry notice before the first-run write check

Since #1835, nothing is tracked until the notice has been shown, so the
first-run test must show it before tracking the command.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 19:24:40 +00:00
Clay GoodandClaude Opus 5 626269ed73 fix(templates): stop generated skills naming workflows the profile omits (#1775)
* fix(templates): stop generated skills naming workflows the profile omits

The `core` profile installs six of the twelve workflows, but the update
and apply templates named `/opsx:continue` (6 times) and `/opsx:new`
(twice) regardless. On a default install those became
`/openspec-continue-change` and `/openspec-new-change` — skills that were
never written — so `update-change` refused to create a missing artifact
and handed off to a dead end. The only guard was a sentence asking the
model to check availability at runtime, 70 lines above the two places it
hits the wall.

`command-references.ts` decides how a reference is spelled; nothing
decided whether it should be emitted at all. Add that: templates author
both wordings with `optionalWorkflow()`, and `getSkillTemplates()` /
`getCommandTemplates()` — the one place every generation path already
funnels the resolved workflow set through — pick a branch before the
reference transformers run. A profile that omits a workflow now gets a
concrete `openspec status` / `openspec instructions` fallback instead of
a reference to a skill that does not exist.

Closes #1734

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(changeset): describe profile-aware workflow references

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(init): assert the core profile names no uninstalled workflow

The end-to-end init test pinned the runtime availability hedging that
#1734 is about, and asserted `/opsx:continue` appears in the default
profile's generated update workflow — the bug itself. Assert the fixed
behavior instead: neither `/opsx:continue` nor `/opsx:new` appears, and
the CLI fallback is stated outright, for both the update and apply
surfaces.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(templates): resolve every cross-workflow reference, not just core's

The first commit fixed the two templates the default profile broke on.
Every other cross-workflow handoff had the same shape, and arbitrary
subsets are reachable: a `custom` profile is whatever the user picked,
and `openspec update` re-derives a workflow set from what it finds on
disk (legacy tool overrides, inferred Codex workflows) without passing
it through getProfileWorkflows.

So resolve all of them:

- `apply` -> archive; `continue` -> apply, archive; `ff` -> apply;
  `new` -> continue; `propose` -> apply; `update` -> apply, archive;
  `archive` and `bulk-archive` -> sync.
- `onboard`'s two command-reference tables are built from the installed
  set rather than printed in full with an "only if installed" caveat, and
  its explore, resume and next-step prompts are resolved the same way.

Two supporting changes:

- `onlyWithWorkflow()` plus a whole-line rule in the resolver: a
  conditional that owns its line takes the line with it when it resolves
  to empty, so a dropped table row cannot leave a blank line that ends
  the table in markdown.
- `generateSkillContent()` and `generateCommand()` now throw on an
  unresolved marker. A generation path that skips the choke point fails
  loudly instead of writing `[[opsx:...]]` into a user's SKILL.md.

The propose and ff surfaces keep their deliberate wording difference
(#258): the command surface never invites "ask me to implement", so its
missing-`apply` fallback names the CLI rather than a conversation.

The guard test now runs the property over every subset that could expose
a reference — each workflow alone, everything but one, the empty set, and
the two shipped profiles — for skills and commands, in both spellings.
Twenty-plus of those cases fail against the previous commit.

Only `openspec-onboard` changes in the skills/ mirror: with every
workflow installed, all other templates render byte for byte as before.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(changeset): cover the full cross-workflow reference fix

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(templates): validate conditionals before choosing a branch

Resolution discarded the unselected branch and only then checked for
residual markers, so a truncated block inside the *missing* branch was
accepted for a profile that installs the workflow and rejected for one
that does not. Profile-dependent authoring errors are exactly what this
module exists to remove.

Validate the authored text up front instead: every marker must be one of
the three recognized forms, and they must appear as a flat sequence of
if / else / end. A malformed block now throws identically for every
profile. The post-resolution check stays as a backstop.

Caught by CodeRabbit on #1775.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: state the profile-aware handoff rule in the skills reference

alfred-openspec on #1775: docs-lab/reference/skills.md described several
handoffs as unconditional while this change deliberately emits a CLI or
conversational fallback when the profile omits the target.

Stated once, above the entries, rather than as a caveat on each of the eleven
affected Response and Creates rows: the page's recipe is one fact per row, and
repeating the same conditional eleven times would bury the contracts it exists
to state. The rows keep naming the skill that owns the next step, which is the
fact a reader looks up; the rule above them says what happens when that skill
is not installed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(workflows): fold #1735 into the profile-aware references

#1735 fixes the same issue (#1734) by removing the optional handoffs outright.
This PR resolves them at generation time instead, which is strictly better for
the template layer: an install that has `continue` still gets told about it.
So the mechanism here wins and #1735's content is folded in, rather than the
two competing for the same lines.

What #1735 had that this did not:

- src/commands/workflow/instructions.ts. The CLI's own runtime strings named
  the openspec-continue-change skill. Those are chosen at run time, so
  optionalWorkflow() cannot reach them; taken from #1735 verbatim.
- The blocked-state fallback. It was a one-line pointer; it now carries #1735's
  full CLI recovery (select the next `ready` artifact, not `skipped` or
  `blocked`, read its rules with `openspec instructions`, keep the selected
  `--store` on both commands) plus the tracking-file repair path and the
  `missingArtifacts` field it branches on. The installed branch still names
  `/opsx:continue`, so neither audience loses.

#1735's update-change.ts rewrite is not carried over: this PR already covers
all six of those sites conditionally, which is the better answer.

Both of #1735's test suites come across, and they are worth more here than
there. test/core/templates/profile-handoffs.test.ts asserts that no generated
file names an uninstalled workflow across every tool and all three delivery
modes, which is the property this PR's mechanism exists to provide, and it
passes against it. test/commands/profile-handoffs.test.ts covers the runtime
CLI strings. The two guards are complementary: that one is broad on tools and
deliveries, this PR's own profile-workflow-references.test.ts is broad on
workflow subsets.

#1735's command-references.test.ts assertions could not be carried as written,
since they assume the reference is gone unconditionally. Replaced with a case
that resolves the template against a set without `continue` and asserts the
fallback carries the whole recovery. Verified it fails when the fallback is
shortened.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: name the core-profile fallback on the two rows that hit it

The rule above the entries covers every profile, but apply-change and
update-change are Core skills whose rows name openspec-continue-change, which
the core profile never installs. On the default install those rows now say what
the generated skill points to instead: openspec status and openspec instructions.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(changeset): drop em dashes from the release note

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 19:17:38 +00:00
Clay GoodandClaude Opus 5 086c93b40b chore(deps-dev): bump changesets, eslint and typescript-eslint (#1901)
Applies dependabot #1898 (lockfile-only: @changesets/changelog-github 1.0.1,
@changesets/cli 3.0.2, eslint 10.10.0, typescript-eslint 8.70.0) plus the two
follow-ups its CI needed: the transitive esbuild 0.28.1 -> 0.28.2 bump in
allowBuilds, and the pnpmDeps hash in flake.nix computed by the Nix job.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 19:11:26 +00:00
7090e16d74 fix(schema): validate the apply block against declared artifacts (#1868)
* fix(schema): validate the apply block against declared artifacts

parseSchema checked each artifact's requires but never the apply block, so schema validate passed a schema whose apply.requires named an artifact that does not exist or whose apply.tracks named a file no artifact generates. At run time apply skipped the unknown id, turning the apply gate off, or blocked forever on a tracked file nothing produces.

Reject both in parseSchema, naming the bad value and what the schema declares. tracks is compared to generates by exact string, the same comparison the tracked-tasks lookups use, so any schema that parses is one they can resolve.

* fix(schema): warn instead of failing the load on an unmatched apply.tracks

apply.tracks is a path that apply reads as written, not an artifact id.
A schema that tracks a hand-written TODO.md, or one file under a glob
generates such as tasks/main.md, loads and applies correctly on main.
Rejecting it in parseSchema made every command on that schema fail.

Keep the unknown apply.requires id as a load error, the same as an
unknown artifact requires. Report an apply.tracks path that matches no
artifact's generates as a warning from `openspec schema validate`,
which still exits 0.

Move the docs note from legacy docs/customization.md into docs-lab
(schema-yaml.md validation section, cli.md schema validate). The
schema-yaml.md table had said unknown apply.requires IDs go unreported.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(schema): describe apply.tracks as a generates mismatch, not as ungenerated

The apply.tracks check compares `tracks` to each artifact's `generates` with
exact string equality, but its warning said the tracked file "is not generated
by any artifact". That is false for the case this PR deliberately supports:
`tracks: tasks/main.md` under `generates: tasks/*.md`, where the glob really
does generate the file and only the strings differ.

The diagnostic now names the real condition (the `tracks` value does not
exactly match any `generates` value, so OpenSpec cannot tell which artifact's
progress it tracks) and keeps both remedies. Both docs-lab pages, the changeset
and the JSDoc that repeated the claim are corrected the same way, and a new
CLI test pins that the glob case is described as a mismatch and never as
ungenerated.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(schema): pin apply.tracks matching across Windows path separators

The tracked-tasks lookup compares apply.tracks and generates as plain
strings, so a backslash on one side and a forward slash on the other must
warn, and the same backslash spelling on both sides must not.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 19:11:23 +00:00
a5bf5c6844 fix(validate): report requirements outside delta sections (#1804)
* fix(validate): report requirements outside delta sections

* docs(test): document orphaned-requirement test helpers

* test(parser): pin orphan reporting to the reader's section rule

Cover a header the reader does not match exactly (`## ADDED  Requirements`),
which must be reported, and a repeated `## ADDED Requirements` header with a
non-delta section between the copies, which must not. Add a patch changeset
matching the other parser fixes.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 19:11:19 +00:00
Clay GoodandClaude Opus 5 6a87a514ec test(store): give the git probe cleanup hook the setup's timeout (#1900)
Deleting the 12000 fixture files on the Windows runner outlasts vitest's
default 10s hook timeout, so the suite failed after every test passed and
knocked PRs out of the merge queue.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 19:11:17 +00:00
Clay GoodandClaude Opus 5 fede536c27 fix(update-change): draft the requested edit in step 4, write only in step 5 (#1840)
* fix(update-change): draft the requested edit in step 4, write only in step 5

Step 4 told the agent to "Apply the requested edit" while step 5 and the
guardrails told it to write only after the user confirms each revision.
"Apply" is a write verb in this very document - step 5 is titled "Confirm
and apply" - so the same request either wrote immediately or stopped and
showed the revision first, depending on which passage the agent weighed.
Step 5 is the workflow's only write path, so its confirmation guarantee
was unenforceable whenever step 4 governed.

Step 4 now drafts and says explicitly that it writes nothing; step 5
claims every write and shows the drafted edit for confirmation. Both
delivery surfaces and the committed skill carry the same wording, and a
regression test slices step 4 out of each body so no write verb can
reappear there.

Closes #1836

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(update-change): keep every edit verb out of the write-free step

Adversarial review of the first commit found three gaps.

Step 4 still opened a bullet with "Revise only files that already
exist" - the same shape as the bug, an imperative edit verb inside the
step that now declares it writes nothing. It reads as a scoping rule,
but "revise" is the write verb everywhere else in this body ("proposed
revision", "Which artifacts were revised"). It now says "Propose
revisions only to files that already exist".

The guard's `not.toMatch(/\bWrite\b/)` was inert and inverted: it was
case-sensitive, so it never matched the wording it was meant to pin,
and it could not be made case-insensitive because the fix's own text
says "do not write anything yet". It now strips that one sanctioned
sentence and rejects any remaining form of write or apply,
case-insensitively - so lowercase "write the drafted edit now", the
dangerous case, is caught. A second assertion rejects any step 4 bullet
opening with Revise/Edit/Update/Rewrite.

The changeset claimed no write verb could reappear in step 4, which was
not what the old guard did. It now states what the guard checks.

Also passes the surface label into section() so a marker drift names the
surface that broke.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(update-change): let no passage outside step 5 authorize a write

Mutation-testing the first guard found it defeatable: 20 of 25 mutations
broke the #1836 contract and still passed. The two worst were structural,
not lexical - the guard only sliced steps 4 and 5, so an authorization
placed in the intro, in step 3, in the Guardrails or in the Output
section governed the agent while no assertion ever saw it; and step 5
carried only positive assertions, so its gate could be kept and then
exempted in the next sentence, or the whole-body confirmation guardrail
deleted outright, with nothing failing.

The guard now pins step 4's draft rule and the whole of step 5 verbatim,
requires the whole-body guardrail to survive, and scans every other
passage for write verbs and their synonyms (commit/save/persist/
overwrite/reapply/flush/emit), verb-free equivalents (perform, carry
out, in place, to disk), consent-bypass phrasing, and imperative edit
bullets including ones led by an adverb. All 22 mutations are now caught.

Two wording corrections came out of the same review. "nothing earlier
writes to disk" was false - every openspec invocation persists a
telemetry id via the root preAction hook - so step 5 now claims every
artifact write instead. Step 4 says "in the conversation, not in files",
borrowing explore.ts's phrasing, so "draft" cannot be read as writing a
draft file.

docs/commands.md carried the same apply-vs-confirm collision two lines
above the confirmation bullet, contradicting the worked example directly
below it; it now says "Drafts your requested revision".

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(update-change): catch more imperative edit verbs outside step 5

CodeRabbit noted `- Modify the artifact now` slipped past the
imperative-bullet guard. Added Modify, Amend, Patch and Replace, each
verified to trip the guard. `Change` is deliberately excluded: step 6
already opens a bullet with "Change already implemented ...".

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(update-change): prove the write-gate scan trips in every section

The outside-step-5 scan was only ever checked against the real body, so
nothing showed it could fail. Injecting a verb-free authorization into the
intro, Input, steps 1-2, Output or Guardrails passed on both surfaces (7 of
10 sections). The bare "already applied" allowlist entry also erased
"treat the requested edit as already applied" before any check ran.

- Move the scan into a function and add a mutation table: one injected
  authorization per section, asserted on skill and command bodies.
- Spell every sanctioned mention in full context.
- Flag any mention of the requested edit outside the pinned draft rule.
- Widen the consent-bypass filter (needs no / exempt from / skip confirm).

Also revert the legacy docs/commands.md edit: docs-lab reference/skills.md
is the published page and already states the confirm-then-write contract.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(changeset): drop em dashes from the release note

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 16:35:49 +00:00
8fc65b7f70 fix(tasks): count checkboxes under every list marker (#1862)
* fix(tasks): count checkboxes under every list marker

The task counter behind list, status, view, instructions apply,
validate --archived and archive's incomplete-task check read only `-`
and `*` bullets. A GFM task is a list item, and CommonMark also allows
`+` and ordered `1.` / `1)` markers, so unchecked ordered or plus tasks
were dropped from every count: the change read as complete and archive
skipped its incomplete-task warning.

Accept every CommonMark list marker in TASK_LINE_PATTERN, keeping its
existing tolerances (indentation, CRLF, a missing space after the
marker). Every consumer goes through parseTaskLines, so this one change
fixes them all, and task-numbering validation now sees these tasks too.

* docs(tasks): list every counted checkbox marker in schema.yaml reference

The apply.tracks section listed only - and * checkbox forms. Task lines under + and ordered markers now count, so show them and name the marker rule. Also use American spelling in the changeset.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 16:21:23 +00:00
Clay GoodandClaude Opus 5 92fb72d1dc fix(workflows): create the main spec when a capability is new (#1701)
* fix(workflows): create the main spec when a capability is new

The agent-driven archive workflow told agents to "compare each delta spec
with its corresponding main spec" and said nothing about the case where
that main spec does not exist yet. Comparing against nothing reads as
"already synced", so the agent took the archive branch and the new
capability's main spec was never written — the change landed in
changes/archive/ with openspec/specs/ still empty.

`openspec archive` already handles this: buildUpdatedSpec creates the spec
from the delta's ADDED requirements, rejects MODIFIED/RENAMED with "only
ADDED requirements are allowed for new specs", and warns past REMOVED. The
guidance now says the same thing, so the agent path and the CLI path agree:

- archive-change: a missing main spec counts as changes needed and is named
  in the summary as a spec the sync will create — never as already synced.
- sync-specs: MODIFIED and RENAMED have no requirement to act on when the
  main spec is absent, so the sync stops and reports rather than inventing
  one; REMOVED is skipped with a warning.

Guidance text only — no CLI, parser, or archive behavior changes.

Closes #1222
Closes #1264

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(sync): never create a main spec with nothing to put in it

CodeRabbit caught a gap in the previous commit: step 4b now tells the agent
a REMOVED-only delta has nothing to remove, but step 4d still read as
"create the main spec if the capability doesn't exist yet" unconditionally.
Following both would write a spec whose `## Requirements` section is empty.

Verified against the CLI on a REMOVED-only delta targeting a capability with
no main spec:

    Specs to update:
      parking: create
    ⚠️  Warning: parking - 1 REMOVED requirement(s) ignored for new spec.
    Validation errors in rebuilt spec for parking (will not write changes):
      ✗ Spec must have at least one requirement
    Aborted. No files were changed.

So step 4d is now gated on the delta having ADDED requirements to seed the
spec with, and says what the CLI reports when it does not.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: define "main spec" and close the no-ADDED archive loop

Hardening pass over the two fixes in this branch.

Guidance: the archive step's verification pass re-runs the same comparison
the fix touched, so a delta that can create nothing — no ADDED requirements,
no main spec to merge into — would have been reported as "still needs sync"
after a sync that correctly created nothing, and an agent could loop on it.
That case now short-circuits with the reason, matching `openspec archive`,
which refuses it with "Spec must have at least one requirement".

Docs: the glossary defined "delta spec" but never "main spec", which is
half of #1647's terminology complaint. It now defines the term and says
that for a new capability the main spec is created by the archive rather
than written up front; concepts.md says the same in the delta-section table
and the archive process. The docs site generates from docs/ at build time,
so no website files change.

Changeset rewritten in the house style (prose, no commit header; the
changelog-github action supplies attribution) and renamed descriptively.

All three CLI branches this guidance describes were verified end to end:
ADDED against a greenfield repo creates the spec and carries its Purpose;
MODIFIED reports "target spec does not exist; only ADDED requirements are
allowed for new specs"; REMOVED-only aborts with "Spec must have at least
one requirement" and writes nothing.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(glossary): a standalone sync creates the main spec too

The "Main spec" entry said the spec is created "by the archive", but the
"Sync" entry two sections down says /opsx:sync creates it as well, without
archiving — and specs-sync-skill's "New capability spec" scenario is the
sync's own behavior. Names both paths so the two entries agree.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(workflows): clarify removed deltas for missing specs

* fix(workflows): preserve explicitly retired missing specs

* fix(archive): preserve explicit skip-sync choice for blocked deltas

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:51 +00:00
Clay GoodandClaude Opus 5 4c369e022b fix(explore): make the capture request the write confirmation (#1832)
* fix(explore): make the capture request the write confirmation

Explore's write-confirmation rule named `openspec new change` as an action
requiring a separate yes/no, while the capture branch told the agent to
transition "seamlessly" into running it. Both readings were defensible, so
the same request either wrote files immediately or stopped and asked.

State the resolution in all three places: an explicit capture request is
the confirmation, for the change and artifacts that request names. The
guardrail keeps its teeth where #1715 reported the problem — an
agent-proposed capture, or work beyond the requested scope, still asks.

Closes #1828

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(explore): guard the capture branch against a re-added confirmation gate

Also disambiguate the scope fence in the IMPORTANT block: "the artifacts
that request names" parses as a relative clause, and it is the sentence an
agent weighs first. Match the article used by both restatements.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(explore): put the capture discriminators where the decision is made

Four hardening findings from review of the first pass:

- A yes to an offer the agent made looks identical to a user-initiated
  capture request at the point the branch decides. The discriminator sat
  190 lines away in Guardrails. Move it into the branch, and require the
  offer to name what it would create.
- "Do not ask for a second confirmation" contradicted step 2 nine lines
  below it, which requires asking before expanding the capture. Narrow it
  to re-asking for what was already asked for.
- Scope the carve-out to change artifacts, so it cannot be read to reach
  the workflow configuration #1715 reported an agent editing.
- The Guardrails bullet restated the whole contract a third time, in a
  quick-reference list whose next-longest entry is 43 words. Replace with
  a pointer to the branch that owns it.

Tests: the three not.toContain guards could not see a gate phrased in
words they did not anticipate. Replace with a structural check that
collects every consent-bearing sentence and requires each to be sanctioned
— inside the capture branch with no topic filter, since a gate written
there is about the capture whether or not it says so. Mutation testing:
kills 6 of 8 contradiction mutations that survived before, and all three
sites stay independently pinned. The two survivors reverse the resolution
without any consent word and are noted as review-only.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(explore): keep the contact clause in the scope fence

The previous commit reintroduced "the change artifacts that request
names", the garden-path parse that 55eeac6 removed: read as a relative
clause it says the artifacts name a request. Restore "the request names",
matching both restatements. Caught by CodeRabbit.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(changeset): drop em dashes from the release note

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:47 +00:00
8146be5546 fix(list): skip unresolvable entries when dating changes (#1866)
* fix(list): skip unresolvable entries when dating changes

To sort changes by recency, list stats every file inside each change,
and any entry it could not stat failed the whole command. A dangling
symlink, such as the .#file lock Emacs keeps beside every file with
unsaved edits, or a symlink loop made list exit 1 and list --json report
no changes at all.

Skip an entry that no longer resolves (ENOENT or ELOOP) when computing a
change's last-modified time. Valid symlinks are dated as before, and any
other error still fails the listing.

* test(list): pin that a permission error still fails the listing

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:46 +00:00
72bf7600a5 fix(completion): restore .bashrc byte for byte on bash uninstall (#1872)
* fix(completion): restore .bashrc byte for byte on bash uninstall

Uninstall removed the OpenSpec block but kept the blank separator line
install adds after it at the top of .bashrc, then popped every trailing
blank line and wrote the file back without its final newline. The next
tool to append with >> (nvm, conda, rustup) merged its first line into
the user's last line.

Drop only the separator line install added when the block sits at the
top, and leave the rest of the file, including its final newline,
trailing blank lines and CRLF line endings, as it was.

* test(completion): cover content right after the block and CRLF without final newline

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:43 +00:00
388d34473a fix(init): keep user files in legacy command folders (#1874)
* fix(init): keep user files in legacy command folders

Legacy cleanup removed each pre-skills tool's <tool>/commands/openspec/ folder recursively whenever it existed, deleting any command the user kept there along with OpenSpec's three files. init runs that cleanup unprompted when there is no TTY, so agents and CI lost those files without --force.

Directory entries now name the files OpenSpec wrote there. Cleanup deletes only those, removes the folder only once nothing else is left in it, and reports each entry it kept. A folder holding none of OpenSpec's files is no longer treated as legacy, and a folder holding only them is removed exactly as before.

* docs: drop legacy migration-guide edit from legacy cleanup fix

docs/ is legacy; the canonical docs-lab page (help/legacy/migration.md) is
still a skeleton, so there is nothing to update there yet.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(init): recognize legacy command files by their OpenSpec markers

Legacy cleanup treated any regular file named proposal/apply/archive in a
<tool>/commands/openspec/ folder as OpenSpec's, so a user-authored file
with one of those names, including one swapped in while the upgrade prompt
waited, was still deleted.

Every legacy slash command was generated with the OpenSpec markers, and
OpenSpec refused to update one without them. A file now counts as
OpenSpec's only when its content still carries them, and cleanup checks
that again immediately before each unlink. A symlinked command folder is
never followed. Test fixtures now use marker-wrapped content like the real
generated files.

Closes #1873

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(init): recheck each legacy command file before the directory cleanup deletes it

The directory cleanup loop classified a folder's managed files once and then
unlinked every one of them. A file the user swapped in after that scan was
deleted and reported as deleted. Each file is now checked for the OpenSpec
markers immediately before its unlink; a file that fails the check is kept
and reported as kept.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:41 +00:00
2ef6fbde3d fix(config): run an EDITOR that carries arguments (#1878)
* fix(config): run an EDITOR that carries arguments

config edit passed the whole EDITOR/VISUAL value to spawn as the program
name with shell: false, so common settings such as `code --wait` failed
with ENOENT, and the uncaught rejection printed a raw Node stack trace.

Run the value the way git does: through sh -c '<editor> "$@"' with the
config path as a positional argument, and through cmd.exe on Windows so
.cmd shims resolve. A value that is itself the absolute path of an
existing file still runs directly, so unquoted paths with spaces keep
working. A failed start, a non-zero exit or a signal is now reported as
a one-line error and the command exits 1.

* fix(config): split EDITOR into argv instead of running a shell

Run the editor without a shell. The EDITOR or VISUAL value is split into a
program and arguments (double quotes everywhere; single quotes and backslash
escapes on POSIX; literal backslashes on Windows) and the config path is
appended as its own argument, spawned via cross-spawn with shell: false so
Windows .cmd shims such as code.cmd still resolve. Shell metacharacters in
the value are now inert.

Show the install hint only when the program is missing (ENOENT), not for
EACCES or EPERM. Move the EDITOR documentation from legacy docs/cli.md to
docs-lab/reference/cli.md.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:38 +00:00
9f8dec5dd9 fix(store): refuse to remove a store that contains another store (#1880)
* fix(store): refuse to remove a store that contains another store

store remove deleted the target folder recursively after checking only
the target's own metadata. Another registered store living inside that
folder, such as a shared store vendored as a git submodule (a layout
store register accepts), was deleted with it, uncommitted work
included, and its registry entry was left pointing at a missing path.

Refuse with store_remove_contains_registered_store when another
registration's canonical root is inside the folder. The check runs in
the beforeCommit hook, under the registry lock that commits the
removal, which now receives the registrations that will remain.

* docs(store): move nested-store remove refusal to docs-lab

Document store_remove_contains_registered_store on the canonical docs-lab CLI reference instead of legacy docs/cli.md. docs/agent-contract.md keeps the error-code entry.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:36 +00:00
208b5b5510 fix(store): stop a store named specs or changes becoming the root (#1882)
* fix(store): stop a store named specs or changes becoming the root

Stores live at ~/openspec/<id>, so a store with the id specs or changes
is itself ~/openspec/specs or ~/openspec/changes. classifyOpenSpecDir
counted that folder as planning shape, which made $HOME the nearest
root for every command under the home tree: defaultStore was never
consulted and new changes were written outside the store.

A specs/ or changes/ directory that carries store metadata is a store
root, not planning content of the directory above it.

* test(store): canonicalize phantom-root identities and cover an alias path

Compare resolved root paths with fs.realpathSync.native on both sides, and add a symlinked-alias case that must resolve the same canonical store root, per review.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:33 +00:00
5d221456e5 fix(store): let setup --no-init-git run inside a git repository (#1884)
* fix(store): let setup --no-init-git run inside a git repository

The nested-repo guard refused a setup path inside another Git
repository even with --no-init-git, which creates no repository, so a
store at ~/openspec/<id> was impossible for anyone whose home directory
is a dotfiles repo. The CLI never passed the existing bypass either:
prepareSetupInput ignored its options.

Skip the guard when initGit is false, and forward --init-git and
--no-init-git into the prepare step. The default setup and an explicit
--init-git still refuse. Two store.test.ts cases passed --no-init-git
while asserting the refusal; they now run the default setup the guard
exists for.

* docs(store): move setup nested-repo note to docs-lab

The setup --no-init-git explanation belongs on the canonical docs-lab CLI reference, not legacy docs/cli.md.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(store): compare canonical paths in setup --no-init-git test

Canonicalize payload.store.root and the registry local_path with fs.realpathSync.native before comparing, per review.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:31 +00:00
e01ed070f1 fix(archive): refuse delta files the merge path never reads (#1870)
* fix(archive): refuse delta files the merge path never reads

validate and archive read a change's deltas only from specs/<capability-path>/spec.md, but the spec-driven artifact graph counts any markdown file under specs/ as written. A delta at specs/user-auth.md was reported done by status and ready by apply, rejected by validate only as having no deltas, and then archived with exit 0 and nothing merged.

Name every markdown file under specs/ that carries delta sections but is not a capability's spec.md. validate reports it as an error with the spec.md its requirements belong in, archive runs that validation and refuses the change, and apply lists it in its warnings. --no-validate and changes with no spec files behave as before.

* docs(schemas): move delta file placement note to docs-lab

The legacy docs/ tree is frozen; the canonical page for the spec-driven
delta layout is docs-lab/reference/schemas/spec-driven/index.md.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:26 +00:00
Dwin Gharibi db560ae33f fix(validate): reject a scenario header with no body (#1858)
A requirement whose only scenario is a header with nothing under it passed validate and was then refused by archive. The delta scenario counter counted every #### header, while the spec path that archive uses to validate the rebuilt spec keeps a scenario only when its body has content, so the two verdicts disagreed and the archive error did not name the requirement.

Share one rule, hasScenarioBody, between both paths and read a scenario body up to the same boundary the spec path uses, so validate rejects exactly what archive rejects. The error names the requirement and explains that a header with no body does not count.
2026-09-16 15:47:24 +00:00
46ff91f2d6 fix(parser): read change deltas with the archive reader (#1856)
* fix(parser): read change deltas with the archive reader

`show --json --deltas-only`, the command OpenSpec's error text recommends for inspecting parsed deltas, read deltas through ChangeParser's own section lookup instead of parseDeltaSpec, the reader archive applies. A bullet-form REMOVED was invisible to it, so it fell back to the proposal's What Changes prose and reported an invented MODIFIED while archive deleted the requirement. A repeated section header was read once, and a RENAMED line written with * or + was dropped.

Derive every operation from parseDeltaSpec, keeping the existing section parser for requirement text and scenarios, and describe a change that has delta spec files by those files alone. A change with no delta spec files still falls back to the What Changes bullets.

* fix(parser): keep the prose fallback for legacy spec files with no delta section

A change whose specs/ held full future-state specs (no ADDED/MODIFIED/REMOVED/RENAMED section) lost its What Changes deltas: show --json reported none, change list counted zero, and archive printed an extra No deltas found warning. The prose fallback now applies whenever no spec file carries a delta section, which is exactly main's behavior for such changes, while a bullet-form REMOVED (which has a REMOVED section) is still read from the delta file.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:22 +00:00
Dwin Gharibi 4b5c07a0c2 fix(parser): drop closing hashes from requirement names (#1860)
CommonMark lets an ATX heading end in a closing run of `#`s, so
`### Requirement: Late Fees ###` renders as `Late Fees`. Requirement
names kept the run, so a REMOVED written that way missed the requirement
and archive exited 0 with a false "treating it as already removed"
warning, while a closed MODIFIED or RENAMED heading failed as not found.

normalizeRequirementName now strips the closing run with the rule scenario
names already use: only a run preceded by a space or tab counts, so `C#`
keeps its `#`. Every reader goes through it, and the main-spec duplicate
check now does too, so a closed and an open heading of one requirement are
reported as duplicates.
2026-09-16 15:47:19 +00:00
Dwin Gharibi 767d63c926 fix(archive): refuse requirement names differing only in case (#1864)
ADDED and the RENAMED target compared requirement names exactly, while
REMOVED and the RENAMED source already treated a name that differs only
in case or interior whitespace as a mistyped header. An ADDED `late fees`
beside an existing `Late Fees`, or a rename to `LATE FEES`, therefore
archived cleanly and left two contradicting copies of one requirement in
the main spec, which validate then accepted.

Both now refuse with an error naming the existing requirement. The source
of a rename is exempt from the target check, so a case-only rename of a
requirement to its own name still applies, and ADDED is still checked
against the spec as it stands after the earlier operations, so a variant
of a requirement the same delta removes or renames away is allowed.
2026-09-16 15:47:17 +00:00
6e62b1d522 fix(parser): refuse malformed RENAMED pairs (#1806)
* fix(parser): refuse malformed RENAMED pairs

* docs(test): document RENAMED pairing test helpers

* test(parser): pin RENAMED pairing across header copies and bullet markers

Cover the two shapes main gained after this branch was cut: a FROM in one
`## RENAMED Requirements` copy and a TO in another are both reported as
unpaired, and unpaired lines written with `*` or `+` are reported like
`-` ones. Add a patch changeset matching the other parser fixes.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Clay Good <hi@claygood.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:15 +00:00
Clay GoodandClaude Opus 5 e571b5b9ae fix(security): harden CLI against hostile-repository inputs and clear dependency advisories (#1835)
* fix(deps): upgrade vitest to 4.1.11 and override fflate

Clears GHSA-82fw-gwwq-j7x9 (path traversal / arbitrary file read via
@vitest/mocker redirect mock), the subject of all three open Dependabot
alerts. No patched 3.x exists — 4.1.11 is the first fixed release — so the
major bump is unavoidable.

Two things the plain Dependabot bump (#1823) got wrong, which is why its
tests failed on every platform:

- It left @vitest/ui on 3.x, which dragged vite/esbuild to 0.28.2 and broke
  the allowBuilds pin assertion in pnpm-workspace-config.test.ts. Upgrading
  @vitest/ui in lockstep keeps esbuild on 0.28.1.
- Vitest 4 no longer lets an arrow function stand in as a constructor
  implementation, so the ZshInstaller module mock threw "is not a
  constructor" across 8 completion tests. Converted the three mock factories
  to function expressions.

Also adds a pnpm override for fflate (GHSA-px8p-9vwx-vf98, infinite loop on
malformed ZIP64), which @vitest/ui 4.1.11 still pulls at 0.8.2.

`pnpm audit` is now clean: 0 vulnerabilities across all severities.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(core): bound schema size and stop prototype keys shadowing worksets

Two low-severity robustness defects found during the security review.

Workset lookups tested membership with `state.worksets[name] !== undefined`
on a plain-prototype object. `constructor`, `toString`, `valueof` and
friends are all valid kebab ids, so `openspec workset add constructor`
reported "already exists" against empty state, `getWorkset` returned a
function off the prototype, and `withoutWorkset` took the found branch for a
workset that was never there. All three sites now use `hasOwnProperty`.
This was never prototype *pollution* — nothing is written through these
keys and Zod's `z.record` drops `__proto__` — only a correctness defect.

`SchemaYamlSchema.artifacts` was unbounded while `validateNoCycles` walks it
with a recursive DFS, so a project-local schema declaring a long `requires`
chain crashed the CLI with an uncaught `RangeError: Maximum call stack size
exceeded` instead of a validation error. Capped at 1000 artifacts, which
also bounds the reference-resolution and graph work.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(security): stop repo-supplied text forging agent instructions

OpenSpec prints a pseudo-XML envelope that an AI coding agent consumes as
instructions, and interpolated repo content went in raw. The tags carry
authority - <project_context> means "background only", <task> means "do
this" - so a value that closes its own block is promoted from data to
directive.

Confirmed against a fresh build: a config.yaml `context:` value containing
`</project_context><system_override priority="critical">` landed a top-level
override block outside every "do NOT treat as instructions" guard. The same
breakout worked from `rules`, `description`, a dependency description, and a
schema `instruction`. A change directory name containing a quote forged
attributes on the <artifact> tag. In markdown output, a `context` line
starting with `##` forged a peer of the printer's own headings.

src/core/references.ts already had sanitizeInline written for exactly this
threat, documented as such, and simply was not applied here - it also only
flattened newlines, which one line of markup is enough to defeat. Extended it
and added three siblings beside it: escapeEnvelopeText, escapeEnvelopeAttribute,
and escapeEnvelopeCloseTags for content that must stay verbatim.

Template bodies deliberately get only their closing tags neutralized: the
shipped templates are full of `<!-- ... -->` comments and <placeholder>
markers that are copied into the generated artifact, so blanket escaping
would write &lt;!-- into every file. A block can only end at a closing tag,
so that is the load-bearing control.

Rules and operation guidance are flattened but explicitly not truncated -
they are instructions an agent must follow in full.

Separately, `openspec update` decided skill freshness from the generatedBy:
line alone and never compared bodies, so appending a step to a generated
SKILL.md still printed "All 1 tool(s) up to date". Skills now get the same
byte-comparison command files already had, and the plan names the reason.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(security): remove super-linear scans and tighten write containment

Three regexes ran over whole repository files with a `\s` class that crosses
newlines under the `m` flag, so `^\s*` re-scanned from every line start. The
blowup is in the *failing* scan - a file with no `generatedBy:` line at all -
which is also the realistic attack file. Measured on this machine:

  extractGeneratedByVersion, 63 KB whitespace SKILL.md   3,103 ms -> <5 ms
  legacy-skill compare, 63 KB whitespace frontmatter     8,131 ms -> <5 ms
  buildUpdatedSpec, 195 KB of `<!--` openers             6,817 ms -> ~90 ms

The first two are reached by `openspec update`, the first command run after
cloning. The third is reached from extractPurposeSection during `openspec
archive`, on the write path.

The scans now use `[ \t]` and walk lines, and maskHtmlComments is an indexOf
scan that visits each character once instead of a lazy regex that re-scans to
EOF from every `<!--`. Both rewrites were fuzzed against the originals -
200,000 random inputs each, 0 mismatches - so the `--!>` terminator and the
"unterminated comment runs to EOF" rule from #1413 are preserved exactly.

resolveTrustedSpecPath treated a failed containment check as permission to
re-root trust on the symlink's own target, on the theory that monorepo
symlinks may be intentional. A repo shipping openspec/specs/<cap> as a link
out of the tree therefore got `openspec archive` to write attacker-controlled
markdown to <external>/spec.md while printing the in-project path. The
fallback root must now still be inside the project, matching retireSpec,
which already refused to delete an external target.

Also: `validate <id> --type spec|change` short-circuited the name guard that
`show` applies, so a traversing id reached a bare path.join; and markTipSeen
wrote the global config through a predictable <config>.<pid>.tmp at default
0644 instead of the repo's existing writeFileAtomically (random name, 0600).

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(security): harden subprocess and shell-config write paths

Defense in depth. The audit confirmed there is no shell injection anywhere in
src/ - no `shell: true`, no user value concatenated into a command line - so
none of these are live exploits; they are the sharp edges next to that line.

Completion install wrote the completions directory into .bashrc/.zshrc inside
double quotes, so a `$(...)` or backtick in HOME/XDG_DATA_HOME became command
execution on every future shell start. Both installers now single-quote the
path through a shared helper.

`feedback` shelled out for two probes (`which gh`, `gh auth status`) directly
alongside free-form user title and body text - the most plausible site for a
future injection regression. Both are execFileSync now, behavior unchanged.

Git subprocesses inherited the default 1 MB maxBuffer with no timeout, so a
large dirty tree made `git status --porcelain` throw ENOBUFS, which gitProbe's
bare catch turned into "no git facts" - `openspec doctor` then silently stopped
reporting uncommitted changes. They now share GIT_EXEC_OPTIONS (15s timeout,
16 MB buffer) the way readCliVersion already did, and the catch distinguishes
a resource failure from "git absent" so the degraded path is no longer silent.

The GITHUB_OUTPUT heredoc in validate-changesets used a fixed EOF delimiter
over a list of PR-authored paths; it is now run-unique.

Finally, both package.json files still carried a `pnpm` block. pnpm 10 uses
that block *instead of* pnpm-workspace.yaml rather than merging with it, which
is exactly the override-displacement trap dependabot.yml documents as #1812 -
and it is where Dependabot writes when it bumps an overridden package. The
block only duplicated `allowBuilds`, so removing it leaves both lockfiles
byte-identical with every advisory override intact, and denies Dependabot the
block to write into. The workspace test now asserts `pnpm` is absent entirely.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(security): pin the update check to TLS and honor telemetry opt-out

The update check asked whatever `npm_config_registry` named, over any
protocol. A code comment asserted that file contents deliberately cannot
choose the destination; that was not true. npm exports every config source it
reads, including a `registry=` line in a repository-local .npmrc that travels
with a clone - reproduced: `registry=http://169.254.169.254/` came straight
through `npm run`.

That is a cleartext GET at an address of the repository's choosing, and it
escalates. The attacker's reply says `{"version":"99.0.0"}`, which triggers
the upgrade prompt whose default is Yes; accepting runs `npm install -g`,
which npm resolves against that same attacker registry. Cloning a repository
and answering one prompt installs an attacker-chosen global package.

Both halves are now closed. The registry override is honored only over https,
falling back to the public registry otherwise, and canSelfUpgrade() refuses
when the resolved registry is not the public origin - a private mirror can
still inform the check but can never drive an install prompt. Redirects must
stay https and on the origin resolved up front, not merely the previous hop,
so no single reply can steer the request elsewhere. The comment now describes
what the code actually guarantees.

Separately, the opt-out env vars were exact-string matches, so DO_NOT_TRACK=true
and OPENSPEC_TELEMETRY=false both silently left telemetry ON - the spellings a
user is most likely to reach for, and inconsistent with the tolerant
isCiEnvironment() helper beside them. Parsing is now tolerant, shared between
both call sites, and fails safe: an unparseable value suppresses the request.

The first --json run also sent an event before the disclosure was ever shown -
the notice is correctly deferred so it cannot corrupt machine-readable output,
but trackCommand fired regardless, and agent-driven --json may be a user's only
mode. No event is sent and no anonymous id is created until the notice has
actually been printed.

No existing guard was weakened: the 256 KB body cap, 3-redirect cap, single
budget timer, strict version regex, argv-based spawn, CI/test guards and the
four-field payload are untouched.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(security): make the close-tag escape linear

CodeQL js/polynomial-redos on the escape added in a563b0591 - and it is the
same defect class this PR set out to remove, in the fix for it.

`/<\/[A-Za-z][^>]*>/g` scans for a closing `>` from every `</`, so a template
of `</A` repeated is quadratic. Measured before: 20 KB 274 ms, 40 KB 1,223 ms,
80 KB 3,917 ms. Reachable, because escapeEnvelopeCloseTags is applied to
`template`, which is repo-controlled.

Rewritten to rewrite the `</` opener alone. The escape only ever swapped the
`<`, so for a well-formed tag the output is byte-identical - verified across
200,000 fuzzed inputs, with zero cases where the new form escapes fewer
closers than the old. It needs no scan at all (2 MB in 35 ms) and additionally
catches a closer whose `>` never arrives.

The other regexes added by this PR were re-checked the same way and are all
linear.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(nix): refresh pnpmDeps hash for the upgraded lockfile

The flake pins a fixed-output hash over pnpm-lock.yaml, so it goes stale on
any lockfile change - here the vitest 4.1.11 upgrade and the fflate override.
Hash taken from the Nix Flake Validation job, which builds specifically to
report the correct one.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(completions): quote the completions dir in printed instructions too

Two review findings.

CodeRabbit caught that only the auto-configured rc block was quoted. When
auto-configuration is off or fails, the installer prints the same lines for
the user to paste into their own rc file - and those were still interpolated
raw, so an expansion in HOME/XDG_DATA_HOME runs on every future shell start
exactly as it would have from the written block. The zsh fpath line was worse
than the bash one: not even double-quoted, so an ordinary space broke it.
Both now go through the same shellSingleQuote helper, with coverage that
exercises the auto-config-disabled path.

Windows CI also failed on a test of this PR's own: it created a change
directory literally named `x"  IGNORE-PREVIOUS  y="`, and Windows forbids `"`
in a filename. The end-to-end vector therefore does not exist on Windows, so
that case is skipped there and the escape itself is now unit-tested on every
platform.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(security): narrow envelope escaping to the tags that carry authority

The first pass escaped every `&`, `<` and `>` in repo-supplied text. A
regression review found that mangles ordinary content for every user - and
worse, OpenSpec's own shipped spec-driven schema, which writes
`### Requirement: <name>`, `specs/<capability-path>/spec.md` and
`openspec show "<spec-id>"` on eleven lines. Agents were reading OpenSpec's
own format guidance as `### Requirement: &lt;name&gt;`. Ordinary `context:`
values suffered the same way: `R&D`, `pnpm build && pnpm test`,
`Result<T, E>`, `2> api.log`.

Only a fixed vocabulary is neutralized now - the tags the printer actually
uses to frame its blocks - in both their opening and closing forms, with
attributes. That is the entire breakout surface: a block ends at its own
closing tag, and a forged opener only carries authority if it names one of
these. Everything else reaches the agent exactly as written. Verified by
rendering the real spec-driven instructions: no entity encoding anywhere.

Escaping both forms is also stronger than the first pass in one respect - it
neutralizes a forged `<task priority="highest">` opener, which the earlier
close-tag-only rule for templates let through.

Markdown heading escaping is dropped entirely. It fired inside fenced code
blocks, so a `# install deps` in a project's context became `\# install deps`
for everyone, and it defended a markdown surface with no envelope to break out
of. Guidance entries are still flattened, so the one-line forgery is still
blocked; a multi-line `context:` can add a heading inside its own labelled
block, which is an accepted limit now recorded in the test.

sanitizeInline goes back to flattening only, so JSON output stops
entity-encoding spec Purpose lines.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(security): repair four regressions the hardening introduced

A regression review of this PR found four ways the fixes broke legitimate
behavior. All are confirmed and reproduced.

**validate rejected every nested spec id.** The new name guard sits in
validateByType, which is the funnel for three entry paths, not just --type.
Nested capabilities (specs/<area>/<capability>/spec.md, #1353) have ids
containing `/`, so `openspec validate platform/session-layout` started
failing - including the exact command `validate --specs` prints as its own
hint. The guard now runs per path segment, so `..` and backslashes are still
refused while nested ids pass.

**git writes could wedge a user's repository.** GIT_EXEC_OPTIONS was applied
to `init`, `add`, `commit` and the rollback `rm --cached`, with
killSignal SIGKILL. git traps SIGTERM to remove .git/index.lock on its way
out; a signal it cannot catch leaves the lock behind, so every later git
command in the store fails with "Another git process seems to be running" -
including the best-effort unstage, which runs in exactly that case. 15s was
also too short for a signed commit waiting on pinentry. Writes now have their
own bounds: no hard kill, 120s.

**A private registry silently became the public one.** Rejecting a non-https
registry fell back to registry.npmjs.org, which sends the request an internal
mirror deliberately avoided and reports a version resolved against a registry
the eventual `npm install -g` does not use. A rejected registry now disables
the check instead, and isDefaultRegistry reads the raw env var so it still
disqualifies a self-upgrade.

**Redirects were pinned to one origin**, which killed the mirror and corporate
front-end case the redirect support exists for. Cross-host is allowed again;
leaving TLS is not.

Also: an external capability symlink is no longer refused. Two places in this
codebase document such links as intentional monorepo layout, so refusing them
broke a supported setup. The real defect was silence - the CLI reported the
in-project path while writing elsewhere - so the write proceeds and names its
actual destination.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test: make the new security tests portable and discriminating

A test-quality audit of this PR's own tests.

The ReDoS bounds passed on reverted code far too easily - discrimination was
only 1.9x, 3.0x and 2.6x, so a full revert could slip through on a fast
machine. These scans are quadratic, so the hostile inputs are now large enough
to separate the two decisively: 32x, 32x and 10.6x, with the fixed code still
running in milliseconds against a 500-800ms bound. Comments that cited
invented pre-fix timings are replaced with measured figures or a plain
statement of the complexity.

git-probe-limits wrote 6000 files with 245-character basenames, putting the
absolute path past MAX_PATH on a windows-latest runner - and it sits in
beforeAll, so the whole file would have died there. 120-character names x
12000 files keeps porcelain output over the 1 MB threshold at ~190-character
paths. This is the same class of defect as the Windows failure already fixed
in this PR.

validate.name-guard built its fixture at process.cwd(), which is not
gitignored; a security test should not leave files in the working tree.

The worksets test looped over three names but only `constructor` is actually
on Object.prototype and a legal id, so two thirds of it passed unchanged on
main. `__proto__` is not reachable - isKebabId rejects underscores - and both
facts are now stated rather than papered over.

Adds the missing coverage for the git timeout half of the exec hardening,
against synthetic error shapes rather than a 15-second sleep, including the
negative cases that keep the classifier honest.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test: write the git probe fixture without exhausting file descriptors

Sizing the fixture up to 12000 files to keep porcelain output over 1 MB made
the writes EMFILE on the macOS and Windows runners - 12000 concurrent
fs.writeFile handles is well past their descriptor limit, and the failure took
the whole beforeAll with it. Written one at a time instead; the hook still
finishes in about a second.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(instructions): correct a comment that claimed a dropped heading guard

The operation-inputs printer never escaped leading '#'; that escaping was
removed because it fired inside fenced code. The comment still described it.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(archive): name the capability in the external-link warning

The warning printed 'spec.md' for every external capability, so the
link could not be identified. Report the capability directory, and assert
the full platform-specific completion lines in the bash and zsh fallback
instruction tests.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(security): escape envelope tags split by line-break whitespace

ENVELOPE_TAG only accepted a space or tab between the tag name and `>`,
so a multiline repo value such as `</project_context\n>` closed the
context block and could forge a top-level `<task>`. Use `\s`; the
`[^<>]` tail keeps the match linear. Adds regressions for split closing
and opening tags and a timing guard on multiline openers.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:12 +00:00
Clay GoodandClaude Opus 5 3b8e5b6616 fix(nix): install shell completions with the flake package (#1785)
* fix(nix): install shell completions with the flake package

The flake exposed `openspec completion generate SHELL` but installed no
completion scripts, so a Nix install had no completions at the standard
locations. Generate the Bash, Fish, and Zsh scripts during postInstall and
place them with installShellCompletion.

Closes #1740

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: note that cross-compiled Nix builds omit completions

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* ci: run the Nix job when the completion generator changes

The Nix build now runs `openspec completion generate`, so a change under
src/core/completions can break packaging without touching flake.nix.

Also drops the cross-compilation caveat from the Nix install docs: every
package this flake exposes is native (`legacyPackages.<system>` has
buildPlatform == hostPlatform), so `canExecute` is always true and the
completions are never omitted.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: move the Nix completions note to the canonical pages

docs-lab/README.md makes docs-lab/ canonical and the old docs/ tree legacy, so
the fact is recorded in the two docs-lab pages that own it and docs/cli.md and
docs/installation.md are back to their state on main.

- docs-lab/start/installation.md, Nix: the package ships the scripts at the
  standard locations, so completion install is not needed.
- docs-lab/reference/cli.md, openspec completion: the same exception, stated
  where a reader looking up the command will hit it, linking to the Nix
  section rather than repeating the paths.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:11 +00:00
Clay GoodandClaude Opus 5 7de24044ef fix(init): make the universal tool target findable in the picker (#1778)
* fix(init): make the universal tool target findable in the picker

Closes #653

`openspec init`'s tool picker is a searchable list of product names. The
vendor-neutral target every unlisted assistant is meant to use was named
"Shared .agents skills" — after the directory it writes, which is not a
word anyone in that position searches for. Typing "universal", "other" or
"generic" returned "No matches", so the escape hatch was unreachable and
the reporter had to open an issue to find it.

Rename the entry to "Other / Universal (shared .agents skills)" and give
choices optional `searchAliases` the filter also matches. The picker also
dropped every non-alphanumeric keystroke: readline reports punctuation
only in `key.sequence`, leaving `key.name` undefined, so ".agents" and
"amazon-q" could not be typed at all.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(init): point at the universal target when a tool search matches nothing

"No matches" is where someone whose assistant is not on the list gives
up — the picker knows the answer and does not say it. Add an optional
`emptyHint` to the searchable multi-select, and have init name the
vendor-neutral entry there.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(init): close every dead end that hides the universal tool target

Hardening pass over the same defect. Reviewing the first fix turned up
four more places the answer was withheld:

- `openspec update`'s tool picker builds its own choices and never
  passed searchAliases through, so the same search failed there.
- `--tools <unknown>` printed a bare list of ids. It now names the
  fallback, the scripted counterpart of the picker's empty hint. The
  hint I first put on validateTools sat on an unreachable branch; the
  path users actually hit is the "Invalid tool(s)" parse error, and a
  test now pins it.
- The search box dropped pasted text as well as punctuation. Any
  sequence whose characters are all printable is now accepted, which
  also lets a space reach the box so "claude code" filters. Escape
  sequences carry control characters and are still rejected, and the
  `name` fallback stays single-character so readline names like 'tab'
  are never typed.
- docs-lab still taught the old label in two places.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: keep the FAQ a router and finish the alias list

- help/faq.md is a one-liner surface (README's "FAQ is one-liners" rule),
  so the answer points at the support matrix's Other / Universal section
  instead of restating the picker's search terms. Drops the em dash that
  writing.md forbids.
- reference/supported-tools.md keeps the search terms, now all nine the
  picker actually matches: `vendor-neutral` and `agents.md` were added to
  searchAliases after the first draft of this page. Same correction in the
  legacy docs/supported-tools.md paragraph.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(init): keep the tool-not-listed hint ASCII

The non-interactive fallback hint is new terminal output and carried an em
dash, an ambiguous-width glyph in the class #983 covered. A colon reads the
same and cannot misalign a terminal.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: drop the legacy docs/ tool-matrix edit

docs-lab/reference/supported-tools.md already carries the label and search terms.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(init): prove picker punctuation through real readline key events

The prompt tests fed a multi-character sequence that readline never emits:
it splits a paste into one key per character, so a pasted space still
toggles. Drive the handler with real emitKeypressEvents output (fails on
main with 'amazonq'), pin the space limit, and stop claiming multi-word
paste in the changeset and code comment.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:10 +00:00
Clay GoodandClaude Opus 5 8b99c07bd0 fix(status): name the command that resumes a change (#1786)
* fix(status): name the command that resumes a change

`openspec status` printed the artifact checklist and stopped. The command
that moves the change forward was computed already and shipped in the JSON
`nextSteps` sentence, but the text surface never rendered it, so anyone
resuming a change had to know the next command by heart.

Extract `resolveNextStep` so the command and the published sentence come
from one place, and print it as a `Next:` line — matching the idiom
`openspec new change` already uses to hand off to `openspec status`.

The completion case matters most: "All planning artifacts complete!" reads
as "you are done" even while implementation tasks remain, and it is now
followed by the `openspec instructions apply` command that resumes the work.

Closes #906

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* style(status): keep the loadStatus comment on loadStatus

The store-flag note landed between the "single definition" comment and the
declaration it describes.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(status): cover the next-step line, and record it in the spec

The behavior change shipped without the OpenSpec change this repo requires
of user-facing work, and without coverage for the paths a reviewer would
reasonably ask about.

Adds `add-status-next-step`, whose delta modifies `Next Artifact Discovery`
in `cli-artifact-workflow` - the requirement that already says status is how
you learn what comes next. It now also says status names the command.

Coverage added:
- Unit tests for `resolveNextStep`, pinning the published `nextSteps`
  sentences verbatim. Confirmed byte-identical to main's output, so the
  split into command + sentence provably did not reword the contract.
- Custom-schema case: the line is built from the resolved artifact id, so a
  project with neither proposal/specs/design/tasks still gets a usable
  command.
- Skipped artifacts are never named - they satisfy dependents but must not
  be created.
- `--json` stays parseable and carries no `Next:` line.
- `--all` gives every change its own line, and a failed entry none.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(status): assert the next-step line closes the output

The spec delta says the text output ends with the `Next:` line, but the
assertions used toContain, which a later line would still satisfy. Compare
the last non-empty line instead, across all four ready/complete cases and
the skipped one.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(status): read the closing line CRLF-safely

Split on /\r?\n/ so a CRLF stream cannot leave a carriage return attached
to the line under comparison, and route the parity check through the same
helper instead of its own scan.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs: move the status Next: line to the canonical CLI page

docs-lab/README.md makes docs-lab/ canonical and the old docs/ tree legacy, so
the entry now lives under 'openspec status' in docs-lab/reference/cli.md and
docs/cli.md is back to its state on main.

Both documented outputs were captured from real runs rather than written by
hand: the blocked case in a change with proposal and specs, and the complete
case with all four artifacts.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(status): drop em dashes from the changeset and proposal

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:08 +00:00
Clay GoodandClaude Opus 5 09a999bbb2 fix(changes): report a change nested in a namespace folder (#1849)
* fix(changes): report a change nested in a namespace folder

Specs can be nested by domain (`specs/mobile/tutorial-videos/spec.md`), so
laying changes out the same way looks reasonable - but a change is only ever a
directory directly under `changes/`. `changes/mobile/refresh-token/` left the
real change invisible to every command while `mobile`, the folder around it,
was reported as an ordinary task-less change. Nothing said so, and
`openspec archive mobile` moved the unfinished change into the archive under
the namespace's name with none of its deltas applied.

A directory under `changes/` is now recognised as a namespace folder when it
carries no change-root artifact of its own and wraps a directory that does.
The probe is deliberately conservative: a miss behaves exactly as before, and
an ordinary change - including a scaffolded one with no artifacts yet, and one
whose only content is a root delta spec - is never reported as a folder.

- `openspec list` marks it `not a change` and explains the flat-only layout
  instead of printing `No tasks`; `--json` gains an additive `warnings` entry.
- `openspec show` and `openspec status --change` say the same rather than
  reporting a change that has no proposal yet.
- `openspec validate` reports the nesting instead of "must have at least one
  delta", with next steps that name the fix rather than delta authoring.
- `openspec archive` refuses it outright - burying an active change is data
  loss, not something to warn about.

Closes #1846.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(agent-contract): document the list --json nesting warning

Agents read 4.1 as the shape contract, so the additive `warnings` array and
per-entry `nested` field have to appear there, along with the instruction not
to treat a flagged entry as a change.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(changes): harden the nested-change probe and cover status --all

Adversarial review of the first commit found three holes.

A custom schema may generate every root artifact into a subdirectory
(`generates: rfc/proposal.md`). Created by hand, such a change carries no
`.openspec.yaml`, so the marker probe read it as a namespace folder wrapping a
change called `rfc` - a legitimate change that validated clean before, now
refused by validate, status, instructions and archive, with no flag to get
past it.

The same probe missed the case it was written for whenever the nested change
started from its delta specs rather than a proposal: `mobile/refresh-token/`
holding only `specs/auth/spec.md` still archived as `mobile`, deltas dropped.
A nested change is always hand-made - `openspec new change` rejects a name with
a separator - so "mkdir the tree, write the deltas first" is a common way to
arrive here.

Both come from asking one question. A directory is now recognised as a change
by a root artifact OR a populated `specs/`, and a directory holding any file of
its own is never a namespace folder. The `specs/**/*.md` shape is fixed by the
delta format rather than by the schema, which is what makes it safe to lean on.

`change show archive` also reached the probe - it has no reserved-name guard -
and offered to rename every dated archive entry into an active change. The
reserved name is rejected in the probe itself, so no caller can repeat it.

`status --all` read each directory straight through `loadStatus`, bypassing the
lookup guard, and printed a whole artifact plan for work that is not there. It
now carries the same per-change diagnostic a malformed change does, and the
sweep continues past it.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(changeset): state the nesting-detection bound

CodeRabbit asked for the three-level limit in the release note. Stated as a
closing sentence rather than a qualifier on the headline, so the note still
leads with what changed for users.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(changes): trust the resolved schema before calling a folder a namespace

A hand-made change under a custom schema that generates into a subdirectory
(rfc/proposal.md), with no .openspec.yaml and no delta specs yet, was read as a
namespace folder and refused by status, show, validate, instructions and
archive. The probe now also counts a file at any path the resolved schema
generates, the same check status uses to mark an artifact done.

Move the flat-change-folder docs from legacy docs/ to docs-lab reference/cli.md.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:06 +00:00
Clay GoodandClaude Opus 5 09984b8242 fix(validate): warn when tracked tasks have no checkboxes (#1774)
* fix(validate): warn when tracked tasks have no checkboxes

Progress counts checkboxes and nothing else, so a tasks.md written as
plain bullets or a numbered list is worse than an empty one: `openspec
list` and `openspec status` report "No tasks", and `openspec archive`
has no incomplete task to warn about. The file reads as finished to the
tool and unfinished to a human.

`openspec validate` now warns when every task file the change's schema
tracks contains list items but not one checkbox, pointing at the first
offending line. Reported per change, not per file, so a checklist
alongside a prose file stays silent, and only files an artifact actually
declares are linted - a bare tasks.md no schema tracks is left alone.

Closes #354

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(validate): honor fence delimiter length and width

CommonMark closes a fence only on the same character, a run at least as
long as the opener's, and no info string. Comparing the first character
alone let an inner ``` end an outer ```` block, exposing the bullets of
a nested code sample as a task list. The delimiter pattern also loses
its end anchor: `.` does not match `\r`, so an anchored info-string
group matched nothing in a CRLF file and blinded the scan to fences.

Adds the nested-fence, annotated-closer, tilde/backtick, longer-closer
and CRLF cases, plus an e2e change whose nested task files are all
bullets, asserting both reported paths stay POSIX-separated.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(validate): scan rendered content and complete evidence only

Hardening pass over the checkbox warning.

The scan for the offending line now skips YAML front matter and HTML
comment blocks alongside fenced code. A list under `tags:` is metadata
about the file rather than the work it tracks, and a commented-out list
is not work either; each exclusion can only silence a warning, never
drop a real task, which is the opposite trade from the task parser. An
unterminated `---` opener rewinds to the top, because that is a thematic
break and everything below it is still content. Only a comment opening
its own line hides that line, so the template's `## 1. <!-- Task Group
Name -->` heading cannot swallow the checklist beneath it.

A tracked file that exists but cannot be read now withdraws the warning
entirely: "no file here holds a checkbox" is a claim about the whole
tracked set, and the checkboxes may be in exactly the file that would
not open. `validate --archived` stays the surface that reports an
unreadable task file loudly (#205).

The message leads with the consequence rather than an accusation, since
a file may legitimately carry a bulleted note and no tasks yet.

New coverage: every packaged tasks template is asserted checkbox-shaped
(the guard fails if a template loses its boxes), a schema tracking tasks
by artifact id with no `apply` block, the deprecated `change validate`
text output, and an unreadable tracked file.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(validate): match CommonMark on fence indent and front matter

Two block-scanning defects, both of which hid list items.

A fence indented four spaces is an indented code block, not an opener.
Accepting it left the scan inside a block that never began, so every
list below it went unseen. Fence recognition now stops at three spaces.

`----` is a thematic break, not a YAML front-matter delimiter. Matching
three-or-more dashes let one open a block that swallowed the list under
it until the next `---`. Front matter is now exactly three dashes.

Two test defects alongside them. The deprecated-command test claimed to
assert the reported line, but the text renderer prints no line for any
issue; it now asserts the level and path prefix that surface actually
emits, with the line left to the JSON assertion that already covers it.
The unreadable-file fixture would have passed for the wrong reason had
the mode not taken, since the checkbox it hides would have silenced the
warning by itself; the read failure is now asserted first.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(validate): name task files relative to a canonical change dir

Windows CI caught the report naming a task file
`../../../../../../../../runneradmin/AppData/.../tasks.md` instead of
`tasks.md`. `resolveArtifactOutputs` hands back real paths while
`changeDir` carries whatever spelling the caller resolved, and a short
8.3 alias against its expanded form is a difference in spelling, not in
location, so the relative path escaped the change. A symlinked project
directory reproduces it off Windows.

Canonicalizing both sides recovers the relationship. A path that still
escapes falls back to the file name, so no report can leak an absolute
filesystem path. Numbering issues are named through the same helper and
gain the same fix.

The deprecated-command test now asserts the `[WARNING] tasks.md:` prefix
that exposed this, and the Windows job is its regression guard: the
mismatch cannot be staged on POSIX, where the spawned CLI's cwd is
already physical.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(validate): keep indented code out of the uncheckboxed-task scan

alfred-openspec on #1774: the scan said it reads rendered content, but
LIST_ITEM began with \s* and so reported top-level four-space-indented code
such as '    - example output' as an uncheckboxed task list. Under --strict
that false positive failed validation on a correct file.

A list-shaped line is now taken only below four visual columns of indent, the
same cut the fence logic already applies, with tabs counting as four. Genuine
nested lists are untouched: this scan reports the first list item it finds and
a nested item always sits under a shallower parent, so the parent is reported
exactly as before. A list-shaped line four columns deep with nothing shallower
above it is not nested under anything, which is what makes it code.

Regressions cover space-indented, tab-indented and numbered code samples, and
pin both the nested-list case (parent still reported) and three-space indent
(not code). Verified the guard bites: removing the column test fails them.

Also moves the documentation to its canonical home. docs-lab/README.md says the
old docs/ tree is legacy and must stay untouched, so the docs/concepts.md line
is dropped and the warning is documented under 'openspec validate' in
docs-lab/reference/cli.md, beside the archive merge findings.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(validate): skip BOM-prefixed front matter and cap ordered markers at nine digits

A prose-only task file that opened with a UTF-8 BOM before its front
matter was warned about, because the opener never matched and the
tags list was scanned. A number longer than nine digits followed by a
period also matched as a list item, which CommonMark does not allow.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(changeset): drop the em dash

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(tasks): use a multi-character marker for the unrecognised-checkbox case

A single-character marker such as `[~]` becomes a task once #1773 lands,
which would flip this expectation. `[ab]` is not a task under either
parser, so the test keeps asserting that checkbox-looking list items that
count as no task still warn, whichever PR merges first.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:47:04 +00:00
Clay GoodandClaude Opus 5 b928165276 docs(explore): stop claiming explore never writes files (#1838)
* docs(explore): stop claiming explore never writes files

Sixteen lines across both documentation trees told users that
`/opsx:explore` creates no artifacts and writes no files, full stop.

That has been false since explore shipped (#467): its capture branch
writes the planning artifacts the user asked for, and can edit an
existing change's artifacts. #1503 later made it scaffold with
`openspec new change` first, closing #668 and #720.

The claim appeared in two shapes. Six lines denied the capability
outright ("Explore creates no artifacts and writes no code"). Ten more
said the same thing as a timing claim ("before any artifact exists"),
which reads as ordinary pitch copy and is what escaped the first pass.

Every site now carries one guarantee, worded the same way: explore
never writes code, and writes nothing else unless you ask, or say yes
when it offers. Four sites described only the user-initiated trigger,
which left the offer path - the one a reader actually hits - looking
like it did not exist.

docs/explore.md and docs/commands.md also gain a positive description
of capture where the denial used to sit, including what scaffolding
creates beyond the artifacts you named, and how capture differs from
handing off to propose (propose writes the set your schema requires;
capture writes only what you named).

Closes #1833

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(docs): keep the retired explore wording retired

A flat list of the phrasings that actually carried the claim, swept
over the eleven pages that pitch explore. Fails on main with all
sixteen offenders; clean on this branch.

Modeled on test/vocabulary-sweep.test.ts, and deliberately a list
rather than a grammar. An earlier draft built the grammar - section
splitting, code-fence tracking, a conditional-marker exemption so
"creates no artifacts unless you ask" would pass - and measured
against realistic prose it was imprecise in both directions while
returning the same verdict on the real input. The list has no
exemption logic to get wrong, and any maintainer can extend it.

Phrasings that are only wrong in the absolute ("writes nothing",
"creates nothing") are left to review, since the conditional form of
each is the wording the failure message recommends.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(docs): pin the explore capture contract, not the word

The guide check matched any "capture", so "explore automatically captures
every artifact" passed. Both explore.md and commands.md now must name the
user trigger, `openspec new change`, and the named-artifacts scope, with no
capture line claiming it happens unprompted, and keep "never writes code".

Also scope the explore.md guarantee to the setup files a new change needs,
and make the commands.md offer name the change and its scope, which the
template asks for on main and after #1832.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(docs): accept negated unprompted-capture wording, catch non-capture verbs

The unprompted check matched "automatically" on any capture line, so the
correct "Explore does not automatically capture artifacts" failed, while
"Explore automatically writes planning artifacts" was never scanned because
it lacks the word capture. Check each clause of lines naming explore or
capture for an unprompted write verb with no preceding negation.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:45:53 +00:00
255 changed files with 20562 additions and 2195 deletions
+28 -7
View File
@@ -42,6 +42,10 @@ jobs:
- 'pnpm-workspace.yaml'
- 'scripts/update-flake.sh'
- '.github/workflows/ci.yml'
# The Nix build runs `openspec completion generate`, so a change to
# the generator can break packaging without touching flake.nix.
- 'src/commands/completion.ts'
- 'src/core/completions/**'
test_matrix:
name: Test (${{ matrix.label }})
@@ -77,7 +81,7 @@ jobs:
persist-credentials: false
- name: Setup pnpm
uses: pnpm/action-setup@0977fd99725f1db4007ccb2928dbb4e90d06cc86 # v6
uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
- name: Setup Node.js
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
@@ -132,7 +136,7 @@ jobs:
persist-credentials: false
- name: Setup pnpm
uses: pnpm/action-setup@0977fd99725f1db4007ccb2928dbb4e90d06cc86 # v6
uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
- name: Setup Node.js
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
@@ -176,10 +180,10 @@ jobs:
persist-credentials: false
- name: Install Nix
uses: DeterminateSystems/nix-installer-action@ef8a148080ab6020fd15196c2084a2eea5ff2d25 # v22
uses: DeterminateSystems/nix-installer-action@3138316df39ed29be04236d7ffc686fa525866aa # v23
- name: Setup Nix cache
uses: DeterminateSystems/magic-nix-cache-action@908b263ff629f4cc17666315b7fd3ec127c6244d # v14
uses: DeterminateSystems/magic-nix-cache-action@84c0677f58dcedf3b91f8223ce36a9ea5b3c84b7 # v15
# Run the update script before `nix build`, not after. The script recomputes
# the pnpmDeps hash from pnpm-lock.yaml and rewrites flake.nix in place, so a
@@ -219,6 +223,19 @@ jobs:
echo "Error: openspec binary not found in build output"
exit 1
fi
for completion in \
"share/bash-completion/completions/openspec.bash" \
"share/fish/vendor_completions.d/openspec.fish" \
"share/zsh/site-functions/_openspec"; do
if [ ! -s "result/$completion" ]; then
echo "Error: completion script missing or empty: $completion"
exit 1
fi
done
if [ "$(head -1 result/share/zsh/site-functions/_openspec)" != "#compdef openspec" ]; then
echo "Error: zsh completion is not autoloadable (missing #compdef header)"
exit 1
fi
echo "✅ Build output verified"
- name: Test binary execution
@@ -248,10 +265,14 @@ jobs:
changed_changesets="$(git diff --name-only --diff-filter=ACMRT origin/main...HEAD -- '.changeset/*.md' ':!.changeset/README.md')"
if [[ -n "$changed_changesets" ]]; then
echo "has_changesets=true" >> "$GITHUB_OUTPUT"
# Run-unique delimiter: the value is a list of PR-authored paths, so a
# fixed "EOF" would let a crafted path close the block early and append
# its own key=value outputs.
delim="EOF_$(openssl rand -hex 16)"
{
echo "files<<EOF"
echo "files<<$delim"
echo "$changed_changesets"
echo "EOF"
echo "$delim"
} >> "$GITHUB_OUTPUT"
else
echo "has_changesets=false" >> "$GITHUB_OUTPUT"
@@ -260,7 +281,7 @@ jobs:
- name: Setup pnpm
if: steps.changed-changesets.outputs.has_changesets == 'true'
uses: pnpm/action-setup@0977fd99725f1db4007ccb2928dbb4e90d06cc86 # v6
uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
- name: Setup Node.js
if: steps.changed-changesets.outputs.has_changesets == 'true'
+3 -3
View File
@@ -40,7 +40,7 @@ jobs:
fetch-depth: 0
token: ${{ steps.app-token.outputs.token }}
- uses: pnpm/action-setup@0977fd99725f1db4007ccb2928dbb4e90d06cc86 # v6
- uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
@@ -53,7 +53,7 @@ jobs:
# Opens/updates the Version Packages PR; publishes when the Version PR merges
- name: Create/Update Version PR
id: changesets
uses: changesets/action@8488615a623b1b9c987934bb89eae8af6a946ac1 # v2.1.1
uses: changesets/action@ae32849d5ba541f9ae29e40e22a623bc13562f51 # v2.1.2
with:
github-token: ${{ steps.app-token.outputs.token }}
pr-title: 'chore(release): version packages'
@@ -84,7 +84,7 @@ jobs:
with:
fetch-depth: 0
- uses: pnpm/action-setup@0977fd99725f1db4007ccb2928dbb4e90d06cc86 # v6
- uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
+2 -2
View File
@@ -51,7 +51,7 @@ jobs:
persist-credentials: false
- name: Setup pnpm
uses: pnpm/action-setup@0977fd99725f1db4007ccb2928dbb4e90d06cc86 # v6
uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
# No dependency cache: `pnpm audit` reads the lockfile, nothing is installed,
# so a cache-save step would fail on the missing store path.
@@ -109,7 +109,7 @@ jobs:
persist-credentials: false
- name: Setup pnpm
uses: pnpm/action-setup@0977fd99725f1db4007ccb2928dbb4e90d06cc86 # v6
uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
- name: Setup Node.js
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
+146
View File
@@ -1,5 +1,151 @@
# @fission-ai/openspec
## 1.13.2
### Patch Changes
- [#1940](https://github.com/Fission-AI/OpenSpec/pull/1940) [`0b5ce44`](https://github.com/Fission-AI/OpenSpec/commit/0b5ce44b55e0d793a312290ba5a41170a78e47c6) Thanks [@clay-good](https://github.com/clay-good)! - Keep fast-forward clarification guidance and onboarding task approval consistent across generated skills and commands. Fast-forward now asks only when context is critically unclear, while onboarding asks users to approve the task breakdown before saving it and separately asks whether to begin implementation.
- [#1926](https://github.com/Fission-AI/OpenSpec/pull/1926) [`f2812f6`](https://github.com/Fission-AI/OpenSpec/commit/f2812f6d185f47cb577055f2fe243f12000d6cd2) Thanks [@kevin9327](https://github.com/kevin9327)! - ### Bug Fixes
- **Archive** — When Windows `EPERM` blocks renaming a change directory that still has children, copy from the original source instead of requiring a staging rename that fails the same way. That lets archive finish instead of rolling back the spec write and leaving an empty capability directory git cannot see. A staging failure that is not `EPERM`/`EXDEV` still leaves the source untouched.
The source of that unstaged copy is still the live change directory, which the archive claim does not cover, so cleanup removes only the entries it copied and verified rather than whatever is present when it runs. A file written in that window is left alone and the complete destination is retained for recovery, instead of being deleted without ever reaching the archive.
An edit to a file that was already verified is covered too. Cleanup claims each entry with an atomic rename before reading it, then compares what it claimed against the copy. A rewrite that lands first is caught by that comparison and the file is put back; one that lands after creates a new file at the original path, which is never deleted. Either way the newer bytes stay on disk and archive reports the move as incomplete rather than succeeding with the older copy.
Rollback of a newly created spec now also prunes the capability directory it created — and only that one. An empty capability directory that was already there is left in place with its own permissions.
- [#1795](https://github.com/Fission-AI/OpenSpec/pull/1795) [`fb1b876`](https://github.com/Fission-AI/OpenSpec/commit/fb1b87613b7cdbe8d74e8147833904f46f0468c6) Thanks [@runsonmypc](https://github.com/runsonmypc)! - Archive workflows now use schema-aware task progress from `openspec list --json`, so custom task files and globs still trigger incomplete-task warnings.
- [#1885](https://github.com/Fission-AI/OpenSpec/pull/1885) [`fd56e12`](https://github.com/Fission-AI/OpenSpec/commit/fd56e12c9e7fdbbfdc2dcd0a5ef3fab04840909d) Thanks [@philo-x](https://github.com/philo-x)! - Fix artifact output resolution to recognize brace expansion and extglob patterns while preserving literal output filenames and confining brace-expanded paths to the change directory.
- [#1964](https://github.com/Fission-AI/OpenSpec/pull/1964) [`7ac58dc`](https://github.com/Fission-AI/OpenSpec/commit/7ac58dc7905a4eeaaad7eff2b2b64cf971fd6ec7) Thanks [@clay-good](https://github.com/clay-good)! - Continue commands now open with an instruction to follow the active OpenSpec workflow directly, so local models no longer try to call a tool named after it ([#1944](https://github.com/Fission-AI/OpenSpec/issues/1944)).
- [#1964](https://github.com/Fission-AI/OpenSpec/pull/1964) [`7ac58dc`](https://github.com/Fission-AI/OpenSpec/commit/7ac58dc7905a4eeaaad7eff2b2b64cf971fd6ec7) Thanks [@clay-good](https://github.com/clay-good)! - Generate Kilo Code commands in `.kilo/command/`, the directory Kilo Code reads, instead of `.kilocode/workflows/` ([#1938](https://github.com/Fission-AI/OpenSpec/issues/1938)). `openspec init` and legacy cleanup remove the workflow files OpenSpec generated there, matched by their known file names (including copies you edited), and leave files with other names in place.
- [#1958](https://github.com/Fission-AI/OpenSpec/pull/1958) [`1d35e90`](https://github.com/Fission-AI/OpenSpec/commit/1d35e908804dbb3c4a1851516759c5de190aa4d5) Thanks [@clay-good](https://github.com/clay-good)! - Preserve a file's existing line endings when rewriting it, so Windows users no longer get whole-file diffs. Applying a delta to a CRLF spec (the default on a Windows checkout with `core.autocrlf=true`) rewrote the file to LF, turning a one-requirement change into a diff that touched every line. `openspec archive` now writes the spec back with the convention it already used; a spec that does not exist yet is still written with LF.
The same fix covers marker-managed files: installing or updating shell completions in a CRLF `.bashrc` or `.zshrc` no longer leaves the file with mixed endings, which `bash` reports as `$'\r': command not found`.
Removing a managed block is fixed the same way: the blank-line collapse in `removeMarkerBlock` rebuilt its separator as a bare LF, so cleaning up legacy artifacts left a lone LF inside an otherwise-CRLF `CLAUDE.md` or rc file. Both write paths now read the file the same way, by dominant ending, so one stray CRLF in an otherwise-LF file no longer pulls the whole rewrite to CRLF.
`scripts/pack-version-check.mjs` now spawns `npm` through `cross-spawn`, so the release guard can run on Windows, where `npm` is `npm.cmd` and cannot be resolved by `execFile`.
- [#1912](https://github.com/Fission-AI/OpenSpec/pull/1912) [`8826c0c`](https://github.com/Fission-AI/OpenSpec/commit/8826c0c4a17d3511947b7c5e0934257f153f0ed2) Thanks [@Tyagiquamar](https://github.com/Tyagiquamar)! - Fix `validate --strict` reporting `PURPOSE_IS_PLACEHOLDER` for a Purpose that opens with the ordinary word "Todo" followed by prose, as in Spanish ("Todo el…") and Portuguese ("Todo o…") specs ([#1897](https://github.com/Fission-AI/OpenSpec/issues/1897)).
- Case now separates the marker from the word. `TBD`/`TODO` in capitals is still a placeholder marker whatever follows it, so `TODO write this later` is still reported.
- In any other case it counts as a marker only when followed by the end of the Purpose, a line break, or marker punctuation (`todo -`, `tbd.`), so an authored Spanish or Portuguese sentence is not reported.
- [#1744](https://github.com/Fission-AI/OpenSpec/pull/1744) [`5b55263`](https://github.com/Fission-AI/OpenSpec/commit/5b5526377506c2f0179674a869c1ac64ca9ab72d) Thanks [@javigomez](https://github.com/javigomez)! - Clarify the Codex setup hint for CLI, IDE, and desktop app users.
- [#1809](https://github.com/Fission-AI/OpenSpec/pull/1809) [`a5ceea3`](https://github.com/Fission-AI/OpenSpec/commit/a5ceea32cf110b6d8bbfea0bf1c65fe55abb133b) Thanks [@ryandemelo](https://github.com/ryandemelo)! - Say what a `MODIFIED` block adds when the scenario-loss guard fires ([#1809](https://github.com/Fission-AI/OpenSpec/pull/1809)). `openspec validate` and `openspec archive` already named the scenarios a block omits. They now also print how many scenarios each side has and which ones the block introduces, capped at three names, so a rename and a truncation read differently without opening either file. The guard catches exactly what it did before, and no exit code changes.
- [#1731](https://github.com/Fission-AI/OpenSpec/pull/1731) [`d6bdef6`](https://github.com/Fission-AI/OpenSpec/commit/d6bdef6577a077614382ef47b64100852182d6a6) Thanks [@runsonmypc](https://github.com/runsonmypc)! - Stop workflows from displaying schema names that `openspec list --json` does not return. Update and continue no longer fabricate a `spec-driven` picker label, while bulk archive and explore describe only the change fields the list command actually provides.
- [#1955](https://github.com/Fission-AI/OpenSpec/pull/1955) [`ed5d386`](https://github.com/Fission-AI/OpenSpec/commit/ed5d386a559c0215af1182d479d7f99b309fdcd2) Thanks [@clay-good](https://github.com/clay-good)! - Task guidance now requires each task group to land its own tests and documentation updates instead of deferring them to a trailing group. The onboarding walkthrough teaches the same rule, and the published schema reference no longer quotes stale instruction text.
- [#1939](https://github.com/Fission-AI/OpenSpec/pull/1939) [`a64303f`](https://github.com/Fission-AI/OpenSpec/commit/a64303fe1e24f08dbf44f78032fadbeac3a6f7fa) Thanks [@clay-good](https://github.com/clay-good)! - Return a nonzero exit status when `openspec update --force` cannot replace a legacy-only Codex installation.
- [#1733](https://github.com/Fission-AI/OpenSpec/pull/1733) [`72fbe4c`](https://github.com/Fission-AI/OpenSpec/commit/72fbe4c904707396151921a20b506d081a9dc024) Thanks [@runsonmypc](https://github.com/runsonmypc)! - Let `/opsx:update` fill a missing file under an already-satisfied glob artifact. A glob artifact is complete once one file matches it, and `/opsx:continue` only picks up `ready` artifacts, so the previous "point the user to `/opsx:continue`" handoff was unreachable and the missing file could never be created through the documented flow.
- [#1962](https://github.com/Fission-AI/OpenSpec/pull/1962) [`3364146`](https://github.com/Fission-AI/OpenSpec/commit/336414665f3f987ae424177ab1b6891a4304baeb) Thanks [@ryandemelo](https://github.com/ryandemelo)! - Stop `/opsx:verify` from reporting a correctly removed requirement as missing. Verify now reads which delta section each requirement sits under: ADDED and MODIFIED requirements are checked for an implementation as before, a REMOVED requirement passes once its behavior is gone and is flagged only while it is still present, and the old name of a RENAMED requirement is no longer reported as missing.
- [#1732](https://github.com/Fission-AI/OpenSpec/pull/1732) [`072de6b`](https://github.com/Fission-AI/OpenSpec/commit/072de6bc39b1c47b9aacf4d484be16345ca4f38e) Thanks [@runsonmypc](https://github.com/runsonmypc)! - Stop `/opsx:verify` from reporting skipped checks as passing. Task completion now uses the schema-aware `tasks` and `progress` fields returned by apply instructions, while absent spec or design inputs are mapped to every check they prevent. Apply instructions aggregate every file matched by the configured task path or glob, regardless of the tracked artifact ID. Verification stays advisory and does not require optional or intentionally omitted artifacts. The scorecard identifies each skipped check, and the final assessment does not claim archive readiness when any check did not run.
- [#1769](https://github.com/Fission-AI/OpenSpec/pull/1769) [`d3d7707`](https://github.com/Fission-AI/OpenSpec/commit/d3d770736fc01bb246b4f12a7cef7e3572ec1fb6) Thanks [@kikeprzn](https://github.com/kikeprzn)! - Fix `openspec archive` leaving `.openspec-archive.lock` behind on Windows. Node can report `dev: 0n` from a path stat while the open file handle reports the real volume id, so the claim-ownership check never matched and the stale lock blocked every later archive. The check now treats an absent device id as unavailable while still requiring the inode and the claim's contents to match before unlinking.
## 1.13.1
### Patch Changes
- [#1864](https://github.com/Fission-AI/OpenSpec/pull/1864) [`767d63c`](https://github.com/Fission-AI/OpenSpec/commit/767d63c926ab1996170f2d101acac0bac6da0287) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Stop archive adding a second copy of an existing requirement under a name that differs only in case or spacing. ADDED and the RENAMED target compared requirement names exactly, while REMOVED and the RENAMED source already treated a case or whitespace variant as a mistyped header, so an ADDED `late fees` beside an existing `Late Fees`, or a rename to `LATE FEES`, archived cleanly and left two contradicting requirements in the main spec, which `validate` then accepted. Both now refuse with an error naming the existing requirement, in the same form REMOVED already used. The exact-duplicate error is unchanged, a case-only rename of a requirement to its own name still works, and a variant of a requirement the same delta removes or renames away is still allowed, because ADDED is checked against the spec as it stands after the earlier operations, as the exact check already was.
- [#1872](https://github.com/Fission-AI/OpenSpec/pull/1872) [`72bf760`](https://github.com/Fission-AI/OpenSpec/commit/72bf7600a5f7bdf74d6387e163577086fb4c68e0) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Make `openspec completion uninstall bash` hand `.bashrc` back exactly as `completion install bash` found it. Install adds the OpenSpec block at the top of the file followed by a blank separator line; uninstall removed the block but kept that blank line at the top, then stripped every trailing blank line and wrote the file back without its final newline. The byte count happened to come out unchanged, but the next tool to append to `.bashrc` with `>>` (the nvm, conda and rustup installers all do) merged its first line into the user's last line and broke both. Uninstall now also drops the separator line install added when the block sits at the top of the file, and leaves the rest untouched: the final newline, trailing blank lines and CRLF line endings all survive the round trip. A block the user moved elsewhere in the file is still removed, and the zsh, fish and PowerShell installers are unchanged.
- [#1829](https://github.com/Fission-AI/OpenSpec/pull/1829) [`e67ac47`](https://github.com/Fission-AI/OpenSpec/commit/e67ac47f3a164cf6d87ddcd9f50272b88f39ee0c) Thanks [@choi138](https://github.com/choi138)! - Fix bulk archive nesting a change inside an existing archive target. The workflow now checks every archive target before it writes any main spec, the same order `openspec archive` uses. A change whose target already exists, or that shares a target with another selected change, is reported as failed and is never synced or moved, while the rest of the batch continues. The check runs again just before each move.
- [#1878](https://github.com/Fission-AI/OpenSpec/pull/1878) [`2ef6fbd`](https://github.com/Fission-AI/OpenSpec/commit/2ef6fbde3da95f6e471bcb504d13711308091be0) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Let `openspec config edit` run an `EDITOR` or `VISUAL` that carries arguments. The whole value was passed to `spawn` as the program name, so common settings such as `code --wait`, `subl -w` or `emacsclient -t` failed with `spawn code --wait ENOENT`, and because that error was never caught the command died with a raw Node stack trace. The value is now split into a program and its arguments, honoring quoted paths with spaces, and the config path is appended as its own argument. No shell is involved, so shell metacharacters in the value are passed through literally. On Windows, `.cmd` shims such as `code.cmd` are found. A value that is itself the absolute path of an existing file is still run as-is, so an unquoted editor path containing spaces keeps working. An editor that cannot be started, exits non-zero or is killed is now reported as a one-line error naming the editor, with an install hint when the program was not found, and the command exits 1 instead of throwing. `EDITOR` still takes precedence over `VISUAL`, and the file is still validated after the editor closes.
- [#1773](https://github.com/Fission-AI/OpenSpec/pull/1773) [`11a9691`](https://github.com/Fission-AI/OpenSpec/commit/11a9691524bad84a575854bf6dc5124f630479ba) Thanks [@clay-good](https://github.com/clay-good)! - Stop dropping checkbox lines whose marker the task parser does not recognise. A `tasks.md` whose remaining work used a marker other than `[ ]`/`[x]`/`[X]`, for example `- [~] 1.2 Deferred`, reported `✓ Complete` in `openspec list`/`status` and archived with no incomplete-task warning, because unmatched lines counted toward neither the numerator nor the denominator. An empty `[]` and a padded `[ x]` were lost the same way. Only a box holding `x` or `X` means done (spacing inside the brackets is ignored, so `[ x]` is done), and every other marker now reads as unfinished, across progress, the apply task list, archive's gate and validate's task-numbering check. The archive, bulk-archive and verify workflows now tell agents the same rule, so a hand-counted tally cannot disagree with the CLI, and the `tasks` instruction in the `spec-driven` schema states it where agents author the file. Markdown link bullets stay out of the count: `- [Some doc](./doc.md)` and the one-character `- [A](https://example.com)` are not tasks.
- [#1701](https://github.com/Fission-AI/OpenSpec/pull/1701) [`92fb72d`](https://github.com/Fission-AI/OpenSpec/commit/92fb72d1dcd5fa6e43802c5b2f74b5e78416e545) Thanks [@clay-good](https://github.com/clay-good)! - Agent-driven archive and sync workflows now create a missing main spec from `ADDED` requirements instead of treating it as already synced. They block sync rather than inventing `MODIFIED` or `RENAMED` requirements or writing an empty spec for a `REMOVED`-only delta, while preserving the user's explicit choice to archive without syncing. A REMOVED-only delta with `retire_capabilities: true` remains already synced when its main spec is gone. Fixes [#1222](https://github.com/Fission-AI/OpenSpec/issues/1222) and [#1264](https://github.com/Fission-AI/OpenSpec/issues/1264).
- [#1804](https://github.com/Fission-AI/OpenSpec/pull/1804) [`a5bf5c6`](https://github.com/Fission-AI/OpenSpec/commit/a5bf5c68447f03e4f99206e49e00b5d9111301a4) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Say so when a requirement in a delta sits outside every delta section. A well-formed `### Requirement:` block written under `## Notes`, under a misspelled header such as `## Add Requirements`, or above the first `## ` header was dropped with no diagnostic: `openspec validate` reported the change valid and `openspec archive` exited 0 without applying it. `openspec validate` now reports each one as a WARNING naming the section and line, and archive prints the same warning. Nothing else changes: the block is still not applied, the verdict stays valid outside `--strict`, and requirements shown inside a code fence are not reported. Fixes [#1803](https://github.com/Fission-AI/OpenSpec/issues/1803).
- [#1832](https://github.com/Fission-AI/OpenSpec/pull/1832) [`4c369e0`](https://github.com/Fission-AI/OpenSpec/commit/4c369e022b1d397842d2b85675e34da6287f5801) Thanks [@clay-good](https://github.com/clay-good)! - Resolve the contradiction that left explore mode's capture branch without a governing rule. Explore states twice that the agent must ask a direct yes/no question and wait for confirmation in a separate user message before its first write-capable action, naming `openspec new change` as an example, while the capture branch tells the agent to transition "seamlessly" into running `openspec new change` and creating artifacts with no confirmation step. Both readings were defensible from the text, so the same "capture this as a change" request either wrote `.openspec.yaml` plus several artifacts immediately or stopped and asked, depending on which passage the agent weighed, which made the [#1715](https://github.com/Fission-AI/OpenSpec/issues/1715) guarantee unenforceable in the one explore path that writes files. An explicit capture request is now stated to be that confirmation, covering the change and the artifacts the request names and nothing else. The guardrail keeps its teeth for the case [#1715](https://github.com/Fission-AI/OpenSpec/issues/1715) actually reported: when the agent is the one proposing the capture, or when the work would go beyond the requested scope, it still asks first, and answers to design or clarifying questions are still never consent to write. Both explore delivery surfaces and the committed skill carry the same wording. Fixes [#1828](https://github.com/Fission-AI/OpenSpec/issues/1828).
- [#1788](https://github.com/Fission-AI/OpenSpec/pull/1788) [`62106f4`](https://github.com/Fission-AI/OpenSpec/commit/62106f40e3b7b7364529a2f928717e23e37282eb) Thanks [@clay-good](https://github.com/clay-good)! - Name the workflow where explore hands off. Explore mode refuses to implement, but every place it said what to do instead described the next step as prose ("create a change proposal") without naming the workflow that does it: the refusal itself, the "flow into a proposal" ending, the closing summary, and the do-not-implement guardrail. Its seamless capture path was worse: it scaffolded a change, wrote artifacts, and then said nothing at all about what came next. With no named exit, agents finished the discovery questions and started writing code, which is the failure reported through GitHub Copilot in [#869](https://github.com/Fission-AI/OpenSpec/issues/869), and which the docs already promised would not happen ("when the picture is clear, it hands off to `/opsx:propose`").
The explore skill and command now name `/opsx:propose` at all four prose handoffs, and the capture path ends by naming `/opsx:propose` for the remaining planning artifacts and `/opsx:apply` for implementation, with an explicit note that capturing artifacts is not permission to implement them. The references are written in the canonical `/opsx:<id>` form so each tool renders the invocation it actually registers (`/openspec-propose` for skills-only delivery, `/opsx-propose`, `/opsx:propose`, or `@opsx-propose` for command surfaces). The handoffs follow the installed workflow set: a custom profile without `propose` or `apply` gets explore's own capture path and the `openspec instructions apply` CLI instead of a command it never installed. Fixes [#869](https://github.com/Fission-AI/OpenSpec/issues/869).
- [#1787](https://github.com/Fission-AI/OpenSpec/pull/1787) [`9827762`](https://github.com/Fission-AI/OpenSpec/commit/9827762d2d18d8076acf90be79d64894255099ea) Thanks [@clay-good](https://github.com/clay-good)! - ### Bug Fixes
- Generated skills and commands no longer adopt a project that never ran `openspec init`. Every workflow now checks `root` from `openspec list --json` before its first write, and `"root": null` means the project is not set up. What happens next depends on how the workflow was reached. A skill the agent picked on its own drops OpenSpec and answers the request normally, without asking about setup. A workflow the user asked for by name, or ran as a slash command, stops and asks whether to initialize the project, target a store, or handle the request without OpenSpec. A project whose `openspec/config.yaml` names a store this machine cannot resolve (not registered, or a malformed `store:` line) is not mistaken for an uninitialized one: the workflow stops and shows the store error. Neither path lets `openspec new change` create `openspec/` in the current directory as a side effect. Skill descriptions now name OpenSpec so hosts stop offering these workflows in unrelated repositories. `openspec new change` also says when it had to create the root itself, so a directory that was never set up no longer picks up an `openspec/` directory in silence (human output only; `--json` is unchanged).
- [#1902](https://github.com/Fission-AI/OpenSpec/pull/1902) [`eb03b9e`](https://github.com/Fission-AI/OpenSpec/commit/eb03b9e93320cf74a0df9043577d8023116cb1aa) Thanks [@clay-good](https://github.com/clay-good)! - Harden the CLI against repositories you have cloned but not yet read ([#1835](https://github.com/Fission-AI/OpenSpec/pull/1835)).
- A `config.yaml` value can no longer close the project context block and inject its own directives into the instructions an agent receives.
- A crafted delta or skill file no longer stalls `openspec update` or `openspec archive` with catastrophic regex backtracking.
- A repository's `.npmrc` can no longer point the update check at a cleartext or attacker-controlled registry; a rejected registry now disables the check instead of falling back.
- `openspec update` now notices a generated `SKILL.md` that was edited by hand and restores it, instead of reporting every tool as up to date.
- `DO_NOT_TRACK=true` and other common spellings of an opt-out now turn telemetry off, and nothing is sent until the first-run notice has been shown.
- Shell-completion installs quote directory paths safely, git probes run with bounded time and output, and dependencies are cleared of known advisories.
- [#1874](https://github.com/Fission-AI/OpenSpec/pull/1874) [`388d344`](https://github.com/Fission-AI/OpenSpec/commit/388d34473a40529320b2b7b9c5bb6723d18322b0) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Stop legacy cleanup deleting the user's own files. The six pre-skills tools that kept their commands in a `<tool>/commands/openspec/` folder (Claude Code, CodeBuddy, Qoder, Lingma, Crush and Gemini CLI) had that whole folder removed recursively whenever it existed, so a command the user kept there, such as a team review checklist, was deleted along with OpenSpec's files, and the summary named only the folder. Because `openspec init` cleans up automatically when there is no TTY, an agent or CI running plain `openspec init` did this without `--force` and without a prompt, and `openspec update --force` did the same. Cleanup now deletes only the files OpenSpec wrote there: `proposal`, `apply` and `archive` files that still carry the OpenSpec markers every legacy command was generated with, so a same-named file the user wrote is kept. It never follows a symlinked command folder, removes the folder only once nothing else is left in it, and lists each thing it kept. A folder holding nothing OpenSpec wrote is no longer reported as legacy at all. A folder holding only OpenSpec's files, or nothing, is still removed exactly as before, with the same summary line.
- [#1866](https://github.com/Fission-AI/OpenSpec/pull/1866) [`8146be5`](https://github.com/Fission-AI/OpenSpec/commit/8146be5546918cdffce860f1e327d929c5a49bd3) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Stop one unresolvable file from breaking `openspec list`. To sort changes by recency, `list` stats every file inside each change, and any entry it could not stat failed the whole command: a dangling symlink, such as the `.#tasks.md` lock Emacs keeps beside every file with unsaved edits, or a symlink loop made `list` exit 1 and `list --json` report `"changes": []`, so agents discovering work through it saw no changes at all. An entry that no longer resolves (removed mid-walk, a dangling symlink, or a loop) is now skipped when computing a change's last-modified time. Valid symlinks are dated as before, and any other error, such as a permission failure, still fails the listing.
- [#1849](https://github.com/Fission-AI/OpenSpec/pull/1849) [`09a999b`](https://github.com/Fission-AI/OpenSpec/commit/09a999bbb258c2ad6d7cdc33436c698c15d4eebe) Thanks [@clay-good](https://github.com/clay-good)! - Report a change directory nested in a namespace folder instead of silently listing the folder around it as a change. Specs can be nested by domain (`specs/mobile/tutorial-videos/spec.md`), so it looks reasonable to lay changes out the same way, but a change is only ever a directory directly under `changes/`: `changes/mobile/refresh-token/` left the real change invisible while `mobile` was reported as a task-less change everywhere. `openspec archive mobile` then moved the unfinished change into the archive under the namespace's name and applied none of its deltas. `openspec list` now marks the folder `not a change` and names the nested directories and a flat alternative, `openspec show`, `openspec status --change` and `openspec status --all` say the same instead of reporting a missing proposal or a full artifact plan, `openspec validate` reports it instead of "must have at least one delta", `openspec list --json` carries a `warnings` entry, and `openspec archive` refuses the folder outright. Detection looks up to three directory levels below `changes/`, which covers every namespace layout seen in practice; a change buried deeper than that behaves as it did before. Fixes [#1846](https://github.com/Fission-AI/OpenSpec/issues/1846).
- [#1902](https://github.com/Fission-AI/OpenSpec/pull/1902) [`eb03b9e`](https://github.com/Fission-AI/OpenSpec/commit/eb03b9e93320cf74a0df9043577d8023116cb1aa) Thanks [@clay-good](https://github.com/clay-good)! - Install shell completions with the Nix flake package ([#1785](https://github.com/Fission-AI/OpenSpec/pull/1785)). The package now ships bash, zsh and fish completions in their standard `share/` locations, so Nix users get tab completion without running `openspec completion install` against their home directory.
- [#1775](https://github.com/Fission-AI/OpenSpec/pull/1775) [`626269e`](https://github.com/Fission-AI/OpenSpec/commit/626269ed732250492d8bd220a83df23dd756ee5d) Thanks [@clay-good](https://github.com/clay-good)! - Generated skills and commands no longer point at workflows the active profile does not install. On the default `core` profile, the update workflow told agents to hand off to `/opsx:continue` for missing artifacts and to `/opsx:new` for a change of intent, neither of which `core` generates. Every cross-workflow handoff is now decided at generation time against the installed workflow set, and renders a concrete CLI fallback (`openspec status`, `openspec instructions`, `openspec archive`) when the workflow it would name is absent, rather than relying on a runtime availability check the agent had to perform. The onboarding tutorial's command tables are likewise built from the workflows you actually have.
Also folds in [#1735](https://github.com/Fission-AI/OpenSpec/issues/1735), which fixed the same issue ([#1734](https://github.com/Fission-AI/OpenSpec/issues/1734)) by removing the optional handoffs outright. The CLI's own runtime instructions no longer name the `openspec-continue-change` skill either, since those strings are chosen at run time and cannot be resolved against a profile; and the blocked-state fallback now carries the full CLI recovery (select the next `ready` artifact from `openspec status`, read its rules with `openspec instructions`, keep the selected `--store`) rather than a one-line pointer.
- [#1870](https://github.com/Fission-AI/OpenSpec/pull/1870) [`e01ed07`](https://github.com/Fission-AI/OpenSpec/commit/e01ed070f18e15529f82563d4c5af35d8124bad3) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Stop archiving a change whose delta was written somewhere `archive` never reads. `validate` and `archive` read a change's deltas only from `specs/<capability-path>/spec.md`, but the spec-driven artifact graph counts any markdown file under `specs/` as the specs being written, so a delta at `specs/user-auth.md`, or in a second file beside a capability's `spec.md`, was reported done by `status` and ready by `instructions apply` with no warning, rejected by `validate` only as "no deltas found", and then archived with exit 0 and nothing merged into `openspec/specs/`. A markdown file that carries delta sections but is not a capability's `spec.md` is now a validation error naming the file and the `spec.md` its requirements belong in; `archive` runs that validation and refuses the change instead of archiving it unmerged, and `instructions apply` lists each such file in its `warnings`. `--no-validate` still archives as before, a change with no spec files still archives, and notes without delta sections under `specs/` are not affected.
- [#1806](https://github.com/Fission-AI/OpenSpec/pull/1806) [`6e62b1d`](https://github.com/Fission-AI/OpenSpec/commit/6e62b1d522cfadb4b9836b63d5afa127bc950743) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Refuse a `## RENAMED Requirements` section whose `FROM:` and `TO:` lines do not pair up, instead of guessing. The reader kept one pending pair and dropped whatever did not fit: a `TO:` before its `FROM:`, a `FROM:` displaced by a second `FROM:`, or a trailing `FROM:` vanished with no diagnostic. Listing the old names and then the new ones paired the second `FROM:` with the first `TO:`, so `openspec archive` renamed a requirement the delta never named, under a name written for a different one, and exited 0. `openspec validate` now reports each unpaired line as an ERROR with its line number, and archive refuses the change until the pairing is fixed. Well-formed renames, including several consecutive pairs, are unchanged. A change that used to archive with a malformed RENAMED section is now rejected. Fixes [#1805](https://github.com/Fission-AI/OpenSpec/issues/1805).
- [#1860](https://github.com/Fission-AI/OpenSpec/pull/1860) [`4b5c07a`](https://github.com/Fission-AI/OpenSpec/commit/4b5c07a0c2e5a4a1dcb3ed9f3a040f826eb7d457) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Read a requirement heading written with a CommonMark closing sequence, such as `### Requirement: Late Fees ###`, as the requirement it renders as. The trailing `#` run stayed in the name, so a REMOVED written that way looked for "Late Fees ###", missed the requirement, and archive exited 0 with a false "treating it as already removed" warning while the requirement stayed in the spec; a closed MODIFIED or RENAMED heading failed as "not found", and a closed and an open heading of one requirement were not reported as duplicates. Requirement names now drop the closing run wherever they are read, exactly as scenario names already did: only a run preceded by a space or tab counts, so a name such as `C#` keeps its `#`. Headings without a closing run are unaffected.
- [#1868](https://github.com/Fission-AI/OpenSpec/pull/1868) [`7090e16`](https://github.com/Fission-AI/OpenSpec/commit/7090e16d74dfe588dad72bc4fda9bf124e71b0af) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Reject a schema whose `apply.requires` names an artifact that does not exist. `parseSchema` checked every artifact's `requires` but never `apply.requires`, so `openspec schema validate` passed a one-character typo there, and apply then skipped the unknown id: `apply.requires: [desgin]` turned the apply gate off and told the agent "Proceed with implementation" with only a proposal written. That is now a schema error, raised wherever the schema is loaded, exactly like an unknown artifact `requires`, and it names the bad id and the artifacts the schema declares. `openspec schema validate` also warns, without failing, when `apply.tracks` isn't exactly equal to some artifact's `generates` value, because OpenSpec finds the tracked artifact by comparing those two strings and can otherwise not tell which artifact's progress the file belongs to. That covers a typo such as `task.md` and also `tracks: tasks/main.md` against `generates: tasks/*.md`, where the glob does produce the file but the strings still differ. Apply reads that path as written either way, so schemas that track a hand-written file keep loading and working. Every built-in schema parses as before.
- [#1856](https://github.com/Fission-AI/OpenSpec/pull/1856) [`46ff91f`](https://github.com/Fission-AI/OpenSpec/commit/46ff91f2d626ef2c3f9f55ff345aa23cd44a6e95) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Make `openspec show --json --deltas-only` report the deltas archive applies. `ChangeParser`, which backs `show --json`, the `change list` delta counts and archive's proposal warnings, read delta specs with its own section lookup instead of `parseDeltaSpec`, the reader archive uses, and the two disagreed. A REMOVED written in the bullet form (`` - `### Requirement: X` ``) was invisible to it, so it fell back to the proposal's "What Changes" prose and reported an invented MODIFIED while archive deleted the requirement; a repeated section header was read only once; and a RENAMED line written with `*` or `+` was dropped. The inspection command OpenSpec's own error text recommends therefore misreported a deletion. `ChangeParser` now derives every operation from `parseDeltaSpec`, and a change whose delta spec files carry a delta section is described by them alone, so proposal prose is never reported in place of what archive applies. Requirement text and scenarios are read exactly as before, header-form deltas produce the same output, and a change with no delta spec files, or a legacy change whose spec files carry no delta section, still falls back to the "What Changes" bullets.
- [#1786](https://github.com/Fission-AI/OpenSpec/pull/1786) [`8b99c07`](https://github.com/Fission-AI/OpenSpec/commit/8b99c07bd0d455f72e746d3950f03e52a025d655) Thanks [@clay-good](https://github.com/clay-good)! - `openspec status` now names the command that moves the change forward.
The text output reported state and stopped there, so picking a change back up (after a lost session, or on a change you did not start) meant already knowing which command came next. The JSON surface had carried that command all along in `nextSteps`; the text surface never printed it.
Status now ends with a `Next:` line: the next ready artifact's `openspec instructions` command while planning is unfinished, and `openspec instructions apply` once every planning artifact exists. It carries `--store <id>` when the resolved root is a store, and it is built from the same source as the JSON `nextSteps` sentence, so the two surfaces cannot name different commands.
- [#1882](https://github.com/Fission-AI/OpenSpec/pull/1882) [`208b5b5`](https://github.com/Fission-AI/OpenSpec/commit/208b5b55106fbeda2ed9f099671b8ce85a01cbaa) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Stop a store named `specs` or `changes` from taking over root selection. Stores are placed at `~/openspec/<id>`, so a store with one of those ids is itself `~/openspec/specs` or `~/openspec/changes`, and that made `$HOME` look like a planning root. Every command run anywhere under the home directory then resolved `$HOME` as the nearest root: the global `defaultStore` was never consulted, and `new change` wrote into `~/openspec/changes`, outside any store. A `specs/` or `changes/` directory that carries store metadata no longer counts as planning content of the directory above it, so these stores resolve like any other. A real project's `openspec/specs/` and `openspec/changes/` are unaffected.
- [#1880](https://github.com/Fission-AI/OpenSpec/pull/1880) [`9f8dec5`](https://github.com/Fission-AI/OpenSpec/commit/9f8dec5dd937da78bbdaeff5e5dfd041bb43cf5c) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Stop `openspec store remove` deleting a store the user did not name. Remove deletes the target's folder recursively, but it checked only the target's own metadata, so any other registered store living inside that folder was deleted with it, uncommitted planning work included, while its registry entry was left pointing at a path that no longer existed. The natural way to get there is a shared store vendored into another as a git submodule, a layout `store register` accepts. Remove now refuses when another registration points inside the folder, checked under the same registry lock that commits the removal, and the error names each nested store with the `openspec store unregister` command to run first. Removing a store whose other registrations are siblings is unchanged, and `store register` still accepts nested checkouts.
- [#1884](https://github.com/Fission-AI/OpenSpec/pull/1884) [`5d22145`](https://github.com/Fission-AI/OpenSpec/commit/5d221456e57feb9277de40482fade427201b9bdb) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Let `openspec store setup --no-init-git` create a store inside an existing Git repository. Setup refuses a path inside another repository because initializing the store there would nest one repository in another, but it ran that check even with `--no-init-git`, which creates no repository at all. Users who keep their home directory as a dotfiles repository therefore could not set up a store at the recommended `~/openspec/<id>` path with any flag. With `--no-init-git` the check is now skipped, and the store never records the enclosing repository's remote. The default setup and an explicit `--init-git` still refuse a path inside another repository.
- [#1862](https://github.com/Fission-AI/OpenSpec/pull/1862) [`8fc65b7`](https://github.com/Fission-AI/OpenSpec/commit/8fc65b7f70c4bd730a1dbe500cbe165d156f3c58) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Count task checkboxes under every CommonMark list marker. The task counter shared by `list`, `status`, `view`, `instructions apply`, `validate --archived` and archive's incomplete-task check recognized only `-` and `*` bullets, so a task written as an ordered item (`1. [ ]`, `1) [ ]`) or under a `+` bullet was invisible to all of them: a change with unfinished ordered tasks reported "✓ Complete", and `openspec archive` archived it without its incomplete-task warning. Task lines under `+` and ordered markers (`.` or `)`, up to nine digits, as CommonMark allows) now count exactly like `-` and `*` ones, including nested sub-tasks, CRLF files and the existing tolerance of a missing space after the marker, and task-numbering checks now see them too. Ordered and `+` items without a checkbox are still ignored, and `-` and `*` tasks count as before.
- [#1777](https://github.com/Fission-AI/OpenSpec/pull/1777) [`3312af4`](https://github.com/Fission-AI/OpenSpec/commit/3312af4799eb162d3ddb7804d643ace5282c22cb) Thanks [@clay-good](https://github.com/clay-good)! - Start generated proposal, spec, design, and tasks files with a top-level heading, so artifacts are complete markdown documents instead of files whose first line is a section header. Editors that run markdownlint no longer flag every OpenSpec artifact with MD041. `openspec schema init` scaffolds custom templates the same way.
`openspec show --json` and `openspec change list --json` keep naming a change by its id when its proposal opens with the template's bare `# Proposal` title.
- [#1778](https://github.com/Fission-AI/OpenSpec/pull/1778) [`7de2404`](https://github.com/Fission-AI/OpenSpec/commit/7de24044ef4c635f634b78fa6bc4b5905967bfd8) Thanks [@clay-good](https://github.com/clay-good)! - Make the vendor-neutral tool target findable when your assistant is not on the list. `openspec init` now shows it as "Other / Universal (shared .agents skills)"; the picker's search box matches it on `universal`, `other`, `generic`, `custom`, `proprietary`, `unlisted`, `unsupported`, `vendor-neutral` and `agents.md`; a search that matches nothing points at it instead of ending at "No matches"; and `--tools <unknown>` names it in the error. The search box also accepts punctuation, so `.agents` and `amazon-q` filter instead of silently dropping their `.` and `-`.
- [#1876](https://github.com/Fission-AI/OpenSpec/pull/1876) [`605d9e7`](https://github.com/Fission-AI/OpenSpec/commit/605d9e7a2bb5c1bab90268933f9b84ff1eb8807c) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Stop OpenSpec rewriting a global config file it cannot parse. After a hand edit left a typo such as a trailing comma in `config.json`, the next command of any kind, including read-only ones like `openspec list`, read the fallback defaults as telemetry consent, minted a new anonymous ID and wrote it back, replacing the whole file: a `telemetry.enabled false` opt-out, the chosen profile and the workflow list were all lost, and usage events were sent. A config file that exists but does not hold a JSON object, whether it failed to parse or its root is something else such as `null`, an array or a string, is now never written implicitly, and telemetry and the update check treat it as opted out. `config set`, `config unset` and `config profile` refuse with an error that names the file and points to `openspec config edit`, and `openspec config reset --all` still replaces it. The existing "Invalid JSON" warning is unchanged, and valid or missing config files behave exactly as before.
- [#1840](https://github.com/Fission-AI/OpenSpec/pull/1840) [`fede536`](https://github.com/Fission-AI/OpenSpec/commit/fede536c27e03c1aaa3c17caffa837f483d9e9b9) Thanks [@clay-good](https://github.com/clay-good)! - Resolve the contradiction that left `/opsx:update`'s only write path without a governing rule. Step 4 told the agent to "Apply the requested edit", while step 5 and the guardrails told it to write only after the user confirms each revision, so the same `/opsx:update "the design now uses X"` either wrote immediately or stopped and showed the proposed revision first, depending on which passage the agent weighed. Step 4 now drafts the edit in the conversation and step 5 owns every artifact write, matching the workflow's own specified behavior: propose each revision and apply it only after user confirmation. Fixes [#1836](https://github.com/Fission-AI/OpenSpec/issues/1836).
- [#1858](https://github.com/Fission-AI/OpenSpec/pull/1858) [`db560ae`](https://github.com/Fission-AI/OpenSpec/commit/db560ae33f565b76ebbc040782ec7007295e8133) Thanks [@dwin-gharibi](https://github.com/dwin-gharibi)! - Stop `validate` accepting a requirement whose only scenario is a bare header. The delta scenario counter counted every `####` header, while the spec path that archive uses to validate the rebuilt spec keeps a scenario only when its body has content, so `validate` called such a change valid and `archive` then refused it with a generic "Requirement must have at least one scenario" that did not name the requirement. Both paths now share one rule, `hasScenarioBody`, and read a scenario's body up to the same boundary, so `validate` rejects exactly what archive rejects, naming the requirement and saying that a header with no body under it does not count. A scenario whose body is only a fenced block or a deeper header still counts, a requirement with one real scenario is still accepted even when another is empty, and main-spec validation is unchanged.
- [#1774](https://github.com/Fission-AI/OpenSpec/pull/1774) [`09984b8`](https://github.com/Fission-AI/OpenSpec/commit/09984b824254f9e35bcdf628fdb052a689a57f37) Thanks [@clay-good](https://github.com/clay-good)! - ### Bug Fixes
- **Task lists without checkboxes are now caught**: a `tasks.md` written as plain bullets or a numbered list counts as zero tasks, so `openspec list` and `openspec status` reported "No tasks" and `openspec archive` had no unfinished work to warn about. `openspec validate` now warns when a change's tracked task files contain list items but no checkbox at all, and points at the first offending line.
- [#1852](https://github.com/Fission-AI/OpenSpec/pull/1852) [`5f5914e`](https://github.com/Fission-AI/OpenSpec/commit/5f5914e7f7a817262c7564ac92694db833564978) Thanks [@clay-good](https://github.com/clay-good)! - Match the natural "openspec <verb>" phrasing to the workflow it names. Users and agents say "openspec propose" or "do an openspec apply", but no workflow skill's description contained that phrasing (and a skill's description is what an agent matches on), so the phrase read as an invitation to hand-build the artifacts with the CLI instead of running the workflow. Every workflow skill's description now names the phrasings a user actually types ("openspec propose", "opsx apply", and so on). Run `openspec update` to pick it up. `openspec update` itself is deliberately left unclaimed: it is a real CLI command that refreshes generated files, unrelated to the update-change workflow, which claims "openspec update change" instead. Commands-only installs write no skills and are unchanged. Fixes [#1221](https://github.com/Fission-AI/OpenSpec/issues/1221).
## 1.13.0
### Minor Changes
+16 -4
View File
@@ -122,7 +122,7 @@ Solo, OpenSpec keeps you and your AI honest on a single repo. On a team, the har
## Quick Start
**Requires Node.js 20.19.0 or higher.**
**Requires Node.js 20.19.0 or higher.** Homebrew installs it as a dependency.
Install OpenSpec globally:
@@ -130,6 +130,12 @@ Install OpenSpec globally:
npm install -g @fission-ai/openspec@latest
```
Or install the official [Homebrew formula](https://formulae.brew.sh/formula/openspec) on macOS or Linux:
```bash
brew install openspec
```
Then navigate to your project directory and initialize:
```bash
@@ -137,11 +143,11 @@ cd your-project
openspec init
```
> **Want your AI to do it?** Paste the [setup prompt](docs/installation.md#install-with-your-ai-assistant) into your coding assistant — it installs the CLI, runs `openspec init`, and verifies the result.
> **Want your AI to do it?** Paste the [setup prompt](docs-lab/start/installation.md#install-with-your-ai-assistant) into your coding assistant — it installs the CLI, runs `openspec init`, and verifies the result.
Now talk to your AI:
- **Not sure what to build yet?** Start with `/opsx:explore`, a no-stakes thinking partner that reads your code, weighs options, and shapes a plan before anything is written. ([Explore guide](docs/explore.md))
- **Not sure what to build yet?** Start with `/opsx:explore`, a no-stakes thinking partner that reads your code, weighs options, and shapes a plan before any code gets written. ([Explore guide](docs/explore.md))
- **Already know what you want?** Go straight to `/opsx:propose <what-you-want-to-build>`.
Both are in the default profile. If you want the expanded workflow (`/opsx:new`, `/opsx:continue`, `/opsx:ff`, `/opsx:verify`, `/opsx:bulk-archive`, `/opsx:onboard`), select it with `openspec config profile` and apply with `openspec update`.
@@ -151,7 +157,7 @@ Both are in the default profile. If you want the expanded workflow (`/opsx:new`,
> [!NOTE]
> Not sure if your tool is supported? [View the full list](docs/supported-tools.md) – we support 30+ tools and growing.
>
> Also works with pnpm, yarn, bun, and nix. [See installation options](docs/installation.md).
> Also works with Homebrew, pnpm, yarn, bun, and Nix. [See installation options](docs-lab/start/installation.md).
## Docs
@@ -208,6 +214,12 @@ AI coding assistants are powerful but unpredictable when requirements live only
npm install -g @fission-ai/openspec@latest
```
If you installed OpenSpec with Homebrew:
```bash
brew upgrade openspec
```
**Refresh agent instructions**
Run this inside each project to regenerate AI guidance and ensure the latest slash commands are active:
+1 -1
View File
@@ -96,7 +96,7 @@ the page or rewriting the goal in both places, never letting them drift.
| [Overview](start/overview.md) | _TODO: emptied 2026-08-21 for a from-scratch rewrite and pulled from the site (`/docs` redirects to Installation meanwhile); the old goal line was dropped as too weak a pitch. Brief in Notes.md._ |
| [Installation](start/installation.md) | Install the `openspec` CLI on your machine, update it, and uninstall it. |
| [Set up your project](start/setup.md) | Add OpenSpec to a project: run init, see what it wrote, and adjust it. |
| [Quickstart](start/quickstart.md) | Your first change on your existing repo, from idea to archived. |
| [Quickstart](start/quickstart.md) | Your first change in a new or existing project, from idea to archived. |
### Guides: understand the system, use it well, bring it to your codebase and team
-2
View File
@@ -58,8 +58,6 @@ For example, with a `context` field and the rule from the top of this page, here
Your config arrives first, then OpenSpec's built-in instruction and template. Rules add to the built-ins and never replace them. Edits to config.yaml reach the agent on the next run.
[Workflow runs](../reference/architecture/workflow-runs.md) covers the full run, from invocation to written artifacts.
## The fields
Three fields shape what the agent receives. Each field's exact contract (types, limits, validation) is in [Project configuration (config.yaml)](../reference/configuration/config-yaml.md).
+1 -1
View File
@@ -125,7 +125,7 @@ The scaffold is bare. Artifacts come from the built-in four ids only, and the ge
A fork has two kinds of files to edit:
- **templates/** change the skeleton of each document. Add a section to the tasks template and every new tasks.md starts with it.
- **templates/** change the skeleton of each document. Add a section to the tasks template and every new tasks.md starts with it. Keep the `#` title on the first line: the artifact inherits it, so every generated file opens as a titled document.
- **schema.yaml** changes the workflow itself: which artifacts exist, what each one requires first, and the instruction the agent gets when creating it.
For example, to drop the design document for a leaner flow:
+3 -2
View File
@@ -17,7 +17,8 @@ once the prose lands. -->
If it has a row in the [support matrix](../reference/supported-tools.md), yes.
Pick its id at init. If it isn't listed but reads the shared `.agents/skills/`
folder, pick **Shared `.agents` skills** (`--tools agents`). If neither, request
it in the [OpenSpec repo](https://github.com/Fission-AI/OpenSpec/issues).
folder, pick **Other / Universal** (`--tools agents`), covered by the support
matrix's Other / Universal section. If neither, request it in the
[OpenSpec repo](https://github.com/Fission-AI/OpenSpec/issues).
## Where did the old /openspec:* commands go?
+83 -5
View File
@@ -302,6 +302,15 @@ Pass --allow-unknown to bypass this check.
Error: Invalid configuration - delivery: Invalid option: expected one of "both"|"skills"|"commands"
```
If the config file exists but does not hold a JSON object, whether because it is not valid JSON at all or because its root is something else such as `null` or an array, `config set`, `config unset` and `config profile` exit 1 and leave the file unchanged. Fix it with `openspec config edit`, or replace it with `openspec config reset --all`:
```
Error: /home/you/.config/openspec/config.json could not be parsed, so it was left unchanged.
Fix it with "openspec config edit", or reset it with "openspec config reset --all".
```
Until it is fixed, telemetry and the update check stay off.
### openspec config unset
```bash
@@ -314,7 +323,7 @@ Removes the key so the default applies again. Keys with built-in defaults always
Unset delivery (reverted to default)
```
A key with no value at all prints `Key "featureFlags.nothere" was not set`. Both cases exit 0.
A key with no value at all prints `Key "featureFlags.nothere" was not set`. Both cases exit 0. A config file that cannot be parsed exits 1 instead, as for `config set`.
### openspec config reset
@@ -350,7 +359,11 @@ Without `--all` it exits 1 and prints the usage line.
openspec config edit
```
Opens the config file in `$EDITOR` (falling back to `$VISUAL`), creating it with defaults first if missing. When the editor closes, the file is validated. Invalid JSON or an invalid config exits 1. With no editor configured it exits 1:
Opens the config file in `$EDITOR` (falling back to `$VISUAL`), creating it with defaults first if missing. When the editor closes, the file is validated. Invalid JSON or an invalid config exits 1.
The editor value may carry arguments and quoted paths, for example `code --wait` or `"/Applications/Sublime Text.app/Contents/SharedSupport/bin/subl" -w`. It is split into words without a shell, so `$VAR`, `~` and `;` are passed through literally. An editor that cannot start, or exits non-zero, prints a one-line error and exits 1.
With no editor configured it exits 1:
```
Error: No editor configured
@@ -449,6 +462,13 @@ Specs:
An empty listing prints `No active changes found.` or `No specs found.` and still exits 0.
A change is a directory directly under `openspec/changes/`. Unlike specs, changes cannot be nested in a namespace folder. A folder like `changes/mobile/` that only wraps a change (`changes/mobile/refresh-token/`) is listed with the status `not a change`, followed by a warning that names the nested directories. `--json` marks that entry with a `nested` array and adds a top-level `warnings` array. `show`, `status`, `validate` and `archive` refuse the folder with the same message. To fix it, move the change up and fold the namespace into its name:
```bash
mv openspec/changes/mobile/refresh-token openspec/changes/mobile-refresh-token
rmdir openspec/changes/mobile
```
**Exit codes**
- `0`: listing printed, even when empty.
@@ -667,6 +687,18 @@ Bulk runs print one status line per item, followed by any findings, and end with
Totals: 2 passed, 0 failed (2 items)
```
**Task checkbox findings**
Progress counts checkboxes and nothing else, so a task file written as plain bullets reads as zero tasks: `openspec list` and `openspec status` report no work, and `openspec archive` has nothing to flag as incomplete. Validate reports a `WARNING` on each tracked task file that lists work without a checkbox:
```text
⚠ [WARNING] tasks.md: This change counts as 0 tasks: no line in its tracked task files is a checkbox, so "openspec list" and "openspec status" report no work and "openspec archive" has nothing to flag as incomplete. Write each task as "- [ ] 1.1 Description".
```
The warning fires only when the change's whole tracked set holds no checkbox at all. One file of prose beside a real checklist is not reported, and a change mid-authoring keeps its progress the moment a single checkbox exists. `--strict` turns the warning into a failure. The line number is in the `--json` report.
Fenced blocks, HTML comments, YAML front matter and indented code are not scanned, so a pasted terminal sample is never mistaken for a task list.
**Archive merge findings**
For changes, validate runs archive's merge builder against the current main specs without writing files. It reports merge conflicts, such as a missing `MODIFIED` target or a conflicting `ADDED` requirement, as `INFO`:
@@ -999,7 +1031,20 @@ Schema: spec-driven
Next: openspec status --change add-caching
```
With `--json`:
When no `openspec/` directory was found, `new change` creates one where you are and says so:
```
Created change 'add-caching' at openspec/changes/add-caching/
Schema: spec-driven
Next: openspec status --change add-caching
Note: no OpenSpec root was found here, so one was created at openspec/.
Run `openspec init` to finish setting this project up, or delete that directory if you meant a different project.
```
The notice goes to stdout with the rest of the human output, and never appears with `--json`.
With `--json`, in a project that already has `openspec/`:
```json
{
@@ -1016,6 +1061,15 @@ With `--json`:
}
```
When no `openspec/` directory was found and `new change` created one, the JSON has the same shape. `root.path` is the directory you ran it from, and `root.source` reads `implicit`:
```json
"root": {
"path": "/Users/you/projects/my-app",
"source": "implicit"
}
```
**Exit codes**
- `0`: change created.
@@ -1065,8 +1119,24 @@ Progress: 2/4 artifacts complete
[x] specs
[ ] design
[-] tasks (blocked by: design)
Next: openspec instructions design --change "add-rate-limit" --json
```
The `Next:` line names the one command that moves the change forward, so `openspec status` is enough to pick a change back up in a fresh session. It names the next ready artifact while planning is unfinished, and `openspec instructions apply` once every planning artifact exists:
```
[x] proposal
[x] specs
[x] design
[x] tasks
All planning artifacts complete!
Next: openspec instructions apply --change "add-rate-limit" --json
```
It carries `--store <id>` whenever the resolved root is a store, and names the same command as the JSON `nextSteps` sentence.
`--json` adds per-artifact dependencies, resolved file paths, and a suggested next step. Trimmed:
```json
@@ -1218,7 +1288,9 @@ With `--json`, each form returns one object. The artifact form starts:
...
```
and continues with `outputPath`, `existingOutputPaths`, the full `instruction` and `template` strings, `dependencies`, `unlocks`, and `root`. The `apply` form carries `contextFiles`, `progress`, `tasks`, `state` (`blocked`, `ready`, `all_done`), and `instruction`.
and continues with `outputPath`, `existingOutputPaths`, the full `instruction` and `template` strings, `dependencies`, `unlocks`, and `root`. The `apply` form carries `contextFiles`, `progress`, `tasks`, `taskTrackingConfigured`, `state` (`blocked`, `ready`, `all_done`), and `instruction`.
`taskTrackingConfigured` is always a boolean: `true` when the schema sets a non-null [`apply.tracks`](schemas/schema-yaml.md#tracks), even if no file matches, and `false` otherwise. If a matched tracking file cannot be read, `unavailableTrackingFiles` contains its absolute `path` and error `reason`. This field is omitted when every matched file is readable. Readable files still contribute to `tasks` and `progress`, but `state` cannot be `all_done` until every matched file is read.
**Exit codes**
@@ -1410,7 +1482,7 @@ openspec schema validate spec-driven # one schema, from any source
openspec schema validate # every project-local schema
```
It verifies that `schema.yaml` exists and parses, that the structure matches the schema format, that every artifact's template file exists inside the schema's `templates/` directory, and that the dependency graph has no cycles or unknown references.
It verifies that `schema.yaml` exists and parses, that the structure matches the schema format, that every artifact's template file exists inside the schema's `templates/` directory, and that the dependency graph has no cycles or unknown references, including in `apply.requires`. An `apply.tracks` value that isn't exactly equal to some artifact's `generates` value prints a `warning:` line but does not fail validation, because OpenSpec then can't tell which artifact's progress that file belongs to.
**Options**
@@ -1559,6 +1631,8 @@ openspec store setup team-context --path ~/openspec/team-context
In an interactive terminal, setup prompts for a missing name and location and confirms before creating anything. Outside one, a missing name or `--path` exits 1 with the flag to pass. Rerunning setup for a registered store reports `Registry: already registered`.
Setup exits 1 with `store_setup_inside_git_repo` when `--path` is inside another Git repository, because initializing the store there would nest one repository in another. `--no-init-git` creates no repository, so it skips that check. Use it to keep a store at `~/openspec/<id>` when your home directory is itself a Git repository, such as a dotfiles repo.
**Arguments**
| Argument | What it is |
@@ -1682,6 +1756,8 @@ Error: Pass --yes to delete store files non-interactively.
Fix: openspec store remove design-system --yes
```
Remove exits 1 and deletes nothing when the folder lacks matching store metadata, or when it contains another registered store (for example a store vendored as a Git submodule). In that case the error is `store_remove_contains_registered_store`: run `openspec store unregister <nested-id>` first, or `openspec store unregister <id>` to forget the store without deleting files.
**Options**
| Flag | Effect |
@@ -2118,6 +2194,8 @@ Supported shells: `zsh`, `bash`, `fish`, `powershell`. Every subcommand takes an
| `install [shell]` | Write the script and configure your shell startup file. |
| `uninstall [shell]` | Remove the script and the config block. |
Installed with Nix, completions are already in place: the flake package ships the Bash, Fish, and Zsh scripts at the standard locations, so `install` is not needed ([Installation](../start/installation.md#nix)).
### openspec completion generate
Prints the script and writes nothing.
@@ -20,7 +20,7 @@ Each change keeps its metadata at `openspec/changes/<change-name>/.openspec.yaml
### schema
The workflow schema this change follows. It is set when the change is created and wins over the project config, so a change keeps its schema even if `openspec/config.yaml` changes afterwards. Valid names are listed in [Schemas](../schemas/index.md).
The workflow schema this change follows. It is set when the change is created and wins over the project config, so a change keeps its schema even if `openspec/config.yaml` changes afterwards. Run [`openspec schemas`](../cli.md#openspec-schemas) to list the available schema names.
### initiative
@@ -36,11 +36,11 @@ Keys other than `store` and `id` are rejected. No command reads the link today.
### skip_specs
Declares the change intentionally makes no spec deltas: a pure refactor, tooling, or docs change. With it set, validation accepts zero deltas, and artifacts that would generate spec files count as complete. Setting it while spec files exist under specs/ is a validation error. Its effect on deltas and archive is on [spec-driven](../schemas/spec-driven/index.md).
Declares the change intentionally makes no spec deltas: a pure refactor, tooling, or docs change. With it set, validation accepts zero deltas, and artifacts that would generate spec files count as complete. Setting it while spec files exist under specs/ is a validation error.
### retire_capabilities
Authorizes archive to retire a capability. When this change's REMOVED deltas take away the last requirement a capability has, archive deletes that capability's main spec instead of stopping. The flag exists because the deletion is only recoverable from git, so it stays the author's call. The archive behavior is on [spec-driven](../schemas/spec-driven/index.md).
Authorizes archive to retire a capability. When this change's REMOVED deltas take away the last requirement a capability has, archive deletes that capability's main spec instead of stopping. The flag exists because the deletion is only recoverable from git, so it stays the author's call.
## Example
@@ -15,8 +15,8 @@ The CLI keeps its machine-level settings at `~/.config/openspec/config.json` on
| `workflows` | list of strings | No | The workflow list a `custom` profile installs |
| `featureFlags` | map: flag → boolean | No | Boolean feature toggles |
| `defaultStore` | string | No | Machine-level fallback store for root resolution |
| `openers` | list | No | The tools worksets open in, and how each is launched |
| `telemetry` | map | No | State the CLI keeps: anonymous id and notice-seen |
| `openers` | map: tool id → settings | No | The tools worksets open in, and how each is launched |
| `telemetry` | map | No | Telemetry opt-out, anonymous id, and notice-seen state |
### profile
@@ -40,11 +40,45 @@ The machine-level fallback store id for root resolution, consulted only when no
### openers
The tools a workset can open in, and how each is launched. Entries are hand-edited and validated on use. Each may set `style` (`workspace-file` or `attach-dirs`), `label`, `command`, `args`, and `attach_flag`, and is merged over the built-in defaults.
The tools a workset can open in, keyed by tool id. Edit `openers` in the global `config.json` with `openspec config edit` in your terminal.
| Field | Contract |
| --- | --- |
| `style` | `workspace-file` or `attach-dirs`. Required for a new tool; optional for a built-in. |
| `label` | Non-empty string shown in the tool picker. Defaults to the id for a new tool. |
| `command` | Non-empty executable name or path. Defaults to the id for a new tool. Put arguments in `args`, not in this string. |
| `args` | Array of strings passed before the workspace file or attach flags. Defaults to `[]` for a new tool. |
| `attach_flag` | Non-empty string paired with each member path for `attach-dirs`. Defaults to `--add-dir` for a new tool. Ignored for `workspace-file`. |
**Built-in overrides:** `code`, `cursor`, `claude`, and `codex` retain any fields you omit. Setting `args` replaces the entire argument list; `[]` clears it.
**Launch styles:** `workspace-file` passes the generated `.code-workspace` path to the executable. `attach-dirs` passes one flag/path pair per member, including the primary member.
**Availability:** `attach-dirs` openers, including Claude Code and Codex, are disabled by default. You cannot select or save them with `--tool`, and OpenSpec refuses to open a workset that already names one. Configuration overrides do not enable the `attach-dirs` launch style.
**Validation:** unknown fields, invalid types, and a new tool without `style` fail when a workset command reads the opener table.
This example adds VS Code Insiders and passes `--new-window` whenever the built-in VS Code opener launches:
```json
{
"openers": {
"code-insiders": {
"style": "workspace-file",
"label": "VS Code Insiders"
},
"code": {
"args": ["--new-window"]
}
}
}
```
The corresponding `code-insiders` or `code` executable must be installed and available on `PATH`.
### telemetry
State the CLI writes for telemetry: your anonymous id and whether the first-run notice was shown. It is not the opt-out. Disabling telemetry is an environment variable, on [Environment variables](environment-variables.md).
The CLI stores your anonymous id and whether the first-run notice was shown. Set `telemetry.enabled` to `false` to disable telemetry. You can also opt out with `OPENSPEC_TELEMETRY=0` or `DO_NOT_TRACK=1` in your environment.
## Example
@@ -23,7 +23,7 @@ What to write in these fields is covered in [Project configuration](../../custom
### schema
The workflow schema every change in this project follows. Valid values are `spec-driven` or a schema name the project defines. The names are listed in [Schemas](../schemas/index.md).
The workflow schema every change in this project follows. Valid values are `spec-driven` or a schema name the project defines. Run [`openspec schemas`](../cli.md#openspec-schemas) to list the available schema names.
### context
+1 -1
View File
@@ -7,5 +7,5 @@
| [Project configuration (config.yaml)](config-yaml.md) | `openspec/config.yaml` | The schema, context, and rules this project plans with |
| [Change metadata (.openspec.yaml)](change-metadata.md) | `openspec/changes/<name>/.openspec.yaml` | The workflow schema, goal, scope, and spec exceptions for one change |
| [CLI settings (config.json)](config-json.md) | `~/.config/openspec/config.json` (Windows varies) | How the openspec CLI behaves on your machine |
| [Environment variables](environment-variables.md) | Your shell or CI environment | Telemetry opt-out, and where the config and data directories live |
| Environment variables | Your shell or CI environment | Telemetry opt-out, and where the config and data directories live |
| Stores | `~/.local/share/openspec/stores/` (Windows varies) | The registry and metadata behind multi-repo stores |
+11 -11
View File
@@ -2,26 +2,26 @@
> Every OpenSpec term, one line each.
OpenSpec reuses words that mean something else in git, CI, and agent tooling. Each row gives the OpenSpec meaning, and the last column links to the page that teaches the term.
OpenSpec reuses words that mean something else in git, CI, and agent tooling. Each row gives the OpenSpec meaning. The last column links to more detail where available.
| Term | Definition | More |
|---|---|---|
| **Apply** | Implement the tasks in a change proposal. Skill: `openspec-apply-change`. | [Apply a change](../guides/apply.md) |
| **Apply** | Implement the tasks in a change proposal. Skill: `openspec-apply-change`. | [Apply a change](skills.md#openspec-apply-change) |
| **Archive** | Complete a change proposal: merge its deltas into the main specs and move its folder to `openspec/changes/archive/`. | [Quickstart](../start/quickstart.md) |
| **Artifact** | A planning document inside a change proposal: `proposal.md`, delta specs, `design.md`, `tasks.md`. Not a build output. | [Concepts](../guides/concepts.md) |
| **Capability** | One behavior area of your system. Each has one spec at `openspec/specs/<capability>/spec.md`. | [Concepts](../guides/concepts.md) |
| **Change proposal** | One unit of work: a folder under `openspec/changes/<name>/` holding its planning artifacts. Often shortened to "change". Not a git commit. | [Concepts](../guides/concepts.md) |
| **Artifact** | A planning document inside a change proposal: `proposal.md`, delta specs, `design.md`, `tasks.md`. Not a build output. | [Artifacts](schemas/spec-driven/index.md#artifacts) |
| **Capability** | One behavior area of your system. Each has one spec at `openspec/specs/<capability>/spec.md`. | [Capabilities](schemas/spec-driven/index.md#proposalmd) |
| **Change proposal** | One unit of work: a folder under `openspec/changes/<name>/` holding its planning artifacts. Often shortened to "change". Not a git commit. | [Propose](../start/quickstart.md#step-2-propose) |
| **Command** | A typed entry point for a workflow. Spelling varies per tool (`/opsx:propose`, `/opsx-propose`). The docs name workflows by skill instead. | [Supported tools](supported-tools.md) |
| **Continue** | Create the next planning artifact for an existing change proposal. Skill: `openspec-continue-change`. | [Skills](skills.md) |
| **Delivery** | How workflows are installed: as skills, commands, or both. | [Set up your project](../start/setup.md) |
| **Delta spec** | A spec inside a change proposal listing only what changes, under `ADDED`, `MODIFIED`, `REMOVED`, and `RENAMED` headers. | [Delta specs](schemas/spec-driven/index.md#delta-specs-specmd) |
| **Explore** | Think an idea through with the agent before proposing. Writes no code. Skill: `openspec-explore`. | [Explore an idea](../guides/explore.md) |
| **Explore** | Think an idea through with the agent before proposing. Writes no code. Skill: `openspec-explore`. | [Explore an idea](skills.md#openspec-explore) |
| **Fast-forward** | Create a change proposal with every planning artifact in one pass, ready to implement. Skill: `openspec-ff-change`. Not a git fast-forward. | [Skills](skills.md) |
| **Legacy workflow** | The pre-OPSX `/openspec:*` commands. | [Migration](../help/legacy/migration.md) |
| **Legacy workflow** | The pre-OPSX `/openspec:*` commands. | |
| **Loop** | The cycle a change proposal moves through: explore, propose, review, apply, archive. | [Quickstart](../start/quickstart.md) |
| **Main specs** | The `openspec/specs/` tree: the current, agreed behavior of your system. Archiving merges deltas into it. | [Concepts](../guides/concepts.md) |
| **Main specs** | The `openspec/specs/` tree: the current, agreed behavior of your system. Archiving merges deltas into it. A capability with no spec yet gets one from its `ADDED` requirements. | [Archive](../start/quickstart.md#step-5-archive) |
| **OpenSpec root** | The `openspec/` tree a command resolves to and operates on: your repo's, or a store's. | [Stores](../multi-repo/stores.md#where-artifacts-get-created-when-using-stores) |
| **OPSX** | The current OpenSpec workflow system, and the command prefix it installs (`/opsx:`). | [Architecture](architecture/index.md) |
| **OPSX** | The current OpenSpec workflow system, and the command prefix it installs (`/opsx:`). | |
| **Profile** | Which workflows init installs: `core` or `custom`. | [Profiles](../customize/profiles.md) |
| **Propose** | Create a change proposal and generate all its planning artifacts in one step. Skill: `openspec-propose`. | [Quickstart](../start/quickstart.md) |
| **Registry** | The machine-level list of registered stores, in `registry.yaml`. Not a package registry. | [CLI](cli.md#openspec-store) |
@@ -29,12 +29,12 @@ OpenSpec reuses words that mean something else in git, CI, and agent tooling. Ea
| **Scenario** | A testable example under a requirement, in WHEN/THEN form. | [Delta specs](schemas/spec-driven/index.md#delta-specs-specmd) |
| **Schema** | The definition of which artifacts a change proposal produces, and in what order. Not JSON Schema. | [Schemas](schemas/index.md) |
| **Skill** | A workflow's instructions, installed where your AI tool reads them (`.agents/skills/`, ...). | [Skills](skills.md) |
| **Spec** | A file describing how one capability behaves today, at `openspec/specs/<capability>/spec.md`. | [Concepts](../guides/concepts.md) |
| **Spec** | A file describing how one capability behaves today, at `openspec/specs/<capability>/spec.md`. | [Archive](../start/quickstart.md#step-5-archive) |
| **spec-driven** | The default schema: proposal, then delta specs, then design, then tasks. | [spec-driven](schemas/spec-driven/index.md) |
| **Store** | A standalone OpenSpec repo registered on your machine, for planning that spans repositories. Not a data store. | [Stores (beta)](../multi-repo/stores.md) |
| **Sync** | Merge implemented deltas into the main specs without archiving. Skill: `openspec-sync-specs`. | [Skills](skills.md) |
| **Template** | The starting content a schema gives each artifact. | [Schemas](../customize/schemas.md) |
| **Update** | As a skill (`openspec-update-change`): revise a change proposal's planning artifacts. As a CLI command (`openspec update`): refresh OpenSpec's installed files. | [Change course](../guides/change-course.md), [CLI](cli.md) |
| **Update** | As a skill (`openspec-update-change`): revise a change proposal's planning artifacts. As a CLI command (`openspec update`): refresh OpenSpec's installed files. | [Update a change](skills.md#openspec-update-change), [CLI](cli.md) |
| **Verify** | Check the implementation matches a change proposal's artifacts before archiving. Skill: `openspec-verify-change`. | [Skills](skills.md) |
| **Workflow** | A named OpenSpec action (propose, apply, archive, ...), installed into your AI tool as a skill or command. | [Set up your project](../start/setup.md) |
| **Workset** | A personal, local group of folders opened together in one tool. Not a store, and nothing is shared. | [Worksets (beta)](../multi-repo/worksets.md) |
+28 -9
View File
@@ -74,7 +74,15 @@ A glob can match several files:
generates: specs/**/*.md
```
This matches Markdown files below `openspec/changes/add-auth/specs/`. OpenSpec treats a value containing `*`, `?`, or `[` as a glob.
This matches Markdown files below `openspec/changes/add-auth/specs/`.
OpenSpec recognizes these glob forms in `generates`:
- **Wildcards and character classes**: values containing `*`, `?`, or `[`, such as `specs/**/*.md` and `review-[ab].md`.
- **Brace expansions**: alternatives such as `review-{api,ui}.md` and ranges such as `file-{1..3}.md`.
- **Extglobs**: patterns such as `@(proposal|design).md`, `+(proposal|design).md`, and `!(proposal|design).md`.
**Literal filenames**: a leading `!` alone does not make a glob. Use `generates: '!review.md'` to name that file. Plain parentheses such as `(proposal|design).md` and single-element braces such as `review-{api}.md` also remain literal.
OpenSpec rejects absolute paths and paths containing a `..` segment.
@@ -119,7 +127,7 @@ OpenSpec rejects absolute paths and paths containing a `..` segment.
| Field | Contract |
|---|---|
| `requires` | **Required.** A non-empty list of artifacts that must exist before apply instructions become ready. |
| `tracks` | An optional relative path to a Markdown task file in the change folder. Default: `null`. |
| `tracks` | An optional relative path or glob for Markdown task files in the change folder. Default: `null`. |
| `instruction` | Optional guidance sent to the agent when apply is ready. OpenSpec uses built-in guidance by default. |
Artifact `requires` controls planning order. `apply.requires` controls when apply instructions become ready.
@@ -132,21 +140,28 @@ The path starts from the change folder. For a change named `add-auth`, `tracks:
openspec/changes/add-auth/tasks.md
```
Apply stays blocked if that file is missing or contains no checkbox with task text. OpenSpec counts these checkbox forms:
A glob such as `tracks: "**/tasks.md"` reads every matching file, such as `backend/tasks.md` and `frontend/tasks.md`. OpenSpec combines their tasks and progress. Use the same value for an artifact's `generates` field so status and list track the same files.
Apply stays blocked if no file matches or the matched files contain no checkbox with task text. OpenSpec counts these checkbox forms:
```markdown
- [ ] Pending task
- [x] Completed task
* [X] Completed task
+ [ ] Pending task
1. [ ] Pending task
2) [x] Completed task
```
Leading spaces are allowed. The [tasks.md section of the spec-driven page](spec-driven/index.md#tasksmd) defines the stricter format produced by the default schema.
Any Markdown list marker works: `-`, `*`, `+`, or a number of up to nine digits followed by `.` or `)`. Leading spaces are allowed. The [tasks.md section of the spec-driven page](spec-driven/index.md#tasksmd) defines the stricter format produced by the default schema.
The tracked file drives the apply state:
The tracked files drive the apply state:
- **`blocked`**: the file is missing, or no checkbox has task text.
- **`ready`**: at least one tracked task is pending.
- **`all_done`**: every tracked task is checked.
- **`blocked`**: no file matches, or no readable file has a checkbox with task text.
- **`ready`**: at least one task is pending, or a matched file could not be read while another provides tasks.
- **`all_done`**: every tracked task is checked and every matched file was read.
If a matched file cannot be read, apply keeps the tasks and progress from readable files but does not mark the change `all_done`. [Apply JSON output](../cli.md#openspec-instructions) identifies each unavailable file and the reason.
OpenSpec rejects absolute paths and paths containing a `..` segment.
@@ -198,12 +213,16 @@ apply:
- Field types and required fields
- Relative paths
- Artifact IDs, dependencies, and cycles
- `apply.requires` IDs: each must be an artifact in the schema
- Template files
A schema with an unknown `apply.requires` ID doesn't load, so every command that uses it reports the error.
Validation warns, without failing, when `apply.tracks` isn't exactly equal to some artifact's `generates` value. OpenSpec finds the tracked artifact by comparing those two strings, so anything else leaves it unable to tell which artifact's progress the file belongs to. That includes a typo like `task.md`, and also `tracks: tasks/main.md` against `generates: tasks/*.md`, where the glob does produce the file but the strings still differ. Apply keeps reading the file either way, but `openspec list` and `openspec status` count `tasks.md` instead.
Validation doesn't catch these mistakes:
| Mistake | What happens |
|---|---|
| A field is misspelled, such as `instrution` | OpenSpec ignores it. Validation doesn't report the typo. |
| `apply.requires` names an unknown artifact ID | Validation doesn't report the unknown ID. |
| `name` differs from the schema directory | Validation passes. OpenSpec still uses the directory name for lookup. |
+59 -12
View File
@@ -54,6 +54,8 @@ Establishes why the change is needed.
The template the agent receives as the output format ([templates/proposal.md](https://github.com/Fission-AI/OpenSpec/blob/main/schemas/spec-driven/templates/proposal.md)):
```md
# Proposal
## Why
<!-- Explain the motivation for this change. What problem does this solve? Why now? -->
@@ -101,7 +103,19 @@ Sections:
- **Impact**: Affected code, APIs, dependencies, or systems.
IMPORTANT: The Capabilities section is critical. It creates the contract between
proposal and specs phases. Research existing specs before filling this in.
proposal and specs phases. Research existing specs before filling this in:
run `openspec list --specs` for the project's capability inventory, then
`openspec show "<spec-id>" --type spec --json --no-scenarios` for any that
look related - that returns a capability's purpose and requirement texts
without pulling whole spec files into context. Append `--store "<id>"` to
both commands only for a registered standalone store, and keep `--type
spec`: a change and a spec sharing a name is otherwise an ambiguous-item
error. `openspec list` without `--specs` lists in-flight changes, not
specs - it never shows what the project already covers. Reuse an existing
capability's exact path instead of introducing a near-duplicate name.
The filtered read is only an overview. Before deciding what is already
covered or what should change, read each relevant spec in full, including
scenarios, with `openspec show "<spec-id>" --type spec` (same `--store` rule).
Each capability listed here will need a corresponding spec file.
Every change must either declare at least one capability (new or
@@ -122,11 +136,15 @@ This is the foundation - specs, design, and tasks all build on this.
Defines what behavior changes, with one delta spec per capability the proposal lists.
Each delta spec is the `spec.md` inside its capability folder. `openspec validate` and `openspec archive` reject delta sections written in any other file under `specs/`, such as `specs/user-auth.md`, because archive never merges them.
### Structure
The template the agent receives as the output format ([templates/spec.md](https://github.com/Fission-AI/OpenSpec/blob/main/schemas/spec-driven/templates/spec.md)):
```md
# Spec Delta
## Purpose
<!-- New capabilities only: one or two sentences (50+ characters) on what this capability is for. Delete this section for an existing capability. -->
@@ -168,7 +186,7 @@ Create one spec file per capability listed in the proposal's Capabilities sectio
`<capability-path>` is the spec directory relative to `specs/` (for example,
`user-auth` or `identity/user-auth`). Preserve the full path:
- New capabilities: use the exact path from the proposal at `specs/<capability-path>/spec.md`. Any path segment newly introduced in the proposal must be kebab-case. Follow the project's existing organization; do not add a new domain level when the project uses a flat layout.
- Modified capabilities: use the exact existing path from `openspec/specs/<capability-path>/` when creating the delta at `specs/<capability-path>/spec.md`. Do not move or rename the capability.
- Modified capabilities: use the exact existing path from `openspec/specs/<capability-path>/` when creating the delta at `specs/<capability-path>/spec.md`. Run `openspec list --specs` to confirm that path before writing the delta, appending `--store "<id>"` only for a registered standalone store - a mistyped or invented path targets a capability that does not exist rather than the one you meant. Do not move or rename the capability.
There must be at least one spec file unless the change's `.openspec.yaml`
sets `skip_specs: true` (no spec-level behavior change) - `openspec validate`
@@ -188,7 +206,7 @@ Format requirements:
- **CRITICAL**: Scenarios MUST use exactly 4 hashtags (`####`). Using 3 hashtags or bullets will fail silently.
- Every requirement MUST have at least one scenario.
New capabilities only: start the delta spec with a `## Purpose` section -
New capabilities only: the delta spec's first section is `## Purpose` -
one or two sentences (50+ characters, or `openspec validate --strict`
reports it as too brief) describing what the capability is for. Archive
copies it into the main spec it creates; without it the new main spec is
@@ -196,10 +214,16 @@ left with a `TBD ... Update Purpose after archive` placeholder to fill in
by hand. Do NOT add `## Purpose` to a delta for an existing capability -
that spec already has one and the delta's is ignored. To change an
existing capability's Purpose - including a leftover `TBD` placeholder -
edit `openspec/specs/<capability-path>/spec.md` directly.
edit `<planningHome.root>/openspec/specs/<capability-path>/spec.md`
directly. `planningHome.root` comes from the `openspec instructions ...
--json` response. Always use it rather than a repo-relative path: it
resolves to the store whenever the change lives in one - whether that
came from `--store`, a project `store:` pointer, or a global default
store - and to the current repository otherwise. Do not try to work out
which case applies; the field already has.
MODIFIED requirements workflow:
1. Locate the existing requirement in openspec/specs/<capability-path>/spec.md
1. Locate the existing requirement in `<planningHome.root>/openspec/specs/<capability-path>/spec.md` (the same store-aware root as above)
2. Copy the ENTIRE requirement block (from `### Requirement:` through all scenarios)
3. Paste under `## MODIFIED Requirements` and edit to reflect new behavior
4. Ensure header text matches exactly (whitespace-insensitive)
@@ -207,8 +231,10 @@ MODIFIED requirements workflow:
Common pitfall: Using MODIFIED with partial content loses detail at archive time.
If adding new concerns without changing existing behavior, use ADDED instead.
Example (a new capability, so it opens with `## Purpose`):
Example (a new capability, so its first section is `## Purpose`):
```
# Spec Delta
## Purpose
Lets users take their data out of the product in a portable format.
@@ -241,6 +267,8 @@ Explains how to implement the change. Drafted only when the change needs one.
The template the agent receives as the output format ([templates/design.md](https://github.com/Fission-AI/OpenSpec/blob/main/schemas/spec-driven/templates/design.md)):
```md
# Design
## Context
<!-- Current state and constraints that shape the approach. See proposal.md for motivation - don't restate it -->
@@ -305,6 +333,8 @@ Breaks the implementation into checkable tasks. [apply](#apply) tracks progress
The template the agent receives as the output format ([templates/tasks.md](https://github.com/Fission-AI/OpenSpec/blob/main/schemas/spec-driven/templates/tasks.md)):
```md
# Tasks
## 1. <!-- Task Group Name -->
- [ ] 1.1 <!-- Task description -->
@@ -328,29 +358,46 @@ would change what gets built, resolve them with the user first - do not
bake an unstated assumption into the task list.
**IMPORTANT: Follow the template below exactly.** The apply phase parses
checkbox format to track progress. Tasks not using `- [ ]` won't be tracked.
checkbox format to track progress. A box holding only `x` counts as done,
upper or lower case and with any spacing, so `- [ x]` is done too. Every
other marker, including `- [~]`, `- [-]` and an empty `- []`, reads as
unfinished. A line with no checkbox is not tracked at all.
Guidelines:
- Group related tasks under ## numbered headings
- Each task MUST be a checkbox: `- [ ] X.Y Task description`
- Tasks should be small enough to complete in one session
- Order tasks by dependency (what must be done first?)
- Each task MUST state how to verify completion (a test, command,
observable behavior, or delivered artifact). Put the verification in
that task's checkbox description. Use a separate verification task only
when it checks broader integration or system behavior that spans
multiple implementation tasks.
- Each task group MUST land the tests and documentation its own work
calls for. Do NOT collect testing or documentation into a final group -
when a late group first exercises work from an early one, the failures
cascade back through every group in between and force rework. A group
whose work calls for neither, such as scaffolding or dependency setup,
carries neither. A final group is for integration checks only, not for
the tests and docs an earlier group owed.
Example:
```
# Tasks
## 1. Setup
- [ ] 1.1 Create new module structure
- [ ] 1.2 Add dependencies to package.json
- [ ] 1.1 Create new module structure and verify expected files are present
- [ ] 1.2 Add dependencies to package.json and verify package installation succeeds
## 2. Core Implementation
- [ ] 2.1 Implement data export function
- [ ] 2.2 Add CSV formatting utilities
- [ ] 2.1 Implement data export function and verify the export test passes
- [ ] 2.2 Add CSV formatting utilities and verify unit tests cover quoting and delimiters
- [ ] 2.3 Document the export API in docs/export.md and verify the documented command runs as written
```
Reference specs for what needs to be built, design for how to build it.
Each task should be verifiable - you know when it's done.
````
## Apply
+11 -2
View File
@@ -39,6 +39,13 @@ The skills come in two sets:
- **Core**: installed by default, the main planning loop.
- **Optional**: installed only when you add them, via [Profiles](../customize/profiles.md).
Every skill expects a project that already uses OpenSpec. Before its first step that writes anything, a skill checks for a resolved root. What happens when there is none depends on how the skill was reached:
- **Auto-selected**: your agent picked the skill on its own, without you naming OpenSpec. It drops OpenSpec and answers your request normally, the way it would with OpenSpec not installed.
- **Explicit OpenSpec request**: you named OpenSpec, named the skill, or ran its command. It stops before writing and asks how to proceed: run `openspec init` here, target a store with `--store <id>`, or continue without OpenSpec. It waits for your answer.
Commands are always the second case. A project whose `openspec/config.yaml` names a store this machine cannot resolve (not registered, or a malformed `store:` line) is not treated as uninitialized: the skill stops and shows the store error with its fix. No skill creates an `openspec/` directory on its own in either case. The entries below describe what each skill does once a root is in place.
| Skill | Job | Type |
|---|---|---|
| [openspec-explore](#openspec-explore) | Think through an idea before it becomes a change proposal | Core |
@@ -54,6 +61,8 @@ The skills come in two sets:
| [openspec-bulk-archive-change](#openspec-bulk-archive-change) | Archive several change proposals at once | Optional |
| [openspec-onboard](#openspec-onboard) | Learn the workflow by doing one real change proposal end to end | Optional |
Each entry below names the skill that owns the next step. When your profile leaves that skill out, the installed files never name it: the handoff becomes the equivalent `openspec` command, or a plain request to you, and a line that exists only to point at a missing skill is not written at all. So the skills you have always hand off to skills you have. Which set you get is [Profiles](../customize/profiles.md).
## openspec-explore
Think through an idea before it becomes a change proposal.
@@ -82,7 +91,7 @@ Implement a change proposal's tasks, working through the list until done or bloc
|---|---|
| **Arguments** | A change proposal name (`add-auth`), optional. If the target is ambiguous it lists the active change proposals and asks you to pick. |
| **Creates** | Code: the minimal changes each task calls for, in your project files. In the change proposal it touches only the tasks file, checking off each finished task (`- [ ]` to `- [x]`). |
| **Response** | Progress per task, then an overall count (N/M tasks complete). All done: suggests `openspec-archive-change`. Blocked by missing artifacts: points to `openspec-continue-change`. Unclear tasks or errors: pauses and asks. |
| **Response** | Progress per task, then an overall count (N/M tasks complete). All done: suggests `openspec-archive-change`. Blocked by missing artifacts: points to `openspec-continue-change`, or to `openspec status` and `openspec instructions` when that skill is not installed (the core profile leaves it out). Unclear tasks or errors: pauses and asks. |
## openspec-update-change
@@ -92,7 +101,7 @@ other.
| Contract | Description |
|---|---|
| **Arguments** | A change proposal name, optional, plus the revision you want. With no revision stated it runs a coherence review: artifacts checked against each other for contradictions, gaps, and duplication. |
| **Creates** | Nothing new. Edits only artifact files that already exist. Missing artifacts are `openspec-continue-change`'s job. Never code. |
| **Creates** | Edits artifact files that already exist. One exception: for an artifact written as a glob, such as `specs/**/*.md`, that already has at least one file, it can add a missing companion file once you confirm the path. An artifact with no files yet is `openspec-continue-change`'s job. Without that skill (the core profile leaves it out), it points to `openspec status` and `openspec instructions` instead. Never code. |
| **Response** | Shows each proposed revision and writes it only after you confirm, one artifact at a time. Ends with what was revised and the next step; implementation waits for `openspec-apply-change`. |
## openspec-sync-specs
+20 -8
View File
@@ -35,7 +35,7 @@ The id goes to `openspec init --tools <id>` to skip the picker ([CLI](cli.md)).
| Hermes Agent | `hermes` | `.hermes/skills/` | `/openspec-apply-change` | none | none |
| iFlow | `iflow` | `.iflow/skills/` | `/openspec-apply-change` | `.iflow/commands/` | `/opsx-apply` |
| Junie | `junie` | `.junie/skills/` | `/openspec-apply-change` | `.junie/commands/` | `/opsx-apply` |
| Kilo Code | `kilocode` | `.kilocode/skills/` | `/openspec-apply-change` | `.kilocode/workflows/` | `/opsx-apply` |
| Kilo Code | `kilocode` | `.kilocode/skills/` | `/openspec-apply-change` | `.kilo/command/` | `/opsx-apply` |
| Kimi Code | `kimi` | `.kimi-code/skills/` | `/skill:openspec-apply-change` | none | none |
| Kiro | `kiro` | `.kiro/skills/` | `/openspec-apply-change` | `.kiro/prompts/` | `/opsx-apply` |
| Lingma | `lingma` | `.lingma/skills/` | `/openspec-apply-change` | `.lingma/commands/opsx/` | `/opsx:apply` |
@@ -49,7 +49,7 @@ The id goes to `openspec init --tools <id>` to skip the picker ([CLI](cli.md)).
| Trae | `trae` | `.trae/skills/` | `/openspec-apply-change` | `.trae/commands/` | `/opsx-apply` |
| ZCode | `zcode` | `.zcode/skills/` | `/openspec-apply-change` | `.zcode/commands/opsx/` | `/opsx:apply` |
| Zoo Code | `roocode` | `.roo/skills/` | `/openspec-apply-change` | `.roo/commands/` | `/opsx-apply` |
| Shared `.agents` skills | `agents` | `.agents/skills/` | `/openspec-apply-change` | none | none |
| Other / Universal | `agents` | `.agents/skills/` | `/openspec-apply-change` | none | none |
- **Skill invocation**: whether a tool registers skills as typed entries is the tool's
own behavior. The column shows the spelling OpenSpec uses in generated files and in
@@ -80,8 +80,12 @@ Skills stay in `.cline/skills/`.
### Codex
- **Invocation**: type `$openspec-<skill>`. Codex does not recognize the
`/openspec-<skill>` form ([upstream issue](https://github.com/openai/codex/issues/11817)).
- **CLI and IDE extension**: mention `$openspec-propose` with your idea, or run
`/skills` to select the skill. Codex does not recognize `/openspec-propose`
([upstream issue](https://github.com/openai/codex/issues/11817)).
- **Desktop app**: open Skills in the sidebar and select `openspec-propose`.
[OpenAI's skills documentation](https://learn.chatgpt.com/docs/build-skills)
describes both interfaces.
- **No command files**: Codex runs skills directly, so init skips commands even when
delivery includes them and prints `Commands skipped for: codex (uses skills)`.
- **Shared folder**: Codex skills land in `.agents/skills/`, the same tree Antigravity,
@@ -102,8 +106,13 @@ Skills stay in `.cline/skills/`.
### GitHub Copilot
Prompt files register as slash commands in the Copilot IDE extensions (VS Code,
JetBrains, Visual Studio). Copilot CLI does not read `.github/prompts/`.
- **IDE extensions (command delivery)**: VS Code, JetBrains, and Visual Studio load
`.github/prompts/opsx-<id>.prompt.md` as `/opsx-<id>`. If a command disappears
while its file still exists, restart the IDE.
- **Copilot CLI (skill delivery)**: the CLI ignores `.github/prompts/` and loads
`.github/skills/openspec-*/SKILL.md` instead. Invoke a skill as
`/openspec-<skill>`. If a skill disappears while its file still exists, run
`/skills reload`, then `/skills info openspec-propose` to confirm discovery.
### Hermes Agent
@@ -118,10 +127,13 @@ init prints this reminder after install.
- **Safe across projects**: a commands-only delivery leaves the global skills in
place, so one project's setting cannot remove skills another project uses.
### Shared `.agents` skills
### Other / Universal (shared `.agents` skills)
- **When it fits**: any tool that reads the shared `.agents/skills/` folder,
including tools with no row in the matrix.
including tools with no row in the matrix. It is the entry to pick when your
assistant is not listed. The init picker's search box finds it by `universal`,
`other`, `generic`, `custom`, `proprietary`, `unlisted`, `unsupported`,
`vendor-neutral`, or `agents.md`.
- **Alongside other targets**: Antigravity, Codex, Zed Agent, and this target share
one physical skill tree. OpenSpec records one writer in `.openspec-target` and
writes the tree once per run. Each tool's separate command files are still
+23 -4
View File
@@ -5,7 +5,9 @@
## Prerequisites
OpenSpec is a Node.js CLI. You need version 20.19.0 or newer.
OpenSpec runs on Node.js 20.19.0 or newer. Homebrew installs Node.js as a
dependency, and the Nix package includes the runtime. Check your installed version
before using another install method.
In your terminal:
@@ -13,7 +15,9 @@ In your terminal:
node --version
```
If that prints `v20.19.0` or higher, you're set. If not, install a newer Node from [nodejs.org](https://nodejs.org) or through your version manager (nvm, fnm, asdf, volta).
If that prints `v20.19.0` or higher, you're set. If not, install a newer Node from
[nodejs.org](https://nodejs.org) or through your version manager (nvm, fnm, asdf,
volta). You can skip this check when you install with Homebrew or Nix.
The workflow itself runs inside an AI coding tool: Claude Code, Cursor, or any other tool on the [supported list](../reference/supported-tools.md).
@@ -53,6 +57,16 @@ In your terminal:
npm install -g @fission-ai/openspec@latest
```
### Homebrew
Homebrew installs OpenSpec and its Node.js dependency on macOS or Linux. In your terminal:
```bash
brew install openspec
```
The formula is published in [homebrew-core](https://formulae.brew.sh/formula/openspec), so you don't need to add a tap.
### Yarn
`yarn global add` is Yarn Classic (1.x) only. Modern Yarn removed global installs, so use npm, pnpm, or bun instead. A global CLI doesn't have to share your project's package manager.
@@ -94,6 +108,11 @@ That leaves nothing on your PATH, so there's no install to check afterward.
To put OpenSpec in a project dev shell instead, add the flake as an input and use its default package; [flake.nix](https://github.com/Fission-AI/OpenSpec/blob/main/flake.nix) lists the outputs.
The Nix package ships the Bash, Fish, and Zsh completion scripts at the standard
locations (`share/bash-completion/completions`, `share/fish/vendor_completions.d`,
`share/zsh/site-functions`), so they load with the package and there is no need to run
`openspec completion install`.
### Check it worked
Whichever method you used, in your terminal:
@@ -118,7 +137,7 @@ When a newer CLI is out, [`openspec update`](../reference/cli.md#openspec-update
> [!WARNING]
> On Deno, re-run the [Deno install](#deno) with `-f`; it won't overwrite the installed command without it. On Nix, use `nix profile upgrade openspec`.
> On Homebrew, run `brew upgrade openspec`. On Deno, re-run the [Deno install](#deno) with `-f`; it won't overwrite the installed command without it. On Nix, use `nix profile upgrade openspec`.
> [!NOTE]
> A global npm install belongs to one Node installation. Switch Node versions with nvm and the `openspec` command doesn't come along, so install it again under the new version.
@@ -139,7 +158,7 @@ openspec completion uninstall
npm uninstall -g @fission-ai/openspec
```
On Deno: `deno uninstall --global openspec`. On Nix: `nix profile remove openspec`. Your shell should no longer find `openspec`.
On Homebrew: `brew uninstall openspec`. On Deno: `deno uninstall --global openspec`. On Nix: `nix profile remove openspec`. Your shell should no longer find `openspec`.
**3. Delete what's left, or keep it.**
+20 -13
View File
@@ -1,9 +1,19 @@
# Quickstart
> Your first change on your existing repo, from idea to archived.
> Your first change, from idea to archived, in a new or existing project.
Before you start, you need the CLI on your machine ([Installation](installation.md)) and OpenSpec initialized in your project ([Set up your project](setup.md)).
## Start from an empty project
You can start without a chosen stack or a complete architecture. Initialize OpenSpec in your project folder, then ask your agent to explore the options with you. In your AI chat:
```text
Help me explore a task tracker from scratch. I have not picked a stack. Compare the options and help me choose the first behavior to build.
```
Decide what the first change needs and leave later architecture choices open. Ask your agent to propose that one change, then follow the steps below. You can revisit the architecture as the project grows.
## The loop at a glance
Every change moves through the same five steps: you think the idea through with your agent, it drafts a plan, you correct the plan before any code exists, the agent builds from it, and archiving updates your specs with what shipped.
@@ -17,22 +27,22 @@ flowchart LR
archive -. "next change" .-> explore
```
Every prompt below goes in your AI chat, the same place you ask for code. Each invokes an OpenSpec skill by name, the same spelling in every tool. A plain ask works too ("propose a change to add rate limiting"). Some tools add shorter command aliases (`/opsx:propose` in Claude Code, [other tools vary](../reference/supported-tools.md)).
Every prompt below goes in your AI chat, the same place you ask for code. The examples use plain language so they work across tools. You can also invoke a skill directly; the syntax varies by tool ([supported tools](../reference/supported-tools.md)).
## Step 1: Explore
Think the idea through with your agent before you ask for a plan. In your AI chat:
```text
/openspec-explore how rate limiting should work in this app
Help me explore how rate limiting should work in this app.
```
Explore is a thinking mode. The agent investigates your codebase, asks the questions that matter, sketches options, and challenges assumptions. It writes no code and no files. The output is a sharper idea.
Explore is a thinking mode. The agent investigates your codebase, asks the questions that matter, sketches options, and challenges assumptions. It never writes code. It writes nothing else unless you ask it to capture what you decided, or say yes when it offers. The output is a sharper idea.
Stay here as long as the problem needs. When the shape feels right, hand it off:
```text
/openspec-propose
Propose the change we just discussed.
```
That line starts propose for you, carrying everything you settled. Skip the first prompt in step 2.
@@ -42,7 +52,7 @@ That line starts propose for you, carrying everything you settled. Skip the firs
Propose turns the idea into a reviewable plan. Coming from explore, it's already running. Starting cold, when the change is clear in your head, ask directly. In your AI chat:
```text
/openspec-propose add rate limiting
Propose a change to add rate limiting.
```
The agent asks what it needs to, then writes a change folder:
@@ -75,7 +85,7 @@ To fix something, either works:
Apply turns the plan into code. Start a fresh chat session, since implementation goes better on a clean context window. In your AI chat:
```text
/openspec-apply-change add-rate-limiting
Apply the add-rate-limiting change.
```
The agent reads the change folder, then works through `tasks.md`, checking off each task as it lands.
@@ -91,7 +101,7 @@ Archiving does two things: it updates your main specs with the change's requirem
When every box in `tasks.md` is checked, in your AI chat:
```text
/openspec-archive-change add-rate-limiting
Archive the add-rate-limiting change.
```
Step through what archiving does:
@@ -146,14 +156,11 @@ Step through what archiving does:
└── 2026-08-08-add-rate-limiting/
```
Git is a separate concern. Commit the change folder with the code, and nothing else about your workflow changes. When to archive relative to a PR is a team convention; the [Teams](../guides/teams.md) guide has the tradeoff.
Git is a separate concern. Commit the change folder with the code, and nothing else about your workflow changes.
## Going further
- [Concepts](../guides/concepts.md): what the two artifacts are, and how a delta describes a change.
- [Explore](../guides/explore.md): getting more out of explore mode.
- [Apply](../guides/apply.md): pacing, context windows, resuming long changes.
- [Review the plan](../guides/review-the-plan.md): what to look for in specs before you build.
- [Delta specs](../reference/schemas/spec-driven/index.md#delta-specs-specmd): how to write the behavior changes in a delta spec.
- [Profiles](../customize/profiles.md): optional workflows beyond the core set (verify before archive, incremental planning).
## Advanced guides
+24 -2
View File
@@ -41,7 +41,7 @@ Running init creates two things in your project:
- An `openspec/` folder at the repo root
- Workflow files (skills and commands) added to your AI tool's folder (`.agents/`, `.claude/`, etc.)
Commit all of it like the rest of your source ([FAQ](../help/faq.md) covers why). Init changes nothing else in your repo (if it finds leftovers from an older OpenSpec version, it asks before cleaning them up).
Commit all of it like the rest of your source. Init changes nothing else in your repo (if it finds leftovers from an older OpenSpec version, it asks before cleaning them up).
### The `openspec/` folder
@@ -55,7 +55,7 @@ openspec/
└── archive/ completed changes move here
```
[Concepts](../guides/concepts.md) explains both artifacts; [Project config](../customize/project-config.md) covers `config.yaml`.
[Project config](../customize/project-config.md) covers `config.yaml`.
### The workflow files (skills and commands)
@@ -112,4 +112,26 @@ Config changes:
Answering yes applies it to the current project on the spot. Other projects pick it up on their next `openspec update`. The setting is global, per machine.
#### Claude Code doesn't show the workflows
Claude Code loads OpenSpec workflows from one or both of these project paths, based on your delivery setting:
- **Skills**: `.claude/skills/openspec-*/SKILL.md`
- **Commands**: `.claude/commands/opsx/<id>.md`
If the files are missing, refresh the project. In your terminal:
```bash
openspec update
```
If the command files exist but `/opsx:` shows no OpenSpec commands, update Claude Code and restart it. If commands still don't load, enable skills too. In your terminal:
```bash
openspec config set delivery both
openspec update
```
Restart Claude Code, then run `/openspec-propose` in its chat. If only some workflows are missing, [change your profile](../customize/profiles.md#expanding-the-set-optional-workflows).
Setup is done. The [Quickstart](quickstart.md) takes your first change from here.
+1 -1
View File
@@ -11,7 +11,7 @@ If you read nothing else, read these two pages:
That second one matters more than it looks. OpenSpec has two halves: a command line tool you run in your terminal, and slash commands you give to your AI assistant. Knowing which is which saves you the most common moment of confusion.
> **The best habit to build first: when you're not sure what to build, start with `/opsx:explore`.** It's a no-stakes thinking partner that reads your code, weighs options, and sharpens a fuzzy idea into a concrete plan before any artifact or code exists. The [Explore First](explore.md) guide makes the case.
> **The best habit to build first: when you're not sure what to build, start with `/opsx:explore`.** It's a no-stakes thinking partner that reads your code, weighs options, and sharpens a fuzzy idea into a concrete plan before any code gets written. The [Explore First](explore.md) guide makes the case.
## Pick your path
+4 -2
View File
@@ -47,7 +47,9 @@ deliberately remains the compatibility bare array documented in §4.13:
## 4. Command JSON shapes
### 4.1 `list --json`
`{ "changes": [ { "name", "completedTasks", "totalTasks", "lastModified", "status": "no-tasks"|"complete"|"in-progress" } ], "root": RootOutput }` — note the per-change `status` is a string enum here. `--specs`: `{ "specs": [ { "id", "requirementCount" } ], "root" }`.
`{ "changes": [ { "name", "completedTasks", "totalTasks", "lastModified", "status": "no-tasks"|"complete"|"in-progress", "nested"?: ["<area>/<name>", ...] } ], "warnings"?: [ { "code", "name", "nested", "message" } ], "root": RootOutput }` — note the per-change `status` is a string enum here. `--specs`: `{ "specs": [ { "id", "requirementCount" } ], "root" }`.
`warnings` (omitted when empty) reports directories under `changes/` that are not changes. Today the only code is `nested_change_directory`: a namespace folder wrapping change directories, which OpenSpec cannot address because a change is always a directory directly under `changes/`. The same entry carries `nested` on the listed change, whose `status` is then meaningless. Do not treat such an entry as a change; report the message and leave the directories alone.
### 4.2 `show <item> --json`
Change: `{ "id", "title", "deltaCount", "deltas": [...], "root" }`. Spec: `{ "id", "title", "overview", "requirementCount", "requirements": [...], "metadata": { "version", "format", "sourcePath"? }, "root" }`.
@@ -110,7 +112,7 @@ setup/register: `{ "store": {id, root, metadata_path?}, "registry": {path, regis
`invalid_store_id`, `invalid_store_registry`, `invalid_store_metadata`, `store_registry_busy`, `store_not_found`, `no_store_registry`, `store_registry_changed`, `store_metadata_missing`, `store_metadata_id_mismatch`, `store_metadata_invalid`, `store_id_conflict`, `store_path_conflict`, `store_already_registered` (info).
### Store setup/register/remove
`store_setup_id_required`, `store_setup_path_required`, `store_setup_path_not_directory`, `store_setup_inside_git_repo`, `store_setup_non_empty_directory`, `store_setup_cancelled`, `store_path_required`, `store_path_missing`, `store_path_not_directory`, `store_root_pointer_declared`, `store_register_root_unhealthy`, `store_register_identity_confirmation_required`, `store_register_cancelled`, `store_remote_empty`, `store_remote_requires_hand_edit`, `store_remove_confirmation_required`, `store_remove_cancelled`, `store_remove_path_not_directory`, `store_remove_metadata_missing`, `store_root_missing` (warning in remove, error in doctor), `store_root_not_directory`.
`store_setup_id_required`, `store_setup_path_required`, `store_setup_path_not_directory`, `store_setup_inside_git_repo`, `store_setup_non_empty_directory`, `store_setup_cancelled`, `store_path_required`, `store_path_missing`, `store_path_not_directory`, `store_root_pointer_declared`, `store_register_root_unhealthy`, `store_register_identity_confirmation_required`, `store_register_cancelled`, `store_remote_empty`, `store_remote_requires_hand_edit`, `store_remove_confirmation_required`, `store_remove_cancelled`, `store_remove_path_not_directory`, `store_remove_metadata_missing`, `store_remove_contains_registered_store`, `store_root_missing` (warning in remove, error in doctor), `store_root_not_directory`.
### Store git
`store_git_init_failed`, `store_git_identity_missing`, `store_git_commit_failed`, `store_git_no_commits` (warning), `store_clone_fragile_directories` (warning), `store_remote_divergence` (info, doctor), `store_checkout_drift` (info, doctor).
+19 -6
View File
@@ -78,7 +78,7 @@ AI: Created openspec/changes/add-dark-mode/
### `/opsx:explore`
> **Start here when you're unsure.** Explore is a no-stakes thinking partner: it reads your codebase, compares options, and sharpens a fuzzy idea into a concrete plan before any change exists. It ships in the default profile. For the full case and more examples, see the [Explore First](explore.md) guide.
> **Start here when you're unsure.** Explore is a no-stakes thinking partner: it reads your codebase, compares options, and sharpens a fuzzy idea into a concrete plan before any code gets written. It ships in the default profile. For the full case and more examples, see the [Explore First](explore.md) guide.
Think through ideas, investigate problems, and clarify requirements before committing to a change.
@@ -97,6 +97,7 @@ Think through ideas, investigate problems, and clarify requirements before commi
- Investigates the codebase to answer questions
- Compares options and approaches
- Creates visual diagrams to clarify thinking
- Captures the exploration when you ask, or when you say yes to its offer: scaffolds a change with `openspec new change` and writes the planning artifacts you name, or updates an existing change's artifacts
- Can transition to `/opsx:propose` (default) or `/opsx:new` (expanded workflow) when insights crystallize
**Example:**
@@ -119,14 +120,20 @@ AI: Let me investigate your current auth setup...
Your API already has CORS configured. Which direction interests you?
You: Let's go with JWT. Can we start a change for that?
You: Let's go with JWT.
AI: Ready when you are. Run /opsx:propose add-jwt-auth to begin.
AI: That's a decision worth keeping. Want me to start a change called
add-jwt-auth? Just the change folder, nothing else yet.
You: Yes.
AI: Started openspec/changes/add-jwt-auth/. Say the word and I'll
write the proposal, specs, and tasks from what we just worked out.
```
**Tips:**
- Use when requirements are unclear or you need to investigate
- No artifacts are created during exploration
- It never writes code, and writes nothing else unless you ask, or say yes when it offers
- Good for comparing multiple approaches before deciding
- Can read files and search the codebase
@@ -345,7 +352,13 @@ Revise a change's existing planning artifacts and keep them coherent with one an
- Applies your requested revision, or reviews the artifacts for contradictions if you didn't name one
- Reconciles the other existing artifacts in any direction (a design edit may ripple back to the proposal)
- Confirms every edit with you before writing, one artifact at a time
- Ends by recommending the next step: `/opsx:continue` (artifacts missing), `/opsx:apply` (carry a revised plan into code), or `/opsx:archive` (all done)
- Ends by recommending the next step: `/opsx:continue` (unstarted artifacts), `/opsx:apply` (carry a revised plan into code), or `/opsx:archive` (all done)
**Missing files:**
- For a glob artifact such as `specs/**/*.md` with at least one existing file, update can propose a missing companion file. It uses the schema's instructions and asks you to confirm the concrete path before creating it.
- Artifacts with no files yet remain with `/opsx:continue`. Intentionally skipped artifacts stay untouched.
- New files must stay inside the change directory. If a file appears at the confirmed path before creation, update stops instead of overwriting it.
**Example:**
@@ -366,7 +379,7 @@ AI: Reading add-dark-mode artifacts...
**Tips:**
- It won't create missing artifacts - that's `/opsx:continue`
- It won't start an artifact with no existing files. Enable `/opsx:continue` for that, or use `openspec status` and `openspec instructions` if that optional workflow isn't installed.
- If the change was already implemented, follow up with `/opsx:apply` so the code matches the revised plan
- If your revision changes the *intent* of the change, start fresh with a new change instead (see [When to Update vs. Start Fresh](opsx.md#when-to-update-vs-start-fresh))
+2 -1
View File
@@ -6,7 +6,8 @@ Listed projects are maintained independently. Inclusion does not imply official
## Projects and resources
- **[OpenSpec UI](https://github.com/VeryComplexAndLongName/OpenSpec-UI)**: A standalone web dashboard and VS Code extension for browsing OpenSpec changes, archives, specs, and tasks.
- **[OpenSpec Workbench](https://github.com/VeryComplexAndLongName/OpenSpec-UI)**: Running and supervising agents on OpenSpec changes.
- **[openspec-guard](https://github.com/guillaume-flambard/spec-guard)**: CLI and GitHub Action that reports which OpenSpec scenarios are covered by a Vitest or Jest test, without running the tests.
## Add your project
+2
View File
@@ -341,6 +341,8 @@ Tasks are the **implementation checklist** — concrete steps with checkboxes.
- Group related tasks under headings
- Use hierarchical numbering (1.1, 1.2, etc.)
- Keep tasks small enough to complete in one session
- State how each task is verified (a test, command, or observable result)
- Land the tests and documentation each group's work calls for inside that group, not in a final catch-up group
- Check tasks off as you complete them
## Delta Specs
+1 -1
View File
@@ -68,7 +68,7 @@ Tip: for a fix, a good scenario is the regression test in prose. "GIVEN a logged
**When to use it:** you have a problem but not yet a plan. You're not sure what to build, or which approach is right.
Start with `/opsx:explore`. It's a thinking partner with no structure and no artifacts created. It reads your codebase and helps you decide.
Start with `/opsx:explore`. It's a thinking partner with no structure. It never writes code, and writes nothing else unless you ask it to capture what you decided, or say yes when it offers. It reads your codebase and helps you decide.
```text
You: /opsx:explore
+12 -6
View File
@@ -1,6 +1,6 @@
# Explore First
**`/opsx:explore` is your thinking partner. Reach for it whenever you have a problem but not yet a plan.** It investigates your codebase, weighs options with you, and clarifies what you actually want, all before a single artifact or line of code is created. When the picture is clear, it hands off to `/opsx:propose`.
**`/opsx:explore` is your thinking partner. Reach for it whenever you have a problem but not yet a plan.** It investigates your codebase, weighs options with you, and clarifies what you actually want, all before a line of code is written. When the picture is clear, it hands off to `/opsx:propose`.
If you take one habit from these docs, take this one: **when you're not sure, explore before you propose.**
@@ -27,14 +27,16 @@ Explore is a **conversation**, not a generator.
- Compare options and name the tradeoffs of each.
- Draw diagrams to make a design legible.
- Help you narrow a vague idea into a concrete, buildable scope.
- Capture the exploration when you ask, or when you accept its offer: it scaffolds the change with `openspec new change` and writes the planning artifacts you named, or updates an existing change's artifacts.
- Transition to `/opsx:propose` when you're ready.
**It does not:**
- Create a change folder.
- Write any artifacts (no proposal, specs, design, or tasks).
- Write or modify code.
- Write or modify code. Explore never writes code, on any path, capture included.
- Design or edit your schemas or templates. Shaping those is a change, not thinking.
- Start a change or write an artifact on its own. It writes nothing unless you ask, or say yes when it offers, and then only what you agreed to, plus the setup files starting a change needs (see below).
- Push you toward capturing. It offers when the thinking crystallizes; you decide.
That's the point. Exploring costs you nothing and commits you to nothing. You can explore three dead ends, learn something from each, and only then propose the path that survived.
That's the point. Exploring costs you nothing and commits you to nothing until you say so. You can explore three dead ends, learn something from each, and only then propose the path that survived.
## It's already installed
@@ -95,6 +97,10 @@ explore ──► propose ──► apply ──► archive
You can say it in plain language ("let's turn this into a change") or run `/opsx:propose <name>` directly. Either way, the exploration you just did becomes the foundation of the proposal, not throwaway chat.
You can also ask explore to capture the change itself, without leaving the conversation: "start a change for this" scaffolds the folder, and "write the proposal too" writes exactly the artifacts you named. Scaffolding also lays down the change's own metadata, and fills in anything your project is missing at the top level (`openspec/specs/`, `openspec/changes/archive/`, a `config.yaml`).
That's the same destination as handing off, with one difference: propose writes the whole set your schema requires to reach implementation, while capture writes only the artifacts you named.
If you use the expanded command set, explore can hand off to `/opsx:new` instead, for step-by-step artifact creation. See [Workflows](workflows.md).
## Tips for a good exploration
@@ -107,7 +113,7 @@ If you use the expanded command set, explore can hand off to `/opsx:new` instead
## The honest tradeoffs
**What you gain:** explore catches wrong turns at the cheapest possible moment, before any artifact exists. It's especially powerful in unfamiliar code, where the AI's ability to read and summarize the system saves you an afternoon of spelunking.
**What you gain:** explore catches wrong turns at the cheapest possible moment, before you've committed to anything. It's especially powerful in unfamiliar code, where the AI's ability to read and summarize the system saves you an afternoon of spelunking.
**What it costs:** a little patience. Explore is a conversation, so it's slower than firing off `/opsx:propose` and hoping. For work you genuinely understand already, that extra step is pure overhead, and you should skip it.
+1 -1
View File
@@ -50,7 +50,7 @@ Both are files OpenSpec writes so your assistant can run the workflow. Skills (`
### Where should I start if I'm not sure what to build?
With `/opsx:explore`. It's a no-stakes thinking partner that reads your codebase, lays out options, and turns a fuzzy problem into a concrete plan, all before any change or code exists. It's in the default profile, so it's always available. When the plan is clear, it hands off to `/opsx:propose`. This is the single best habit to form, because it stops an eager AI from confidently building the wrong thing. See [Explore First](explore.md).
With `/opsx:explore`. It's a no-stakes thinking partner that reads your codebase, lays out options, and turns a fuzzy problem into a concrete plan, all before any code gets written. It's in the default profile, so it's always available. When the plan is clear, it hands off to `/opsx:propose`. This is the single best habit to form, because it stops an eager AI from confidently building the wrong thing. See [Explore First](explore.md).
### What's the simplest possible flow?
+1 -1
View File
@@ -26,7 +26,7 @@ Two terminal steps to set up, then you live in chat. The rest of this guide unpa
**Don't want to do the terminal part yourself?** Paste the [setup prompt](installation.md#install-with-your-ai-assistant) into your assistant and it handles both lines, then reports what it created.
> **Not sure what to build yet? Start with `/opsx:explore`.** It's a no-stakes thinking partner that reads your codebase, weighs options, and sharpens a fuzzy idea into a concrete plan, all before any artifact or code exists. When the picture is clear, it hands off to `/opsx:propose`. This is the single best habit for working with an AI that will otherwise confidently build the wrong thing. See the [Explore guide](explore.md).
> **Not sure what to build yet? Start with `/opsx:explore`.** It's a no-stakes thinking partner that reads your codebase, weighs options, and sharpens a fuzzy idea into a concrete plan, all before any code gets written. When the picture is clear, it hands off to `/opsx:propose`. This is the single best habit for working with an AI that will otherwise confidently build the wrong thing. See the [Explore guide](explore.md).
## How It Works
+1 -1
View File
@@ -46,7 +46,7 @@ Terms are grouped by topic, then alphabetized within each group.
**Slash command.** A command you type into your AI assistant's chat, like `/opsx:propose`. Slash commands drive the workflow. They are not terminal commands. See [How Commands Work](how-commands-work.md).
**Explore (`/opsx:explore`).** The thinking-partner command. It reads your codebase, compares options, and clarifies a fuzzy idea into a concrete plan, creating no artifacts and writing no code. The recommended starting point whenever you have a problem but not yet a plan. See [Explore First](explore.md).
**Explore (`/opsx:explore`).** The thinking-partner command. It reads your codebase, compares options, and clarifies a fuzzy idea into a concrete plan. It never writes code, and writes nothing else unless you ask it to capture the exploration as a change, or say yes when it offers. The recommended starting point whenever you have a problem but not yet a plan. See [Explore First](explore.md).
**CLI.** The `openspec` program you run in your terminal. It sets up projects, lists and validates changes, opens the dashboard, and archives. The terminal half of OpenSpec. See [CLI](cli.md).
+3 -1
View File
@@ -213,7 +213,9 @@ Works through tasks, checking them off as you go. If you're juggling multiple ch
```
/opsx:update add-dark-mode - we're storing the theme in a cookie now
```
Revises the change's existing planning artifacts and keeps them coherent - in any direction (a design edit may ripple back to the proposal). Planning artifacts only: it never edits code, and it never creates missing artifacts (that's `/opsx:continue`). Every edit is confirmed with you first. If the change was already implemented, it recommends `/opsx:apply` so the code catches up with the revised plan. If your revision changes the change's *intent*, start fresh instead - see [When to Update vs. Start Fresh](#when-to-update-vs-start-fresh).
Revises the change's existing planning artifacts and keeps them coherent in any direction (a design edit may ripple back to the proposal). It never edits code. Every edit is confirmed with you first. See [the update reference](commands.md#opsxupdate) for how it handles missing files without starting a new artifact.
If the change was already implemented, it recommends `/opsx:apply` so the code catches up with the revised plan. If your revision changes the change's *intent*, start fresh instead. See [When to Update vs. Start Fresh](#when-to-update-vs-start-fresh).
### Sync delta specs
```text
+1 -1
View File
@@ -56,7 +56,7 @@ In the default setup, your day looks like this. Optionally think it through firs
/opsx:archive → specs updated, change archived
```
**When in doubt, start by exploring.** `/opsx:explore` is a no-stakes thinking partner: it reads your code, lays out options, and turns a fuzzy idea into a concrete plan before any artifact exists. It's the best antidote to an AI that will otherwise build *something* from a vague prompt. Already know exactly what you want? Skip straight to `/opsx:propose`. Either way, explore ships in the default profile, so it's always there. See the [Explore guide](explore.md).
**When in doubt, start by exploring.** `/opsx:explore` is a no-stakes thinking partner: it reads your code, lays out options, and turns a fuzzy idea into a concrete plan before any code gets written. It's the best antidote to an AI that will otherwise build *something* from a vague prompt. Already know exactly what you want? Skip straight to `/opsx:propose`. Either way, explore ships in the default profile, so it's always there. See the [Explore guide](explore.md).
Those are slash commands, typed in your AI assistant's chat. Setup (`openspec init`) happens in your terminal. If that split is new to you, read [How Commands Work](how-commands-work.md) first; it's the most common point of confusion.
+1 -1
View File
@@ -86,7 +86,7 @@ to read the hint.
| Hermes Agent (`hermes`) | `.hermes/skills/openspec-*/SKILL.md`\*\*\* | Not generated (no command adapter; use skill-based `/openspec-*` invocations) |
| iFlow (`iflow`) | `.iflow/skills/openspec-*/SKILL.md` | `.iflow/commands/opsx-<id>.md` |
| Junie (`junie`) | `.junie/skills/openspec-*/SKILL.md` | `.junie/commands/opsx-<id>.md` |
| Kilo Code (`kilocode`) | `.kilocode/skills/openspec-*/SKILL.md` | `.kilocode/workflows/opsx-<id>.md` |
| Kilo Code (`kilocode`) | `.kilocode/skills/openspec-*/SKILL.md` | `.kilo/command/opsx-<id>.md` |
| Kimi Code (`kimi`) | `.kimi-code/skills/openspec-*/SKILL.md` | Not generated (no command adapter; use skill-based `/skill:openspec-*` invocations) |
| Kiro (`kiro`) | `.kiro/skills/openspec-*/SKILL.md` | `.kiro/prompts/opsx-<id>.prompt.md` |
| Lingma (`lingma`) | `.lingma/skills/openspec-*/SKILL.md` | `.lingma/commands/opsx/<id>.md` |
+2 -2
View File
@@ -140,7 +140,7 @@ You: Yes.
You: /opsx:propose rebuild-search-index-on-write
```
Explore creates no artifacts and writes no code. It's a free, no-stakes conversation that turns a vague worry into a precise change, so the proposal that follows is sharp. Already know exactly what you want? Skip it and go straight to `/opsx:propose`. Full guide: [Explore First](explore.md).
Explore never writes code, and writes nothing else unless you ask, or say yes when it offers. It's a free, no-stakes conversation that turns a vague worry into a precise change, so the proposal that follows is sharp. Already know exactly what you want? Skip it and go straight to `/opsx:propose`. Full guide: [Explore First](explore.md).
### Expanded/Full Workflow (custom selection)
@@ -493,7 +493,7 @@ AI: Let me investigate your current setup and options...
Your current stack suggests #1 or #2. What's your scale?
```
Exploration clarifies thinking before you create artifacts.
Exploration clarifies thinking before any code gets written.
### Verify Before Archiving
+17 -1
View File
@@ -52,10 +52,11 @@
inherit (finalAttrs) pname version src;
pnpm = pkgs.pnpm_10;
fetcherVersion = 3;
hash = "sha256-hET2NApPPSep8v59HcVGk3jfWLssaBnQisJF0Gx7ZE8=";
hash = "sha256-ifgjl6/g7wpvcF4Ly/p+rxUbNEKiXF2u69CmpUM0olg=";
};
nativeBuildInputs = with pkgs; [
installShellFiles
nodejs_22
npmHooks.npmInstallHook
pnpmConfigHook
@@ -72,6 +73,21 @@
dontNpmPrune = true;
# `openspec completion generate` renders a static command registry, so it
# needs no project and no network. Opting out of telemetry also disables
# the update check, keeping the build offline.
postInstall = lib.optionalString (pkgs.stdenv.buildPlatform.canExecute pkgs.stdenv.hostPlatform) ''
export OPENSPEC_TELEMETRY=0
completions=$(mktemp -d)
for shell in bash fish zsh; do
$out/bin/openspec completion generate "$shell" > "$completions/openspec.$shell"
done
installShellCompletion --cmd openspec \
--bash "$completions/openspec.bash" \
--fish "$completions/openspec.fish" \
--zsh "$completions/openspec.zsh"
'';
meta = with pkgs.lib; {
description = "AI-native system for spec-driven development";
homepage = "https://github.com/Fission-AI/OpenSpec";
@@ -0,0 +1,2 @@
schema: spec-driven
created: 2026-09-04
@@ -0,0 +1,44 @@
# Name the command that resumes a change
## Why
`openspec status` reported where a change stood and stopped there. The command
that moves it forward was already computed: `buildNextSteps` derives it and
`--json` publishes it as `nextSteps`. But the text surface never rendered it.
So the surface a person actually reads ended on a checklist. `openspec new
change` hands off with `Next: openspec status --change <name>`, and that next
command then had no verb of its own. Picking a change back up after a lost
session, or opening one somebody else started, meant already knowing which
command came next (#906).
The completion case was the worst of it. Once every planning artifact existed,
status printed a lone green "All planning artifacts complete!", which reads as
*you are done* even while `tasks.md` sits half-checked. That is what #906
reports: every artifact showed `done` rather than `ready`, so the conclusion was
that nothing was left to run.
## What Changes
- `openspec status` ends with a `Next:` line naming one command: the next ready
artifact's `openspec instructions` call while planning is unfinished, and
`openspec instructions apply` once every planning artifact exists.
- The line carries `--store <id>` whenever the resolved root is a store. A
command without the flag would resolve against the pointer repo instead of the
store the status was read from.
- `--all` gives every change in the sweep its own line, and gives none to an
entry that failed to load, since a failed entry has no artifact statuses to reason
about.
- The line is built from the same resolution as the JSON `nextSteps` sentence,
so the two surfaces cannot name different commands. `nextSteps` itself is
unchanged, character for character.
No new command, no new flag, no new JSON field. This renders a value the agent
contract already publishes.
## Impact
- Affected specs: `cli-artifact-workflow` (MODIFIED: Next Artifact Discovery)
- Affected code: `src/commands/workflow/status.ts`,
`src/core/change-status-policy.ts`
- Affected docs: `docs/cli.md` (the status text output example)
@@ -0,0 +1,37 @@
## MODIFIED Requirements
### Requirement: Next Artifact Discovery
The workflow SHALL use `openspec status` output to determine what can be created next, rather than a separate next-command surface.
#### Scenario: Discover next artifacts from status output
- **WHEN** a user needs to know which artifact to create next
- **THEN** `openspec status --change <id>` identifies ready artifacts with `[ ]`
- **AND** the first `[ ]` entry is the schema's recommended next artifact
- **AND** no dedicated "next command" is required to continue the workflow
#### Scenario: Status names the command that moves the change forward
- **WHEN** a user runs `openspec status --change <id>` in text mode and a next step resolves
- **THEN** the output ends with a `Next:` line naming exactly one command to run
- **AND** that command is `openspec instructions <artifact> --change "<id>" --json` for the first ready artifact while any planning artifact is still ready
- **AND** it is `openspec instructions apply --change "<id>" --json` once every planning artifact exists, printed after the completion line rather than in place of it, because that line alone reads as "you are done" while implementation tasks remain
- **AND** the named artifact is never one the change skipped, which satisfies its dependents but must not be created
- **AND** the artifact id comes from the resolved schema, so a project whose schema declares neither of the default artifact names still gets a usable command
#### Scenario: The named command carries the store selection
- **WHEN** the resolved root is a store
- **THEN** the `Next:` command includes `--store <id>`, so it resolves against the same root the status was read from rather than the pointer repo
#### Scenario: Both surfaces name the same command
- **WHEN** a next step resolves
- **THEN** the command printed on the `Next:` line and the command inside the JSON `nextSteps` sentence are derived from one resolution, so the two surfaces cannot name different commands
- **AND** the `Next:` line never appears in `--json` output, which stays parseable
#### Scenario: No next step resolves
- **WHEN** no artifact is ready and planning is not complete, or a change in an `--all` sweep failed to load
- **THEN** no `Next:` line is printed for it, rather than a guessed or shared command
@@ -0,0 +1,17 @@
# Tasks
## 1. Resolve the next step once
- [x] 1.1 Extract `resolveNextStep` returning the command and the sentence, leaving `buildNextSteps` returning exactly that sentence so the JSON contract is unchanged
- [x] 1.2 Pin the published sentences verbatim in a unit test, so splitting command from sentence cannot reword the contract
## 2. Render it on the text surface
- [x] 2.1 Print a `Next:` line from the resolved command, after the completion line rather than in place of it
- [x] 2.2 Thread the store selection into the renderer so the command carries `--store`
- [x] 2.3 Give every change in an `--all` sweep its own line, and a failed entry none
## 3. Cover the behavior
- [x] 3.1 Assert the ready, planning-complete, skipped, and custom-schema cases end to end
- [x] 3.2 Assert the printed command appears verbatim inside the JSON sentence, and that the line never leaks into `--json`
## 4. Record it
- [x] 4.1 Update the `cli-artifact-workflow` spec delta and the `docs/cli.md` status output example
@@ -105,6 +105,12 @@ Review feedback flagged that "update" alone is generic — could it apply to any
### 6. Next-step guidance, especially for already-implemented changes
A change can be revised after it was built — tasks checked off, `/opsx:apply` already run. The update itself behaves identically (planning artifacts only), but stopping silently would strand the user: the code and the revised plan now disagree. So the skill ends by reporting where the change stands (from the status JSON and the tasks checklist) and recommending the next command — `/opsx:continue` if artifacts are missing, `/opsx:apply` to carry a revised plan into code, `/opsx:archive` when everything is done. Guidance only: the skill never implements, mirroring the "All artifacts created! You can now implement this change with `/opsx:apply`" hand-off that `continue-change.ts` already uses.
### 7. Companion-file correction (#1733)
The original glob-file deferral was unreachable: one matching file marks an artifact `done`, while continue selects only `ready` artifacts. Update can therefore propose a missing companion file within an already populated glob. This corrects the unarchived spec's former blanket deferral without changing the graph's completion rule or starting another artifact.
The exception uses existing status and instructions output, requires current dependency context and user confirmation, and preserves the change-only planning scope. Immediately before creation, it rechecks scope and the concrete path and uses an operation that refuses an existing target. Delegated creators must obey the same limits. No new CLI command, metadata, graph state, or automatic artifact writer is introduced.
## Risks / Trade-offs
- **No deterministic staleness signal.** With no digest/ledger, the skill relies on the agent reading the artifacts to spot incoherence. Trade-off accepted: an agent that rewrites prose must read it anyway, and a content-blind signal earns its cost only for use cases this change excludes (Decision 3).
@@ -19,7 +19,7 @@ The system SHALL provide a `/opsx:update` workflow skill that revises a change's
#### Scenario: Missing artifacts are deferred to continue
- **WHEN** keeping the change coherent would require an artifact that has not been created yet
- **WHEN** keeping the change coherent would require an artifact with no existing output files and status `ready` or `blocked`
- **THEN** the skill revises only the artifacts that currently exist
- **AND** it notes the not-yet-created artifacts and points the user to `/opsx:continue` to create them
@@ -53,7 +53,7 @@ The `/opsx:update` skill SHALL learn which artifacts exist and where they live b
#### Scenario: Resolve artifact paths cross-platform
- **WHEN** the skill reads or writes an artifact on macOS, Linux, or Windows
- **WHEN** the skill reads or revises an existing artifact file on macOS, Linux, or Windows
- **THEN** it uses the `existingOutputPaths` provided by the CLI status output
- **AND** it does not assume forward-slash separators
@@ -63,11 +63,30 @@ The `/opsx:update` skill SHALL learn which artifacts exist and where they live b
- **THEN** the skill edits the concrete files reported in that artifact's `existingOutputPaths`
- **AND** it does not write to `resolvedOutputPath`, which for a glob artifact remains the glob pattern rather than a real file
#### Scenario: A new file under a glob artifact is deferred to continue
#### Scenario: A missing companion file under a populated glob artifact
- **WHEN** keeping the change coherent would require a new file under a glob artifact that does not exist yet (for example a spec for a not-yet-captured capability)
- **THEN** the skill revises only the files already present in `existingOutputPaths`
- **AND** it points the user to `/opsx:continue`/`/opsx:propose` to create the new file rather than inventing a path from the glob
- **WHEN** reconciliation identifies a missing companion file for a glob artifact with non-empty `existingOutputPaths`
- **THEN** the skill MAY propose creating that file using the artifact's instructions, template, project context, rules, and current dependency files
- **AND** it selects an unused concrete path matching the artifact's `outputPath` inside `changeRoot`, including after resolving linked parent directories
- **AND** it creates the file only after user confirmation, refreshing status, instructions, and path checks immediately before creation
- **AND** creation SHALL fail rather than overwrite a file that appeared in the meantime
- **AND** it SHALL NOT start another artifact, write main specs, or edit implementation code
#### Scenario: Required inputs are no longer available
- **WHEN** a populated glob artifact remains `done` but a required non-skipped dependency is missing
- **THEN** the skill SHALL stop new companion creation and ask the user to restore the dependency first
#### Scenario: Schema delegates companion creation
- **WHEN** the artifact instruction delegates creation to another skill or command
- **THEN** the skill SHALL invoke it only if it can honor the confirmed concrete path and the update guardrails
- **AND** otherwise it SHALL stop rather than invoke broader generation
#### Scenario: Intentionally skipped artifact
- **WHEN** status or instructions mark an artifact as skipped
- **THEN** the skill SHALL leave it untouched and SHALL NOT treat its empty outputs as missing or send it to continue
### Requirement: Bidirectional Coherence Review
@@ -109,7 +128,7 @@ After applying confirmed revisions (or finding none needed), the `/opsx:update`
#### Scenario: Next step when artifacts are incomplete
- **WHEN** the update finishes and the change still has not-yet-created artifacts
- **WHEN** the update finishes and the change still has artifacts with no outputs and status `ready` or `blocked`
- **THEN** the skill recommends `/opsx:continue` to create them
#### Scenario: Next step when the change is fully done
@@ -0,0 +1,2 @@
schema: spec-driven
created: 2026-09-02
@@ -0,0 +1,28 @@
# Release archive claims on Windows
## Why
`openspec archive` creates `.openspec-archive.lock` before moving a change into
the archive. On Windows, a successful archive can leave that lock behind because
the cleanup check compares the device id returned by the open file handle with
the one returned by `fs.lstat()`. Node reports a real device id from the handle
and `0n` from the path stat on the affected Windows/NTFS setup, so the ownership
check never passes.
The archive itself succeeds, but the next archive is blocked by the stale claim
and the user has to delete `.openspec-archive.lock` by hand.
## What Changes
- Treat an inode match plus matching claim contents as sufficient when either
side reports `dev: 0n`, while still requiring the two path stats around the
read to match.
- Keep the existing protection against deleting a claim that was replaced by
another process.
- Add a regression test that simulates the Windows path-stat device id behavior.
## Impact
- Affected spec: `cli-archive`
- Affected code: `src/core/archive.ts`
- Affected tests: `test/core/archive.test.ts`
@@ -0,0 +1,36 @@
## MODIFIED Requirements
### Requirement: Archive Process
The archive operation SHALL follow a structured process to safely move changes to the archive.
#### Scenario: Performing archive
- **WHEN** archiving a change
- **THEN** execute these steps:
1. Create archive/ directory if it doesn't exist
2. Generate target name as `YYYY-MM-DD-[change-name]` using current date, keeping the name as-is when it already starts with a `YYYY-MM-DD-` prefix
3. Claim the target and verify that it does not already exist
4. Prepare and validate spec updates from the active change's delta specs
5. Apply the spec updates as a rollback-capable transaction
6. Move the entire change directory to the archive location
7. If a spec mutation or final move fails before a complete archive is secured, restore the spec transaction and leave or return the change at its active path
8. If a verified fallback copy completes but staged-source cleanup fails, retain the complete archive and committed spec state for recovery instead of risking the only complete copy
#### Scenario: Archive already exists
- **WHEN** target archive already exists
- **THEN** fail with error message
- **AND** do not overwrite existing archive
#### Scenario: Successful archive
- **WHEN** move succeeds
- **THEN** display success message with archived name and list of updated specs
#### Scenario: Successful archive releases its own claim
- **WHEN** an archive run successfully moves a change to its archive destination
- **THEN** remove the temporary archive claim it created
- **AND** do so on supported platforms even when a path stat does not report a device id
- **AND** never remove a claim whose path identity or contents changed before cleanup
@@ -0,0 +1,12 @@
# Tasks
## 1. Release owned claims cross-platform
- [x] 1.1 Compare archive claim files by inode and tolerate a missing device id from either stat result
- [x] 1.2 Preserve the content and repeated-path-stat checks before unlinking
## 2. Verify behavior
- [x] 2.1 Add regression coverage for the Windows `dev: 0n` path-stat case
- [x] 2.2 Run the focused archive regression test
## 3. Record behavior
- [x] 3.1 Add a `cli-archive` spec delta for successful claim cleanup
@@ -0,0 +1,2 @@
schema: spec-driven
created: 2026-09-28
@@ -0,0 +1,90 @@
## Context
See `proposal.md` for motivation and `specs/custom-openspec-directory/spec.md` for the user contract.
The current root model has one overloaded path. `ResolvedOpenSpecRoot.path` names a repository or store root, while most consumers reconstruct its data directory with `path.join(root.path, 'openspec', ...)`. `init` and `update` use that same path for both planning files and project-local agent integrations. Stores work because their planning files retain the conventional `<store root>/openspec` layout; relocating only a normal project's planning directory exposes the missing distinction.
The implementation also contains command-local path construction and generated instructions that say `<planningHome.root>/openspec/...`. Adding an environment check at one entry point would therefore produce split-brain behavior: some commands would use the custom location while others and the coding agent would continue reading or writing the default one.
## Goals / Non-Goals
**Goals:**
- Represent the workspace and complete OpenSpec directory separately in one canonical root result.
- Give every shipped command and generated workflow the same custom-directory behavior.
- Preserve store validation, identity, precedence, diagnostics, and default project behavior.
- Make selection visible and fail closed before mutations.
**Non-Goals:**
- Configure `specs`, `changes`, `archive`, or `schemas` independently.
- Add a committed root pointer, search descendants for candidate directories, or infer a directory from agent instructions.
- Turn an in-repository custom directory into a registered store or change store metadata.
- Make `OPENSPEC_DIR` a persistent team setting. Teams remain responsible for setting the environment consistently in shells, task runners, and CI.
## Decisions
### 1. Select the complete directory with `OPENSPEC_DIR`
`OPENSPEC_DIR` names the directory that directly contains `config.yaml`, `specs/`, `changes/`, and optional `schemas/`. For example, `OPENSPEC_DIR=ai/openspec` selects `<workspace>/ai/openspec`.
The variable is the bootstrap mechanism because config inside the directory cannot locate itself. A new root-level YAML file was rejected because it replaces one unwanted root entry with another. Recursive discovery was rejected because it becomes ambiguous in monorepos and makes command behavior depend on unrelated descendants. Reusing store registration was rejected because a directory inside one code workspace is not a standalone planning repository and should not acquire store identity or machine-global registration.
### 2. Resolve a workspace-relative path by walking ancestors
`OPENSPEC_DIR` is a relative path within a workspace. Normal commands walk from the start directory toward the filesystem root and select the nearest ancestor where the relative candidate is an existing, qualifying OpenSpec directory. The matching ancestor is therefore the unambiguous workspace root, while the candidate is the OpenSpec directory. A closer ancestor with its own qualifying candidate is a nested workspace and wins for invocations inside it, matching existing nearest-root semantics. This mirrors nearest-root discovery without scanning descendants: `OPENSPEC_DIR=ai/openspec` works from both a workspace root and its subdirectories.
`init [path]` is the creation exception. It resolves the value against the explicit target workspace because the directory does not exist yet. `update [path]` resolves against the explicit target first and requires the result to exist. Unset, empty, and whitespace-only values mean no override so common shell and CI defaults preserve today's behavior. Non-empty absolute values, paths that escape the workspace lexically or after symlink canonicalization, filesystem roots, files, and directories without an OpenSpec config or planning shape fail with typed diagnostics. Existing path identity is canonicalized using the same utilities as store resolution, including symlink and Windows alias handling, before enforcing workspace containment.
Absolute and outside-workspace values are deliberately rejected: they select planning data without identifying the workspace that owns project-local agent files. A standalone planning repository already has an explicit, identity-preserving mechanism in stores. Keeping `OPENSPEC_DIR` workspace-relative makes `root.path` stable and avoids adding a second workspace variable or guessing from Git metadata.
### 3. Make selection explicit and non-ambiguous
An explicit `--store` and a non-empty `OPENSPEC_DIR` are mutually exclusive; supplying both fails before registry or filesystem mutation. Otherwise, a non-empty `OPENSPEC_DIR` is resolved before nearest-root and default-store fallback because setting it is an explicit process-level choice. An invalid non-empty value fails closed instead of silently falling back to another root.
The selected custom directory prints a root banner in human mode. JSON root output adds `openspec_dir` and the source value `environment`; `openspec_dir` is emitted for every resolved source so agents never reconstruct it. Existing `root.path` remains the workspace/store root for compatibility. Generated workflow instruction payloads likewise add `planningHome.openspecDir` while retaining existing fields.
The always-visible provenance addresses the main environment-variable risk: a long-lived shell can otherwise direct writes somewhere unexpected. This follows stores' established banner and machine-readable-root pattern rather than creating an invisible override.
### 4. Separate workspace paths from planning paths
The canonical result will carry at least:
- `path`: the existing workspace or store root contract.
- `openspecDir`: the authoritative complete OpenSpec directory.
- `changesDir`, `specsDir`, and `archiveDir`: derived once from `openspecDir`.
- `source` and optional `storeId`: selection provenance.
For a default project, `openspecDir` is `<workspace>/openspec`. For a store, it is `<store root>/openspec`. For an environment-selected project, `path` is the ancestor that resolved the relative value (or the explicit init/update workspace), while `openspecDir` is the selected directory. Because the environment value must be relative and remain inside that workspace, both paths are defined for every successful resolution.
`init` and `update` continue using the workspace path for `.claude/`, `.codex/`, other project-local tool files, root stubs, detection, and cleanup. Config, OpenSpec-owned instructions, schemas, specs, changes, and archives use `openspecDir`. This distinction is passed explicitly; no consumer derives one path from the other.
### 5. Migrate consumers onto directories, not another helper that hides joins
The root resolver and planning-home adapter derive all OpenSpec subdirectories. Root-scoped command APIs receive the resolved root or the exact directory they need. Project-config and schema APIs gain directory-aware entry points while compatibility wrappers retain default behavior for external callers.
Every shipped command path is included, including `init`, `update`, `config`, `schema`, `templates`, `view`, `doctor`, and deprecated noun-form commands that remain executable. Leaving a cwd-based path in a deprecated command would still let the same invocation read one root and write another.
Generated workflow text must read `root.openspec_dir` or `planningHome.openspecDir`. Literal `openspec/` examples may remain only when they describe the default layout, never when they direct a file operation. Generated snapshots and parity hashes are refreshed from the shared templates.
### 6. Keep store structure and registration unchanged
Registered stores continue requiring their conventional `openspec/` child and identity metadata. `OPENSPEC_DIR` does not customize a store's internal layout, participate in the registry, or weaken health checks. Stores benefit only from the shared explicit `openspecDir` field and from consumers no longer reconstructing their paths.
This keeps #697 independent from project-scoped store discovery and configurable individual artifact paths. It also preserves the stores simplification principle: one root-selection path and one observable root contract.
## Risks / Trade-offs
- **A partially migrated consumer could read or write the default directory.** → Inventory every hardcoded runtime and generated `openspec/` path, add command-parity tests, and make directory derivation a shared dependency-direction invariant.
- **A stale environment variable could redirect writes.** → Emit provenance for every custom-root command, reject invalid values and `--store` conflicts, and document consistent environment use across a workflow.
- **Relative resolution could differ by invocation directory.** → Use nearest-ancestor candidate resolution and cover workspace-root, nested-directory, spaces, Windows separators, and symlink aliases.
- **Separating workspace and planning paths expands the init/update surface.** → Test that planning files move while every project-local tool file remains byte-for-byte at the workspace root.
- **Adding JSON fields can affect strict consumers.** → Keep all existing keys and meanings, document the additive fields, and add agent-contract fixtures. This is a minor feature change, not a key rename.
## Migration Plan
1. Introduce the directory-aware root types and default/store adapters with compatibility tests while behavior is unchanged.
2. Add environment resolution, diagnostics, provenance, and root-selection tests.
3. Move runtime consumers, init/update, and generated workflows onto `openspecDir`, with parity coverage after each group.
4. Document `OPENSPEC_DIR`, add a minor changeset, and run the complete macOS/Linux suite plus Windows CI.
5. Rollback removes environment selection and the additive fields; default projects and stores retain their existing on-disk layouts throughout.
@@ -0,0 +1,34 @@
## Why
OpenSpec can select a standalone store anywhere on disk, but a normal project still has to keep its complete `openspec/` directory at the workspace root. This blocks teams that must place tool-owned content under an existing hierarchy such as `ai/openspec/`, even though the canonical root-selection layer already proves that commands can operate on planning data outside the current directory.
## What Changes
- Add `OPENSPEC_DIR` as an explicit, process-scoped selection of the complete OpenSpec directory.
- Make the canonical root result distinguish the workspace root, where project-local agent integrations live, from the OpenSpec directory, where config, schemas, specs, and changes live.
- Route every shipped CLI command and generated workflow through that canonical directory instead of reconstructing `<root>/openspec` locally.
- Preserve stores as standalone registered planning roots: a store still resolves to `<store root>/openspec`, but it uses the same directory-aware result as a normal or customized project.
- Keep existing root selection, filesystem behavior, and human output unchanged when `OPENSPEC_DIR` is unset or empty; retain every existing JSON field and meaning while adding the authoritative directory field.
- Reject invalid or conflicting custom-directory selection before reading or writing files, with the selected directory visible in human and JSON provenance.
## Capabilities
### New Capabilities
- `custom-openspec-directory`: Environment-based selection, precedence, diagnostics, provenance, and command parity for a relocated complete OpenSpec directory.
### Modified Capabilities
- `cli-init`: Initialize planning files in the selected OpenSpec directory while keeping project-local agent integrations at the requested workspace root.
- `cli-update`: Refresh planning instructions in the selected OpenSpec directory and agent integrations at the workspace root.
- `config-loading`: Load project configuration from the selected OpenSpec directory.
- `schema-resolution`: Resolve project-local schemas from the selected OpenSpec directory.
- `ai-tool-paths`: Keep project-local tool paths anchored to the workspace when planning files are relocated.
## Impact
- Root contract: `ResolvedOpenSpecRoot`, `PlanningHome`, human root banners, and JSON root output gain an authoritative OpenSpec-directory path and environment provenance.
- CLI: `init`, `update`, normal root-scoped commands, config/schema commands, view, doctor, and deprecated-but-shipped command paths must share the same directory resolution.
- Generated content: workflow templates and GitHub Copilot agent files must consume the resolved directory rather than assume `openspec/` beneath the process working directory.
- Tests and docs: cross-platform path, symlink identity, precedence, store parity, JSON, init/update, and generated-content parity coverage; CLI and agent-contract documentation; a minor changeset.
- No new project file, registry format, dependency, directory scan, or `specsPath`-style partial layout is introduced.
@@ -0,0 +1,19 @@
## ADDED Requirements
### Requirement: Planning relocation does not relocate project-local AI tools
Project-local AI tool skills, commands, prompts, workflows, and managed root stubs SHALL remain anchored to the workspace root when `OPENSPEC_DIR` relocates planning data.
#### Scenario: Tool paths remain at workspace root
- **GIVEN** `OPENSPEC_DIR` selects `ai/openspec`
- **WHEN** init or update generates project-local files for a selected AI tool
- **THEN** those files SHALL remain under the tool's documented workspace-relative path
- **AND** they SHALL NOT be generated beneath `ai/`
#### Scenario: Generated instructions use authoritative planning paths
- **GIVEN** planning data is outside the default root-level `openspec/` directory
- **WHEN** an installed OpenSpec workflow directs an agent to read or write a planning artifact
- **THEN** it SHALL obtain and use the authoritative OpenSpec directory reported by the CLI
- **AND** it SHALL NOT infer the planning path from the workspace or process working directory
@@ -0,0 +1,26 @@
## ADDED Requirements
### Requirement: Init separates workspace and planning destinations
`openspec init [path]` SHALL treat its path argument as the workspace root and, when `OPENSPEC_DIR` is set, create the complete OpenSpec structure at the selected directory while keeping workspace-scoped integrations at the workspace root.
#### Scenario: Initialize a custom relative directory
- **GIVEN** the user runs `openspec init .` with `OPENSPEC_DIR=ai/openspec`
- **WHEN** initialization completes
- **THEN** config, specs, changes, archive, and OpenSpec-owned instructions SHALL be created under `ai/openspec`
- **AND** selected project-local AI tool files SHALL be created under the workspace root
- **AND** no default root-level `openspec/` directory SHALL be created
#### Scenario: Custom directory already exists
- **GIVEN** `OPENSPEC_DIR` selects an existing valid OpenSpec directory
- **WHEN** the user runs `openspec init` to add or refresh tools
- **THEN** init SHALL enter its existing extend behavior for that directory
- **AND** it SHALL keep project-local tool discovery and generation anchored to the workspace root
#### Scenario: Invalid custom destination
- **GIVEN** `OPENSPEC_DIR` resolves to a file or selects an unsafe filesystem root
- **WHEN** the user runs `openspec init`
- **THEN** init SHALL fail before creating planning or tool files
@@ -0,0 +1,20 @@
## ADDED Requirements
### Requirement: Update separates workspace and planning destinations
`openspec update [path]` SHALL refresh OpenSpec-owned planning instructions in the environment-selected OpenSpec directory while detecting and refreshing project-local AI tool integrations at the workspace root.
#### Scenario: Update a relocated project
- **GIVEN** the workspace uses `OPENSPEC_DIR=ai/openspec`
- **WHEN** the user runs `openspec update .`
- **THEN** OpenSpec-owned files under `ai/openspec` SHALL be refreshed
- **AND** existing project-local tool files under the workspace root SHALL be refreshed
- **AND** update SHALL NOT create or refresh a default root-level `openspec/` directory
#### Scenario: Selected directory is missing
- **GIVEN** `OPENSPEC_DIR` does not resolve to an existing valid OpenSpec directory
- **WHEN** the user runs `openspec update`
- **THEN** update SHALL fail with a diagnostic naming the selected directory
- **AND** it SHALL NOT fall back to the default directory
@@ -0,0 +1,19 @@
## ADDED Requirements
### Requirement: Load project config from the authoritative OpenSpec directory
Project configuration SHALL be loaded from `config.yaml` or `config.yml` inside the authoritative OpenSpec directory returned by root selection.
#### Scenario: Environment-selected config
- **GIVEN** `OPENSPEC_DIR` selects `ai/openspec`
- **AND** `ai/openspec/config.yaml` contains project context, rules, and a schema
- **WHEN** a root-scoped command loads project configuration
- **THEN** it SHALL use `ai/openspec/config.yaml`
- **AND** it SHALL NOT read a config from the default root-level directory
#### Scenario: Store config remains conventional
- **GIVEN** a registered store is selected
- **WHEN** a command loads project configuration
- **THEN** it SHALL continue reading config from the store's authoritative `openspec` directory
@@ -0,0 +1,144 @@
## Purpose
Allow a project to relocate its complete OpenSpec directory without changing the workspace location of coding-agent integrations or adopting store machinery.
## ADDED Requirements
### Requirement: Environment selects the complete OpenSpec directory
OpenSpec SHALL accept `OPENSPEC_DIR` as a workspace-relative path to the complete directory for project config, specs, changes, and optional custom schemas, and SHALL use that directory consistently across every shipped command that reads or writes OpenSpec project data.
For discovery, a custom directory SHALL use the same qualification predicate as nearest-root selection: it qualifies when `specs/` or `changes/` is a planning directory that is not itself a store root, or when `config.yaml` or `config.yml` exists. A config-only directory therefore qualifies for selection, while config parsing and command-specific validation remain responsible for reporting malformed or incomplete content.
#### Scenario: Relative directory from workspace root
- **GIVEN** `OPENSPEC_DIR` is `ai/openspec`
- **AND** `ai/openspec` qualifies under the established nearest-root predicate
- **WHEN** the user runs a root-scoped command from the workspace root
- **THEN** the command SHALL read and write planning data under `ai/openspec`
#### Scenario: Relative directory from a workspace subdirectory
- **GIVEN** `OPENSPEC_DIR` is `ai/openspec`
- **AND** the user is inside a subdirectory of the same workspace
- **AND** no closer ancestor has its own qualifying `ai/openspec` directory
- **WHEN** the user runs a root-scoped command
- **THEN** OpenSpec SHALL resolve the nearest ancestor whose `ai/openspec` qualifies under that predicate
- **AND** the command SHALL use the same planning data as an invocation from the workspace root
#### Scenario: Nested workspace has its own custom directory
- **GIVEN** `OPENSPEC_DIR` is `ai/openspec`
- **AND** both an outer workspace and a nested workspace contain a qualifying `ai/openspec` directory
- **WHEN** the user runs a root-scoped command inside the nested workspace
- **THEN** OpenSpec SHALL treat the nested workspace as a separate workspace
- **AND** it SHALL select the nested workspace's `ai/openspec` directory
#### Scenario: Absolute directory is rejected
- **GIVEN** `OPENSPEC_DIR` is an absolute platform-native path to a valid OpenSpec directory
- **WHEN** the user runs a root-scoped command
- **THEN** the command SHALL fail with guidance to use a workspace-relative path
- **AND** it SHALL explain that standalone planning repositories use stores
#### Scenario: Relative directory escapes the workspace
- **GIVEN** `OPENSPEC_DIR` contains parent traversal that resolves outside the workspace candidate
- **WHEN** the user runs an OpenSpec command
- **THEN** the command SHALL fail before reading or writing project data
#### Scenario: Symlink escapes the workspace
- **GIVEN** `OPENSPEC_DIR` is a relative path whose existing candidate is a symlink
- **AND** the candidate's canonical path is outside the workspace ancestor that resolved it
- **WHEN** the user runs an OpenSpec command
- **THEN** the command SHALL fail before reading or writing project data
#### Scenario: Environment is unset or empty
- **WHEN** `OPENSPEC_DIR` is unset, empty, or whitespace-only
- **THEN** existing project and store root selection SHALL behave as before
#### Scenario: Config-only directory qualifies
- **GIVEN** `OPENSPEC_DIR` resolves to a directory containing `config.yaml` but no `specs/` or `changes/` directory
- **WHEN** OpenSpec performs root selection
- **THEN** it SHALL select that custom directory
- **AND** any config-content error SHALL be reported by the existing config validation path
### Requirement: Custom-directory selection is explicit and fail-closed
OpenSpec SHALL validate an environment-selected directory before a command mutates project data and SHALL NOT silently fall back to another project or store root when explicit custom-directory selection is invalid or conflicts with explicit store selection.
#### Scenario: Directory is missing
- **GIVEN** `OPENSPEC_DIR` names a directory that cannot be resolved
- **WHEN** the user runs a command other than `init`
- **THEN** the command SHALL fail with an actionable custom-directory diagnostic
- **AND** it SHALL NOT read from or write to the default `openspec/` directory
#### Scenario: Path is not a directory
- **GIVEN** `OPENSPEC_DIR` resolves to a file or another non-directory object
- **WHEN** the user runs an OpenSpec command
- **THEN** the command SHALL fail before reading or writing project data
#### Scenario: Explicit store conflicts with environment selection
- **GIVEN** `OPENSPEC_DIR` is set to a non-empty value
- **WHEN** the user also passes `--store <id>`
- **THEN** the command SHALL fail with guidance to choose one root source
- **AND** it SHALL NOT mutate either location
### Requirement: Root provenance exposes the authoritative directory
OpenSpec SHALL make the authoritative OpenSpec directory available to humans and agents so neither has to reconstruct it from the workspace or store root.
#### Scenario: Human command uses custom directory
- **WHEN** a human-mode command resolves `OPENSPEC_DIR`
- **THEN** stderr SHALL identify the selected custom OpenSpec directory before command-specific output
#### Scenario: JSON command reports custom directory
- **WHEN** a JSON command resolves `OPENSPEC_DIR`
- **THEN** its root object SHALL report `source: "environment"`
- **AND** it SHALL report the canonical absolute directory in `openspec_dir`
#### Scenario: Default project or store reports directory
- **WHEN** a JSON command resolves a default project root or registered store
- **THEN** its root object SHALL report the canonical absolute OpenSpec directory in `openspec_dir`
- **AND** existing root fields SHALL retain their meanings
### Requirement: Custom directories work across supported platforms
OpenSpec SHALL resolve custom-directory identity using platform-native path semantics and canonical existing-path identity on macOS, Linux, and Windows.
#### Scenario: Path contains spaces
- **GIVEN** `OPENSPEC_DIR` resolves to a valid directory whose path contains spaces
- **WHEN** the user completes a normal change lifecycle
- **THEN** creation, status, instructions, validation, and archive SHALL all use that directory
#### Scenario: Windows path and alias
- **GIVEN** a Windows path uses supported native separators or an existing filesystem alias
- **WHEN** OpenSpec resolves the custom directory
- **THEN** all commands SHALL agree on one canonical directory identity
- **AND** no command SHALL construct a mixed-separator filesystem path
### Requirement: Store behavior remains isolated
Custom project-directory selection SHALL reuse the canonical root contract without changing registered-store layout, identity, health, or registry behavior.
#### Scenario: Registered store is selected
- **WHEN** the user selects a registered store with `--store <id>` and `OPENSPEC_DIR` is unset or empty
- **THEN** the store SHALL continue using `<store root>/openspec`
- **AND** store identity and health validation SHALL remain unchanged
#### Scenario: Custom project needs no store metadata
- **WHEN** a project selects an in-workspace directory with `OPENSPEC_DIR`
- **THEN** OpenSpec SHALL NOT require store registration or store identity metadata
@@ -0,0 +1,17 @@
## ADDED Requirements
### Requirement: Project-local schemas follow the authoritative OpenSpec directory
Schema discovery and loading SHALL resolve project-local schemas beneath the authoritative OpenSpec directory rather than reconstructing an `openspec/schemas` path from the process working directory or workspace root.
#### Scenario: Environment-selected project schema
- **GIVEN** `OPENSPEC_DIR` selects `ai/openspec`
- **AND** a project-local schema exists under `ai/openspec/schemas/<name>`
- **WHEN** the user lists schemas or creates a change using that schema
- **THEN** schema discovery and schema loading SHALL both use the selected project-local schema
#### Scenario: Default and store schemas retain precedence
- **WHEN** `OPENSPEC_DIR` is unset or empty
- **THEN** project-local, user override, and package schema precedence SHALL remain unchanged for default projects and stores
@@ -0,0 +1,33 @@
## 1. Establish the directory-aware root contract
- [ ] 1.1 Add focused root-selection tests for default projects, stores, unset/empty compatibility, ancestor-resolved and nested-workspace relative `OPENSPEC_DIR` values, rejected absolute, lexical-escape, and symlink-escape values, other invalid values, `--store` conflicts, spaces, and canonical in-workspace alias identity; verify the new cases fail for the missing directory contract.
- [ ] 1.2 Extend the canonical resolved-root and planning-home types with authoritative OpenSpec-directory fields, derive all planning subdirectories once, and verify existing default/store tests remain green.
- [ ] 1.3 Implement environment selection, typed diagnostics, fail-closed precedence, human provenance, and additive JSON root output; verify focused human and JSON tests pass without changing existing field meanings.
- [ ] 1.4 Update `docs/agent-contract.md` and root-selection CLI documentation in the same change, then verify their documented payloads and precedence against the focused tests.
## 2. Move runtime consumers onto the authoritative directory
- [ ] 2.1 Inventory every runtime construction of config, schemas, specs, changes, and archive paths; migrate normal and deprecated-but-shipped commands to the resolved directories and verify command-parity tests cover list, show, validate, status, instructions, new change, archive, doctor, context, schemas, templates, config, view, and noun-form compatibility paths.
- [ ] 2.2 Add directory-aware project-config and schema-resolution APIs with compatibility wrappers for existing callers; verify config loading, rules/context injection, schema listing, schema loading, and custom-schema change creation against a custom directory.
- [ ] 2.3 Update reference, health, discovery, archive, and spec-application consumers to accept authoritative directories; verify a complete create-to-archive lifecycle in a path containing spaces.
- [ ] 2.4 Add a static regression guard for forbidden command-local `<root>/openspec` reconstruction and verify it permits only constants, default-layout descriptions, and store bootstrap code explicitly reviewed by name.
## 3. Separate init/update workspace and planning paths
- [ ] 3.1 Add failing init tests proving `OPENSPEC_DIR` creates the complete planning structure at the selected destination while project-local tool files, detection, cleanup, and managed root stubs stay at the explicit workspace path.
- [ ] 3.2 Implement separate workspace and OpenSpec-directory inputs through init, including extend mode, pointer guards, config creation, anchors, Copilot cloud state, and rollback; verify focused init and cleanup suites pass.
- [ ] 3.3 Add failing update tests for relocated planning instructions, workspace-local tool refresh, missing/invalid custom directories, and absence of default-directory writes.
- [ ] 3.4 Implement the same separation through update and verify focused update, migration, shared-skill, and Copilot cloud suites pass.
- [ ] 3.5 Update `cli-init`, `cli-update`, customization, and troubleshooting documentation with cross-platform examples and consistent-environment guidance; run every documented command in temporary fixtures.
## 4. Make generated workflows directory-aware
- [ ] 4.1 Add generated-content tests proving workflow instructions consume `root.openspec_dir` or `planningHome.openspecDir` for config, specs, changes, schemas, and archive operations under a custom directory.
- [ ] 4.2 Replace operational hardcoded `openspec/` paths in shared workflow templates and GitHub Copilot agent content with authoritative-directory guidance while preserving default-layout examples; regenerate committed skills and parity hashes and verify generated-content equivalence.
- [ ] 4.3 Extend cold-start and capstone agent journeys with a relocated directory and verify the agent creates, reads, validates, syncs, and archives only in the selected location.
## 5. Complete compatibility and release verification
- [ ] 5.1 Add a minor changeset and a migration note; verify unset-environment human output, filesystem effects, and existing JSON keys remain compatible for default projects and stores.
- [ ] 5.2 Run `pnpm run build`, `pnpm exec tsc --noEmit`, `pnpm run lint`, `pnpm test`, strict OpenSpec validation, generated-content parity checks, and `git diff --check`.
- [ ] 5.3 Verify Windows CI covers native separators, rejected drive-qualified absolute paths, spaces, and alias canonicalization before marking the implementation ready to merge.
+46 -1
View File
@@ -53,6 +53,10 @@ The system SHALL compute a valid topological build order for artifacts.
### Requirement: State Detection
The system SHALL detect artifact completion state by scanning the filesystem.
The system SHALL recognize `generates` values containing `*`, `?`, or `[` as glob patterns. It SHALL also support brace alternatives, brace ranges, and the `@()`, `+()`, `!()`, `*()`, and `?()` extglob forms. An artifact with a glob output SHALL be completed when at least one matching file exists.
The system SHALL preserve literal filenames with a bare leading `!`, plain parentheses, or single-element braces when no supported glob syntax is present. Brace expansion SHALL preserve literal brace groups and recognize later and nested expansion groups. Expanded output paths and traversed symbolic links SHALL remain within the change directory.
#### Scenario: Simple file exists
- **WHEN** an artifact generates "proposal.md" and the file exists
- **THEN** the artifact is marked as completed
@@ -73,6 +77,48 @@ The system SHALL detect artifact completion state by scanning the filesystem.
- **WHEN** the change directory does not exist
- **THEN** all artifacts are marked as not completed (empty state)
#### Scenario: Brace alternatives with matching files
- **WHEN** an artifact generates "review-{api,ui}.md" and "review-api.md" exists
- **THEN** the artifact is marked as completed
#### Scenario: Brace range after a literal brace group
- **WHEN** an artifact generates "report-{draft}-{1..3}.md"
- **AND** "report-{draft}-1.md", "report-{draft}-2.md", "report-{draft}-3.md", and "report-{draft}-4.md" exist
- **THEN** its resolved outputs contain exactly the first three files
- **AND** the artifact is marked as completed
#### Scenario: Later and nested brace alternatives
- **WHEN** an artifact generates "report-{draft}-{{api},ui}.md" and "report-{draft}-{api}.md" exists
- **THEN** the artifact is marked as completed
#### Scenario: Extglob alternatives with matching files
- **WHEN** an artifact generates "@(proposal|design).md" or "+(proposal|design).md" and "proposal.md" exists
- **THEN** the artifact is marked as completed
#### Scenario: Negative extglob excludes its alternatives
- **WHEN** an artifact generates "!(proposal|design).md"
- **AND** "proposal.md", "design.md", and "notes.md" exist
- **THEN** its resolved outputs contain only "notes.md"
- **AND** the artifact is marked as completed
#### Scenario: Brace or extglob pattern without matching files
- **WHEN** an artifact generates "review-{api,ui}.md" or "@(proposal|design).md" and no matching files exist
- **THEN** the artifact is not marked as completed
#### Scenario: Literal output names remain literal
- **WHEN** an artifact generates "!review.md", "(proposal|design).md", or "review-{api}.md"
- **THEN** completion depends on the existence of a file with that exact name
#### Scenario: Brace expansion escapes the change directory
- **WHEN** an artifact generates "{safe,../outside}/review.md"
- **THEN** output resolution rejects the expanded path outside the change directory before matching files
- **AND** rejection does not depend on whether the outside file exists
#### Scenario: Expanded directory pattern reaches an outbound symbolic link
- **WHEN** an artifact generates "content/{safe,linked}/review.md" or "content/@(safe|linked)/review.md"
- **AND** "content/linked" is a symbolic link to a directory outside the change directory
- **THEN** output resolution rejects traversal through that link even when no matching files exist
### Requirement: Ready Artifact Query
The system SHALL identify which artifacts are ready to be created based on dependency completion.
@@ -137,4 +183,3 @@ The system SHALL support self-contained schema directories with co-located templ
#### Scenario: List available schemas
- **WHEN** listing schemas
- **THEN** the system returns schema names from both user and package directories
+1 -1
View File
@@ -117,7 +117,7 @@ The update command SHALL refresh existing slash command files for configured too
- **AND** skip creating missing files (the update command only refreshes what already exists)
#### Scenario: Updating slash commands for Kilo Code
- **WHEN** `.kilocode/workflows/` contains `openspec-proposal.md`, `openspec-apply.md`, and `openspec-archive.md`
- **WHEN** `.kilo/command/` contains OpenSpec-managed `opsx-*.md` command files for the configured profile
- **THEN** refresh each file using shared templates wrapped in OpenSpec markers
- **AND** ensure templates include instructions for the relevant workflow stage
- **AND** skip creating missing files (the update command only refreshes what already exists)
+7 -1
View File
@@ -32,6 +32,13 @@ The system SHALL detect legacy OpenSpec artifacts from previous init versions.
- `.windsurf/workflows/openspec-*.md`
- And equivalent directories for all tools in the legacy SlashCommandRegistry
#### Scenario: Detecting legacy Kilo Code workflows
- **WHEN** `.kilocode/workflows/` contains OpenSpec-managed `opsx-*.md` or `openspec-*.md` workflow files
- **THEN** `openspec init` or legacy cleanup SHALL remove those files
- **AND** Kilo Code commands SHALL be generated under `.kilo/command/`
- **AND** `openspec update` SHALL NOT refresh files that remain only under `.kilocode/workflows/`
#### Scenario: Detecting legacy OpenSpec structure files
- **WHEN** running `openspec init` on an existing project
@@ -160,4 +167,3 @@ The system SHALL report what was cleaned up.
- **WHEN** no legacy artifacts are found
- **THEN** the system SHALL NOT display the cleanup section
- **AND** proceed directly with skill setup
+63 -7
View File
@@ -45,27 +45,37 @@ The skill SHALL check artifact completion status using the artifact graph before
### Requirement: Task Completion Check
The skill SHALL check task completion status from tasks.md before archiving.
The skill SHALL check the selected change's task completion using `totalTasks` and `completedTasks` from `openspec list --json`, with the same selected-root flags used for the rest of the workflow. It SHALL match the change by name and use the CLI's schema-aware task resolution in both single and bulk archive workflows.
#### Scenario: Incomplete tasks found
- **WHEN** agent reads tasks.md
- **AND** incomplete tasks are found (marked with `- [ ]`)
- **WHEN** the selected change has `totalTasks` greater than `completedTasks`
- **THEN** display warning showing count of incomplete tasks
- **AND** prompt user for confirmation to continue
- **AND** proceed if user confirms
#### Scenario: All tasks complete
- **WHEN** agent reads tasks.md
- **AND** all tasks are complete (marked with `- [x]`)
- **WHEN** the selected change has equal `totalTasks` and `completedTasks`
- **THEN** proceed without task-related warning
#### Scenario: No tasks file
#### Scenario: No tracked tasks
- **WHEN** tasks.md does not exist
- **WHEN** the CLI reports `totalTasks` as zero for the selected change
- **THEN** proceed without task-related warning
#### Scenario: Custom task artifact or output path
- **WHEN** the schema tracks tasks under a custom artifact name, output path, or glob
- **THEN** use the CLI totals across the schema-resolved files
- **AND** do not infer completion from artifact existence, an artifact id of `tasks`, or the absence of a top-level `tasks.md`
#### Scenario: Task progress lookup unavailable
- **WHEN** the list command fails, returns invalid JSON, omits or duplicates a selected change, or reports invalid task counts
- **THEN** report the lookup problem and stop before syncing or archiving
- **AND** do not treat the missing progress as zero tasks
### Requirement: Spec Sync Prompt
The skill SHALL prompt to sync delta specs before archiving if specs exist.
@@ -82,6 +92,52 @@ The skill SHALL prompt to sync delta specs before archiving if specs exist.
- **AND** stop without archiving if the sync fails or any capability does not verify
- **AND** archive only after verification passes, or when the user explicitly chose to archive without syncing or to archive already-synced specs
#### Scenario: Applicable ADDED delta whose main spec does not exist yet
- **WHEN** agent compares a delta spec against its main spec at `openspec/specs/<capability-path>/spec.md`
- **AND** that main spec does not exist yet
- **AND** the delta has `## ADDED Requirements`
- **AND** the delta has no `## MODIFIED Requirements` or `## RENAMED Requirements`
- **THEN** count that capability as needing sync rather than as already synced
- **AND** name it in the summary as a main spec the sync will create
- **AND** never treat the missing main spec as nothing to apply
- **AND** if the delta also has `## REMOVED Requirements`, warn that they will be ignored because there is no main spec to remove them from
- **AND** create the main spec from only the delta's `## ADDED Requirements`
#### Scenario: Unsupported delta operation whose main spec does not exist yet
- **WHEN** a delta targets a capability whose main spec does not exist yet
- **AND** the delta has `## MODIFIED Requirements` or `## RENAMED Requirements`
- **THEN** report that only ADDED requirements can create a new main spec
- **AND** mark the capability as sync-blocked without writing a main spec
#### Scenario: Explicitly retired capability whose main spec is missing
- **WHEN** a delta contains only `## REMOVED Requirements` and its main spec is missing
- **AND** the change's `.openspec.yaml` declares `retire_capabilities: true`
- **THEN** count that capability as already synced and report that it is already retired
- **AND** warn that there is nothing left to remove and do not recreate the main spec
- **AND** apply the same rule when verifying a completed sync, so retiring a capability does not block archiving
#### Scenario: Nothing to put in a missing main spec without a declared retirement
- **WHEN** a delta targets a capability whose main spec does not exist yet
- **AND** the delta has no `## ADDED Requirements`
- **AND** it is not a REMOVED-only delta with `retire_capabilities: true`
- **THEN** report that no sync is possible
- **AND** if the delta has only `## REMOVED Requirements`, warn that there is no main spec to remove them from and leave the main-spec tree unchanged
- **AND** mark the capability as sync-blocked, since the verification pass would re-read the same missing spec
#### Scenario: Sync-blocked capability during archive assessment
- **WHEN** any capability is sync-blocked during the initial assessment
- **THEN** assess the remaining capabilities and summarize the blockers before prompting
- **AND** offer only "Archive without syncing" and "Cancel"
- **AND** archive without writing main specs only if the user explicitly chooses "Archive without syncing"
- **AND** stop without archiving if the user cancels
- **AND** do not start any sync while a capability is blocked, even if other capabilities could sync
- **AND** a failed sync or post-sync verification still stops without archiving; do not silently fall back to skipping sync
#### Scenario: No delta specs
- **WHEN** agent checks for delta specs
+91 -18
View File
@@ -15,34 +15,51 @@ The system SHALL provide an `/opsx:verify` skill that validates implementation a
#### Scenario: Verify without change name
- **WHEN** agent executes `/opsx:verify` without a change name
- **THEN** the agent infers the change from conversation context, or auto-selects it when only one active change exists
- **AND** when ambiguous, prompts user to select from available changes, showing only changes that have implementation tasks
- **AND** when ambiguous, prompts user to select from all active changes, including changes with no tracked tasks
- **AND** announces which change was selected and how to override
#### Scenario: Change has no tasks
- **WHEN** selected change has no tasks.md or tasks are empty
- **THEN** the agent reports "No tasks to verify"
- **AND** suggests running `/opsx:continue` to create tasks
#### Scenario: Change has no task descriptions
- **WHEN** the schema configures task tracking but the structured task list provides no usable task descriptions, even if task progress reports nonzero totals
- **THEN** the agent reports Task Completion as not verified with the reason
- **AND** continues checks supported by the remaining artifacts
#### Scenario: Schema has no task tracking
- **WHEN** the schema does not configure `apply.tracks`
- **THEN** apply instructions report `taskTrackingConfigured: false`
- **AND** the agent reports Task Completion as not applicable, not as skipped or failed
- **AND** continues the checks that apply to the schema
### Requirement: Completeness Verification
The agent SHALL verify that all required work has been completed.
#### Scenario: Task completion check
- **WHEN** verifying completeness
- **THEN** the agent reads tasks.md
- **AND** counts tasks marked `- [x]` (complete) vs `- [ ]` (incomplete)
- **THEN** the agent uses the top-level `tasks` and `progress` from apply instructions
- **AND** apply instructions aggregate every concrete file matched by the active schema's `apply.tracks`, regardless of the tracked artifact's ID
- **AND** reports complete and total task counts from `progress`
- **AND** reports completion status with specific incomplete tasks listed
- **AND** reports remaining checkboxes without descriptions when `progress.remaining` exceeds the listed incomplete tasks
#### Scenario: Tracking evidence becomes unavailable
- **WHEN** one or more files matched by `apply.tracks` cannot be read after resolution
- **THEN** apply instructions include every unavailable path and reason
- **AND** preserve tasks and progress from readable tracking files
- **AND** do not report `all_done`
- **AND** the agent marks Task Completion as not verified from partial evidence
#### Scenario: Spec coverage check
- **WHEN** verifying completeness
- **AND** delta specs exist in `openspec/changes/<name>/specs/`
- **THEN** the agent extracts all requirements from delta specs
- **AND** searches codebase for implementation of each requirement
- **AND** reports which requirements appear to have implementation vs which are missing
- **THEN** the agent extracts all requirements from delta specs, noting the delta section each one sits under
- **AND** searches codebase for implementation of each ADDED or MODIFIED requirement
- **AND** reports which ADDED or MODIFIED requirements appear to have implementation vs which are missing
- **AND** checks REMOVED and RENAMED requirements as described in the Removed requirement and Renamed requirement scenarios
#### Scenario: All tasks complete
- **WHEN** all tasks are marked complete
- **THEN** report "Tasks: N/N complete"
- **AND** mark completeness dimension as passed
- **AND** mark Task Completion as passed only when task descriptions are available
- **AND** mark the completeness dimension as passed only when all applicable checks ran and passed
#### Scenario: Incomplete tasks found
- **WHEN** some tasks are incomplete
@@ -56,14 +73,14 @@ The agent SHALL verify that implementation matches the specifications.
#### Scenario: Requirement implementation mapping
- **WHEN** verifying correctness
- **THEN** for each requirement in delta specs:
- **THEN** for each ADDED or MODIFIED requirement in delta specs:
- Search codebase for implementation
- Identify relevant files and line numbers
- Assess whether implementation satisfies the requirement
#### Scenario: Scenario coverage check
- **WHEN** verifying correctness
- **THEN** for each scenario in delta specs:
- **THEN** for each scenario under an ADDED or MODIFIED requirement in delta specs:
- Check if the scenario's conditions are handled in code
- Check if tests exist that cover the scenario
- Report coverage status
@@ -80,10 +97,33 @@ The agent SHALL verify that implementation matches the specifications.
- **AND** suggest: either update implementation or update spec to match reality
#### Scenario: Missing implementation
- **WHEN** no implementation found for a requirement
- **WHEN** no implementation found for an ADDED or MODIFIED requirement
- **THEN** report as CRITICAL issue
- **AND** suggest: "Implement requirement X" with guidance on what's needed
#### Scenario: Removed requirement
- **WHEN** a requirement sits under `## REMOVED Requirements` in a delta spec
- **THEN** the agent treats the absence of its implementation as the expected result
- **AND** does not report it as missing or suggest implementing it
- **AND** reports it as CRITICAL only if the removed behavior is still present in the codebase
- **AND** skips scenario coverage for it
- **AND** does not treat matches in OpenSpec artifacts or docs, or in code that serves only the Migration note or an ADDED requirement, as evidence by themselves
- **AND** still reports a code path that delivers the removed behavior, even when it is shared with an ADDED requirement
#### Scenario: Renamed requirement
- **WHEN** a requirement is listed under `## RENAMED Requirements` in a delta spec
- **THEN** the agent does not report its FROM name as missing
- **AND** does not require code symbols or file names to be renamed
- **AND** unless the TO name also appears under MODIFIED, verifies that the behavior of the baseline requirement (its body and scenarios in the main spec, under the FROM name, or under the TO name only when the main spec is already synced) is still implemented
- **AND** reports CRITICAL "Renamed requirement not found" when that behavior is missing
- **AND** marks spec coverage as not verified for the entry when the baseline requirement cannot be found or read
#### Scenario: Change that only removes or renames requirements
- **WHEN** the delta specs are readable and contain at least one REMOVED or RENAMED requirement but no ADDED or MODIFIED requirements
- **THEN** the agent reports requirement implementation mapping and scenario coverage as not applicable
- **AND** does not mark them as not verified or withhold readiness because of them
- **AND** a delta spec with no parseable requirements still marks them as not verified
### Requirement: Coherence Verification
The agent SHALL verify that implementation is sensible and follows design decisions.
@@ -98,7 +138,7 @@ The agent SHALL verify that implementation is sensible and follows design decisi
- **WHEN** verifying coherence
- **AND** no design.md exists
- **THEN** skip design adherence check
- **AND** note "No design.md to verify against"
- **AND** report "Design Adherence: Not verified (No design.md to verify against)"
#### Scenario: Design decision followed
- **WHEN** implementation follows a design decision
@@ -113,8 +153,10 @@ The agent SHALL verify that implementation is sensible and follows design decisi
#### Scenario: Code pattern consistency
- **WHEN** verifying coherence
- **AND** available artifacts support identifying implementation changes beyond a tasks-only check
- **THEN** check if new code follows existing project patterns
- **AND** flag any significant deviations as suggestions
- **AND** report Code Pattern Consistency as not verified if implementation changes cannot be identified
### Requirement: Verification Report Format
The agent SHALL produce a structured, prioritized report.
@@ -132,6 +174,8 @@ The agent SHALL produce a structured, prioritized report.
| Correctness | X/Y |
| Coherence | Followed |
```
- **AND** report `Not verified (<reason>)` for every skipped or partially verified check in its dimension's status
- **AND** never count a skipped check as passing
#### Scenario: Issue prioritization
- **WHEN** issues are found
@@ -147,7 +191,7 @@ The agent SHALL produce a structured, prioritized report.
- **AND** avoid vague suggestions like "consider reviewing"
#### Scenario: All checks pass
- **WHEN** no issues found across all dimensions
- **WHEN** every applicable check ran and no issues were found across all dimensions
- **THEN** display:
```text
All checks passed. Ready for archive.
@@ -160,15 +204,31 @@ The agent SHALL produce a structured, prioritized report.
X critical issue(s) found. Fix before archiving.
```
- **AND** do NOT suggest running archive
- **AND** name every skipped check and its reason, if any
#### Scenario: Only warnings/suggestions
- **WHEN** no CRITICAL issues but warnings exist
#### Scenario: Only warnings
- **WHEN** every applicable check ran and no CRITICAL issues but warnings exist
- **THEN** display:
```text
No critical issues. Y warning(s) to consider.
Ready for archive (with noted improvements).
```
#### Scenario: Only suggestions
- **WHEN** every applicable check ran and only suggestions exist
- **THEN** report "No critical issues or warnings. Z suggestion(s) to consider. Ready for archive (with noted improvements)."
#### Scenario: Checks skipped
- **WHEN** any check was skipped or partially verified and no CRITICAL issues exist
- **THEN** report "No critical issues found in the checks that ran"
- **AND** name every unverified check and its reason
- **AND** include the warning count when nonzero
- **AND** do not claim archive readiness
#### Scenario: Suggestions in final assessment
- **WHEN** suggestions exist
- **THEN** include their count in the final assessment, including assessments with critical issues or skipped checks
### Requirement: Flexible Artifact Handling
The agent SHALL gracefully handle changes with varying artifact completeness.
@@ -188,3 +248,16 @@ The agent SHALL gracefully handle changes with varying artifact completeness.
- **WHEN** change has proposal, design, specs, and tasks
- **THEN** perform all verification checks
- **AND** cross-reference artifacts for consistency
#### Scenario: Unusable or partial artifact evidence
- **WHEN** an artifact cannot be read or lacks usable requirements, scenarios, or design decisions
- **THEN** mark each affected check as not verified with its reason
- **AND** continue checks supported by the remaining evidence without treating partial coverage as a fully verified check
#### Scenario: Intentional artifact omissions
- **WHEN** a check has no supporting artifacts because the schema omits task tracking or optional artifacts, or the change declares `skip_specs: true`
- **THEN** report the corresponding checks as not applicable and explain why
- **AND** exclude not-applicable checks from skipped-check counts and readiness assessment
- **AND** do not require or create optional or intentionally skipped artifacts to obtain a passing report
- **AND** treat verification as advisory: not verified describes missing evidence for an applicable check, not a new archive gate
- **AND** leave archive checks and user-confirmation behavior unchanged
+17
View File
@@ -71,10 +71,27 @@ The agent SHALL reconcile main specs with delta specs using the delta operation
#### Scenario: New capability spec
- **WHEN** delta spec exists for a capability not in main specs
- **AND** it has ADDED requirements and no MODIFIED or RENAMED requirements
- **THEN** create new main spec file at `openspec/specs/<capability-path>/spec.md`, preserving the delta's path relative to `specs/`
- **AND** copy the delta's `## Purpose` body into it when the delta has one, matching what `openspec archive` does
- **AND** write a brief TBD placeholder Purpose only when the delta has none
#### Scenario: MODIFIED or RENAMED against a capability with no main spec
- **WHEN** delta contains `## MODIFIED Requirements` or `## RENAMED Requirements`
- **AND** the capability has no main spec yet
- **THEN** stop the sync for that capability and report that only ADDED requirements are allowed for a new spec, matching what `openspec archive` does
- **AND** never invent the missing requirement
- **AND** skip any `## REMOVED Requirements` with a warning, since there is nothing to remove
#### Scenario: Nothing to put in a new spec
- **WHEN** a delta targets a capability with no main spec
- **AND** the delta has no `## ADDED Requirements` to seed it with
- **THEN** create no main spec and leave the specs directory untouched
- **AND** for a REMOVED-only delta with `retire_capabilities: true` in the change's `.openspec.yaml`, report the capability as already retired and continue without recreating it
- **AND** without that marker, report a REMOVED-only sync as blocked, matching `openspec archive`, which aborts with `Spec must have at least one requirement`
- **AND** report an empty delta as blocked because it has no operations to sync
- **AND** never write an empty `## Requirements` section
#### Scenario: Merged main spec keeps canonical structure
- **WHEN** the agent writes a main spec during sync
- **THEN** every requirement lives under a single `## Requirements` section
+5 -10
View File
@@ -1,6 +1,6 @@
{
"name": "@fission-ai/openspec",
"version": "1.13.0",
"version": "1.13.2",
"description": "AI-native system for spec-driven development",
"keywords": [
"openspec",
@@ -63,28 +63,23 @@
"@changesets/changelog-github": "^1.0.0",
"@changesets/cli": "^3.0.1",
"@types/node": "^20.19.43",
"@vitest/ui": "^3.2.6",
"@vitest/ui": "^4.1.11",
"eslint": "^10.5.0",
"smol-toml": "^1.7.1",
"typescript": "^6.0.3",
"typescript-eslint": "^8.65.0",
"vitest": "^3.2.6"
"vitest": "^4.1.11"
},
"dependencies": {
"@inquirer/core": "^11.2.1",
"@inquirer/core": "^12.0.0",
"@inquirer/prompts": "^8.5.2",
"chalk": "^5.6.2",
"commander": "^14.0.0",
"diff": "^9.0.0",
"cross-spawn": "7.0.6",
"diff": "^9.0.0",
"fast-glob": "^3.3.3",
"ora": "^9.4.1",
"yaml": "^2.8.3",
"zod": "^4.4.3"
},
"pnpm": {
"onlyBuiltDependencies": [
"esbuild"
]
}
}
+660 -639
View File
File diff suppressed because it is too large Load Diff
+5 -1
View File
@@ -2,7 +2,7 @@ packages:
- '.'
allowBuilds:
esbuild@0.28.1: true
esbuild@0.28.2: true
# The only declaration of these. A `pnpm.overrides` block in package.json does not
# merge with this list — pnpm 10 uses it *instead of* this file (verified: a lone
@@ -22,3 +22,7 @@ overrides:
# (transitive via postcss). Remove once transitive nanoid is >=3.3.17
# (check: pnpm why nanoid).
nanoid@<3.3.17: '>=3.3.17 <4'
# GHSA-px8p-9vwx-vf98 — fflate `unzipSync` infinite loop on malformed ZIP64.
# Dev-only (transitive via @vitest/ui); never in the published CLI. Remove once
# transitive fflate is >=0.8.3 (check: pnpm why fflate).
fflate@<0.8.3: '>=0.8.3 <0.9'
+18 -3
View File
@@ -95,7 +95,7 @@ artifacts:
- **CRITICAL**: Scenarios MUST use exactly 4 hashtags (`####`). Using 3 hashtags or bullets will fail silently.
- Every requirement MUST have at least one scenario.
New capabilities only: start the delta spec with a `## Purpose` section -
New capabilities only: the delta spec's first section is `## Purpose` -
one or two sentences (50+ characters, or `openspec validate --strict`
reports it as too brief) describing what the capability is for. Archive
copies it into the main spec it creates; without it the new main spec is
@@ -120,8 +120,10 @@ artifacts:
Common pitfall: Using MODIFIED with partial content loses detail at archive time.
If adding new concerns without changing existing behavior, use ADDED instead.
Example (a new capability, so it opens with `## Purpose`):
Example (a new capability, so its first section is `## Purpose`):
```
# Spec Delta
## Purpose
Lets users take their data out of the product in a portable format.
@@ -193,7 +195,10 @@ artifacts:
bake an unstated assumption into the task list.
**IMPORTANT: Follow the template below exactly.** The apply phase parses
checkbox format to track progress. Tasks not using `- [ ]` won't be tracked.
checkbox format to track progress. A box holding only `x` counts as done,
upper or lower case and with any spacing, so `- [ x]` is done too. Every
other marker, including `- [~]`, `- [-]` and an empty `- []`, reads as
unfinished. A line with no checkbox is not tracked at all.
Guidelines:
- Group related tasks under ## numbered headings
@@ -205,9 +210,18 @@ artifacts:
that task's checkbox description. Use a separate verification task only
when it checks broader integration or system behavior that spans
multiple implementation tasks.
- Each task group MUST land the tests and documentation its own work
calls for. Do NOT collect testing or documentation into a final group -
when a late group first exercises work from an early one, the failures
cascade back through every group in between and force rework. A group
whose work calls for neither, such as scaffolding or dependency setup,
carries neither. A final group is for integration checks only, not for
the tests and docs an earlier group owed.
Example:
```
# Tasks
## 1. Setup
- [ ] 1.1 Create new module structure and verify expected files are present
@@ -217,6 +231,7 @@ artifacts:
- [ ] 2.1 Implement data export function and verify the export test passes
- [ ] 2.2 Add CSV formatting utilities and verify unit tests cover quoting and delimiters
- [ ] 2.3 Document the export API in docs/export.md and verify the documented command runs as written
```
Reference specs for what needs to be built, design for how to build it.
+2
View File
@@ -1,3 +1,5 @@
# Design
## Context
<!-- Current state and constraints that shape the approach. See proposal.md for motivation - don't restate it -->
@@ -1,3 +1,5 @@
# Proposal
## Why
<!-- Explain the motivation for this change. What problem does this solve? Why now? -->
+2
View File
@@ -1,3 +1,5 @@
# Spec Delta
## Purpose
<!-- New capabilities only: one or two sentences (50+ characters) on what this capability is for. Delete this section for an existing capability. -->
+2
View File
@@ -1,3 +1,5 @@
# Tasks
## 1. <!-- Task Group Name -->
- [ ] 1.1 <!-- Task description -->
+18 -2
View File
@@ -10,18 +10,34 @@
// `changeset publish` triggers `prepublishOnly` (also builds here). This
// means an explicit build is not strictly necessary for the guard.
import { execFileSync } from 'child_process';
import { mkdtempSync, readFileSync, rmSync, writeFileSync } from 'fs';
import { tmpdir } from 'os';
import path from 'path';
import spawn from 'cross-spawn';
function log(msg) {
if (process.env.CI) return; // keep CI logs quiet by default
console.log(msg);
}
// cross-spawn, not execFileSync: on Windows `npm` is npm.cmd, which execFile
// cannot resolve without a shell. Keeps the argv form, so no shell is involved.
function run(cmd, args, opts = {}) {
return execFileSync(cmd, args, { encoding: 'utf-8', stdio: ['ignore', 'pipe', 'pipe'], ...opts });
const result = spawn.sync(cmd, args, {
encoding: 'utf-8',
stdio: ['ignore', 'pipe', 'pipe'],
...opts,
});
if (result.error) throw result.error;
if (result.status !== 0) {
const stderr = (result.stderr || '').trim();
throw new Error(
`${cmd} ${args.join(' ')} exited with ${result.status}${stderr ? `: ${stderr}` : ''}`
);
}
return result.stdout;
}
function npmPack() {
+16 -2
View File
@@ -1,6 +1,6 @@
---
name: openspec-apply-change
description: Implement tasks from an OpenSpec change. Use when the user wants to start implementing, continue implementation, or work through tasks.
description: Implement tasks from an OpenSpec change. Use when the user wants to start implementing, continue implementation, or work through tasks. Also use when the user says "openspec apply", "opsx apply", or "openspec implement".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -13,6 +13,17 @@ Implement tasks from an OpenSpec change.
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
**Input**: Optionally specify a change name (e.g., `/openspec-apply-change add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
**Steps**
@@ -48,9 +59,12 @@ Implement tasks from an OpenSpec change.
- Dynamic instruction based on current state
- Optional `context`: current required project instruction input from the selected root
- Optional `operationGuidance`: current advisory guidance for apply
- `missingArtifacts` (when present): required artifact ids with no output
**Handle states:**
- If `state: "blocked"` (missing artifacts): show message, suggest using `/openspec-continue-change` (if it is not installed, run `openspec status --change "<name>" --json` to see the next artifact and `openspec instructions <artifact-id> --change "<name>" --json` for how to create it)
- If `state: "blocked"`: show the message and pause implementation.
- If `missingArtifacts` is non-empty: suggest using `/openspec-continue-change` to create them.
- Otherwise, follow the CLI instruction to create or repair the schema-configured tracking file from existing planning artifacts. Do not assume another artifact is ready or start implementation while blocked.
- If `state: "all_done"`: congratulate, suggest archive
- Otherwise: proceed to implementation
+37 -9
View File
@@ -1,6 +1,6 @@
---
name: openspec-archive-change
description: Archive a completed change in the experimental workflow. Use when the user wants to finalize and archive a change after implementation is complete.
description: Archive a completed OpenSpec change in the experimental workflow. Use when the user wants to finalize and archive a change after implementation is complete. Also use when the user says "openspec archive" or "opsx archive".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -13,6 +13,17 @@ Archive a completed change in the experimental workflow.
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
`<capability-path>` is the spec directory relative to `specs/` (for example, `user-auth` or `identity/user-auth`). Preserve the full path from each delta spec when resolving its main spec.
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
@@ -74,16 +85,27 @@ Archive a completed change in the experimental workflow.
3. **Check task completion status**
Read the tasks file (typically `tasks.md`) to check for incomplete tasks.
Run `openspec list --json` with the same selected-root flags and find the
entry in `changes` whose `name` exactly matches the selected change.
Require exactly one match and nonnegative integer `totalTasks` and
`completedTasks`, with `completedTasks <= totalTasks`. The CLI resolves
the schema's tracked task files, including custom artifact names, output
paths, and globs.
Incomplete tasks = `totalTasks - completedTasks`.
Count tasks marked with `- [ ]` (incomplete) vs `- [x]` (complete).
Do not infer task completion from artifact status or the absence of a
top-level `tasks.md`. If the lookup fails, returns invalid JSON, omits or
duplicates the selected change, or returns invalid counts, report the problem
and stop before syncing or archiving.
The CLI counts only `x`/`X` checkbox markers as complete;
other markers, including unfamiliar ones, remain incomplete.
**If incomplete tasks found:**
- Display warning showing count of incomplete tasks
- Ask the user to confirm they want to proceed
- Proceed if user confirms
**If no tasks file exists:** Proceed without task-related warning.
**If `totalTasks` is zero:** Proceed without a task-related warning.
4. **Assess delta spec sync state**
@@ -94,17 +116,23 @@ Archive a completed change in the experimental workflow.
**If delta specs exist:**
- Compare each delta spec with its corresponding main spec at `<planningHome.root>/openspec/specs/<capability-path>/spec.md` (use the store-aware `planningHome.root` from step 2, not a hardcoded repo path)
- A missing main spec is **not automatically** "already synced". For a new capability, the main spec is an *output* of the sync, not an input:
- If the delta has MODIFIED or RENAMED requirements, report that only ADDED requirements can create a new main spec and mark that capability as sync-blocked. Never invent a requirement that has no current version.
- Otherwise, if the delta has only REMOVED requirements and the change's `.openspec.yaml` declares `retire_capabilities: true`, the capability is already retired: count it as already synced, warn that there is nothing left to remove, and do not recreate the main spec. Apply this rule both now and when verifying a completed sync.
- Otherwise, if the delta has no ADDED requirements, report that no sync is possible and mark that capability as sync-blocked. For a REMOVED-only delta, warn that there is no main spec to remove from and leave the main-spec tree unchanged. `openspec archive` refuses the unmarked REMOVED-only case with `Spec must have at least one requirement`.
- Otherwise, count the capability as needing sync and name it in the summary (`<capability-path>: new main spec will be created`). If the delta also has REMOVED requirements, warn that they will be ignored because there is no main spec to remove from. The sync creates the main spec from only the delta's ADDED requirements, exactly as `openspec archive` does.
- Determine what changes would be applied (adds, modifications, removals, renames)
- Show a combined summary before prompting
- Continue assessing the remaining capabilities even when one is sync-blocked. Show a combined summary before prompting.
**Prompt options:**
- If changes needed: "Sync now (recommended)", "Archive without syncing"
- If already synced: "Archive now", "Sync anyway", "Cancel"
- If any capability is sync-blocked: explain why and offer only "Archive without syncing", "Cancel"
- Otherwise, if changes needed: "Sync now (recommended)", "Archive without syncing"
- Otherwise, if already synced: "Archive now", "Sync anyway", "Cancel"
Route on the answer:
- "Cancel" — stop, do not archive
- "Archive without syncing" or "Archive now" — proceed to archive
- "Sync now" or "Sync anyway" — sync, then verify (below)
- "Sync now" or "Sync anyway" — sync, then verify (below). Do not start any sync while a capability is sync-blocked; explain the blocker and repeat the available choices.
- Anything else — ask again rather than archiving
Before a selected sync writes any main spec, run
@@ -118,7 +146,7 @@ Archive a completed change in the experimental workflow.
Then run the `openspec-sync-specs` workflow inline (agent-driven intelligent merge) for change '<name>', passing the delta spec analysis and the fetched specs-rule snapshot from above, and wait for it to finish. The inline sync must reuse that snapshot without fetching `specs` instructions again. Do not delegate it to a background task — step 5 would move `changeRoot` out from under a sync that is still reading it, leaving the change archived and the main specs never updated. If your agent can only run it by delegation, delegate synchronously and wait for the result.
Then re-run the comparison from the top of this step against every capability that has a delta spec in `artifactPaths.specs.existingOutputPaths` — not only the ones the sync reports it touched. A successful sync leaves nothing left to apply, so each capability must now read as already synced:
Then re-run the comparison from the top of this step, including the explicitly retired, missing-spec case, against every capability that has a delta spec in `artifactPaths.specs.existingOutputPaths` — not only the ones the sync reports it touched. A successful sync leaves nothing left to apply, so each capability must now read as already synced:
- ADDED requirements present
- MODIFIED requirements carrying the scenario and description changes named in the delta, with their other scenarios intact
- REMOVED requirements gone — and where this sync retired a capability (removed its last requirement, leaving `## Requirements` empty), its main spec deleted rather than left empty; a spec the sync deliberately kept and reported is also a match
+45 -9
View File
@@ -1,6 +1,6 @@
---
name: openspec-bulk-archive-change
description: Archive multiple completed changes at once. Use when archiving several parallel changes.
description: Archive multiple completed OpenSpec changes at once. Use when archiving several parallel changes. Also use for a plural archive request - "openspec bulk-archive", "opsx bulk-archive", "openspec archive all", or "openspec archive these changes".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -15,6 +15,17 @@ This skill allows you to batch-archive changes, handling spec conflicts intellig
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
`<capability-path>` is the spec directory relative to `specs/` (for example, `user-auth` or `identity/user-auth`). Preserve the full path from each delta spec when resolving its main spec.
**Input**: None required (prompts for selection)
@@ -30,7 +41,7 @@ This skill allows you to batch-archive changes, handling spec conflicts intellig
2. **Prompt for change selection**
Ask the user to choose changes (multi-select):
- Show each change with its schema
- Show each change name and task status from the list output
- Include an option for "All changes"
- Allow any number of selections (1+ works, 2+ is the typical use case)
@@ -63,15 +74,24 @@ This skill allows you to batch-archive changes, handling spec conflicts intellig
3. **Batch validation - gather status for all selected changes**
Run `openspec list --json` once with the same selected-root flags for task
progress. If the lookup fails, returns invalid JSON, or omits any selected
change, contains a duplicate selected change, or returns invalid counts,
report the problem and stop before syncing or archiving the batch.
For each selected change, collect:
a. **Artifact status** - Run `openspec status --change "<name>" --json`
- Parse `schemaName`, `artifacts`, `planningHome`, `changeRoot`, `artifactPaths`, and `actionContext`
- Note which artifacts are `done` vs other states
b. **Task completion** - Read `artifactPaths.tasks.existingOutputPaths` from status JSON
- Count `- [ ]` (incomplete) vs `- [x]` (complete)
- If no tasks file exists, note as "No tasks"
b. **Task completion** - Find the `changes` entry from the list response whose `name` exactly matches this change
- Require nonnegative integer `totalTasks` and `completedTasks`, with `completedTasks <= totalTasks`
- Incomplete tasks = `totalTasks - completedTasks`
- The CLI resolves the schema's tracked task files, including custom artifact names, output paths, and globs
- Do not infer task completion from artifact status, an artifact id of `tasks`, or the absence of a top-level `tasks.md`
- The CLI counts only `x`/`X` checkbox markers as complete; other markers remain incomplete
- If `totalTasks` is zero, note as "No tasks"
c. **Delta specs** - Check `artifactPaths.specs.existingOutputPaths` from status JSON
- List which capability specs exist
@@ -81,6 +101,14 @@ This skill allows you to batch-archive changes, handling spec conflicts intellig
lookup for that change; do not infer deltas from unrelated artifacts.
- Evaluate this independently for every change, including mixed-schema
batches where some schemas have no `specs` artifact.
d. **Archive target** - Compute each change's target name once and record it as that change's `<target-name>`
- Use the change name as-is when it already starts with a `YYYY-MM-DD-` prefix; otherwise prepend the current date as `YYYY-MM-DD-<name>` (same rule as `openspec archive`)
- Check whether `<planningHome.changesDir>/archive/<target-name>` already exists
- If it exists, or another selected change resolves to the same target name, mark every such change `Blocked` with `Archive directory already exists`
- A blocked change is never synced or moved: show it as `Blocked` in the step 6 table, leave it out of conflict resolution (resolve its conflicts using only the other changes), and record it as Failed in step 8d
- Checking here, before any main spec is written, matches `openspec archive`: a collision found after sync would leave main specs rewritten for an archive that never happened
4. **Detect spec conflicts**
Build a map keyed by `<capability-path>`, the exact path relative to `specs/`:
@@ -153,8 +181,8 @@ This skill allows you to batch-archive changes, handling spec conflicts intellig
Route on the answer by intent, not by exact label — you wrote these labels,
so match what the user picked rather than the wording above:
- "Cancel" — stop, do not archive. Report that nothing was archived and skip the remaining steps.
- The archive-everything option — proceed with every selected change
- The ready-only option — proceed with only the changes the step 6 table marks `Ready` or `Ready*`, and record the rest as Skipped in step 8d. If a `Ready*` change's conflict partner is skipped, re-derive that conflict's resolution using only the changes being archived.
- The archive-everything option — proceed with every selected change that is not `Blocked`
- The ready-only option — proceed with only the changes the step 6 table marks `Ready` or `Ready*`, and record the rest as Skipped in step 8d, except `Blocked` changes, which stay Failed with `Archive directory already exists`. If a `Ready*` change's conflict partner is skipped, re-derive that conflict's resolution using only the changes being archived.
- Anything else — ask again rather than archiving
Before step 8 writes the first main spec or moves any change, fetch every
@@ -199,13 +227,20 @@ This skill allows you to batch-archive changes, handling spec conflicts intellig
c. **Perform the archive**:
Target name: use the change name as-is when it already starts with a `YYYY-MM-DD-` prefix; otherwise prepend the current date as `YYYY-MM-DD-<name>` (same rule as `openspec archive`).
Target name: use the `<target-name>` recorded for this change in step 3d, unchanged. Never recompute it here: a batch that runs past midnight would check one date in step 3 and move to another.
**Check if target already exists:**
- Check again immediately before the move, even though step 3 already checked: the target can appear mid-batch
- If yes: record this change as Failed with `Archive directory already exists`, leave `changeRoot` where it is, report any main specs step 8a already synced for it, and continue with the remaining changes
- If no: move `changeRoot` to the archive directory
```bash
mkdir -p "<planningHome.changesDir>/archive"
mv "<changeRoot>" "<planningHome.changesDir>/archive/<target-name>"
```
**Confirm the move did not nest:** `mv` exits 0 even when the target appeared after the check, moving the change *inside* it. If `<planningHome.changesDir>/archive/<target-name>/<change-directory-name>` now exists (the last path segment of `changeRoot`), move that directory back to `changeRoot` and record this change as Failed with `Archive directory already exists`. Never report it as archived.
d. **Track outcome** for each change:
- Success: archived successfully
- Failed: error during archive or spec verification (record error)
@@ -320,8 +355,9 @@ No active changes found. Create a new change to get started.
- Never archive after the user cancels the confirmation — a cancelled batch archives nothing
- Track and report all outcomes (success/skip/fail)
- Preserve .openspec.yaml when moving to archive
- Archive directory target uses current date: YYYY-MM-DD-<name>; a name that already starts with a `YYYY-MM-DD-` prefix is used as-is (never stack a second date)
- Archive directory target uses the current date, computed once in step 3d and reused at the move: YYYY-MM-DD-<name>; a name that already starts with a `YYYY-MM-DD-` prefix is used as-is (never stack a second date)
- If archive target exists, fail that change but continue with others
- Check every archive target in step 3, before the first main-spec write; a change whose target exists is never synced or moved
- If sync is requested, run the `openspec-sync-specs` workflow inline (agent-driven) for each change with included delta specs
- Carry the per-delta `includedDeltas` and `excludedDeltas` decisions into execution; sync and verify only included deltas
- Report every excluded delta as `sync skipped` without treating the archive itself as skipped
+12 -2
View File
@@ -1,6 +1,6 @@
---
name: openspec-continue-change
description: Continue working on an OpenSpec change by creating the next artifact. Use when the user wants to progress their change, create the next artifact, or continue their workflow.
description: Continue working on an OpenSpec change by creating the next artifact. Use when the user wants to progress their change, create the next artifact, or continue their workflow. Also use when the user says "openspec continue" or "opsx continue".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -13,6 +13,17 @@ Continue working on a change by creating the next artifact.
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
**Steps**
@@ -26,7 +37,6 @@ Continue working on a change by creating the next artifact.
When prompting, present the top 3-4 most recently modified changes as options, showing:
- Change name
- Schema (from `schema` field if present, otherwise "spec-driven")
- Status (e.g., "0/5 tasks", "complete", "no tasks")
- How recently it was modified (from `lastModified` field)
+20 -9
View File
@@ -1,6 +1,6 @@
---
name: openspec-explore
description: Enter explore mode - a thinking partner for exploring ideas, investigating problems, and clarifying requirements. Use when the user wants to think through something before or during a change.
description: Enter OpenSpec explore mode - a thinking partner for exploring ideas, investigating problems, and clarifying requirements in a project that uses OpenSpec. Use when the user wants to think through something before or during an OpenSpec change. Also use when the user says "openspec explore" or "opsx explore".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -11,12 +11,23 @@ metadata:
Enter explore mode. Think deeply. Visualize freely. Follow the conversation wherever it goes.
**IMPORTANT: Explore mode is for thinking, not implementing.** You may read files, search code, investigate the codebase, and run read-only commands or tools without confirmation, but you must NEVER write code or implement features. If the user asks you to implement something, remind them to exit explore mode first and create a change proposal. You MAY create or update OpenSpec change artifacts (proposals, designs, specs) within a confirmed scope—that's capturing thinking, not implementing. Answering design or clarifying questions is never consent to write. Before the first write-capable action, name the artifacts or files you would change and what you would do, ask a direct yes/no question, and wait for the user's confirmation in a separate message. Confirmation covers only the scope you described; ask again before expanding it. For a new change, scaffold it first as described below.
**IMPORTANT: Explore mode is for thinking, not implementing.** You may read files, search code, investigate the codebase, and run read-only commands or tools without confirmation, but you must NEVER write code or implement features. If the user asks you to implement something, do not start it here: say that explore mode does not implement, and point them at `/openspec-propose`, which turns the discussion into a change. The work happens from that change, never from explore mode. You MAY create or update OpenSpec change artifacts (proposals, designs, specs) within a confirmed scope—that's capturing thinking, not implementing. Answering design or clarifying questions is never consent to write. Before the first write-capable action, name the artifacts or files you would change and what you would do, ask a direct yes/no question, and wait for the user's confirmation in a separate message. Confirmation covers only the scope you described; ask again before expanding it. An explicit request from the user to capture the exploration as a new change is itself that confirmation, covering the change and the change artifacts the request names; scaffold it first as described below.
**This is a stance, not a workflow.** There are no fixed steps, no required sequence, no mandatory outputs. You're a thinking partner helping the user explore.
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
---
## The Stance
@@ -117,7 +128,7 @@ openspec list --json
This tells you:
- If there are active changes
- Their names, schemas, and status
- Their names and task status
- What the user might be working on
That is the *change* list - work in flight. It does not include the project's durable capabilities, so list those too:
@@ -141,14 +152,14 @@ Think freely. When insights crystallize, you might offer:
- "This feels solid enough to start a change. Want me to create a proposal?"
- Or keep exploring - no pressure to formalize
If the user asks you to capture the exploration as a new change, transition seamlessly into the requested capture:
If the user asks you to capture the exploration as a new change, that request is the confirmation required above. It covers scaffolding that change and creating the change artifacts the request names, and nothing else. This holds only when the request is theirs: a yes to an offer you made confirms only the scope your offer itself named, so name the change and the artifacts in the offer. Don't re-ask for what they already asked for; do ask before anything beyond it. Transition seamlessly into the requested capture:
1. Run `openspec new change "<name>"` (with `--store <id>` when applicable) before creating any artifacts. Never create a new change directory under `openspec/changes/` by hand; the CLI scaffold creates required metadata such as `.openspec.yaml`. Keep the selected `--store <id>` on every applicable follow-up `status` and `instructions` command.
2. Run `openspec status --change "<name>" --json` (append the confirmed `--store "<id>"` only for a registered standalone store), then process the requested artifacts in dependency order. For each requested artifact that is `ready`, run `openspec instructions "<artifact-id>" --change "<name>" --json` (append the confirmed `--store "<id>"` only for a registered standalone store). Before creating a requested artifact, evaluate any condition in its own `instruction` against the explored change; record a deliberate skip instead when the condition does not apply. If a requested artifact is blocked by a direct prerequisite the user did not request, run `openspec instructions "<prerequisite-id>" --change "<name>" --json` (append the confirmed `--store "<id>"` only for a registered standalone store) for that prerequisite whether it is `ready` or `blocked`. If its own `instruction` states a condition, evaluate that condition against the explored change and record a deliberate skip only when the condition does not apply. If the condition applies, or the prerequisite is not conditional, treat it as a normal prerequisite and ask before expanding the capture. Do not create an unrequested prerequisite unless the user approves.
3. Follow the returned `template` and `instruction` fields. Read completed dependency files listed in `dependencies`, and apply `context` and `rules` as constraints without copying them into the artifact. If the instruction delegates creation to a specific skill or command, invoke it; otherwise write the artifact to `resolvedOutputPath`, using the instruction to choose a concrete path when it is a glob. Verify that the selected concrete output exists.
4. After creating each artifact, re-run `openspec status --change "<name>" --json` (append the confirmed `--store "<id>"` only for a registered standalone store) and continue until every requested artifact is `done`, `skipped`, or was deliberately skipped because its own `instruction` stated a condition that did not apply. Tell the user about a deliberate conditional skip, remember it, and do not reconsider it. Dependencies are enablers, not gates: if a requested artifact is still `blocked` only because you deliberately skipped a conditional prerequisite, run `openspec instructions "<artifact-id>" --change "<name>" --json` (append the confirmed `--store "<id>"` only for a registered standalone store) despite the blocked status, then create it using step 3 only when those recorded conditional skips are its sole missing dependencies. If a requested artifact is blocked by a prerequisite the user did not ask to capture and cannot be conditionally skipped, explain that dependency and ask before expanding the capture.
Capture the artifact(s) the user requested without asking them to invoke another workflow command. If they asked only to start a change, stop after scaffolding and show its status.
Capture the artifact(s) the user requested without asking them to invoke another workflow command. If they asked only to start a change, stop after scaffolding and show its status. When the requested capture is done, stop there and name where the work continues: `/openspec-propose` writes the remaining planning artifacts, and `/openspec-apply-change` implements the change once tasks exist. Capturing artifacts never starts implementing them.
### When a change exists
@@ -304,7 +315,7 @@ You: That changes everything.
There's no required ending. Discovery might:
- **Flow into a proposal**: "Ready to start? I can create a change proposal."
- **Flow into a proposal**: "Ready to start? Run `/openspec-propose` and this becomes a change."
- **Result in artifact updates**: "Updated design.md with these decisions"
- **Just provide clarity**: User has what they need, moves on
- **Continue later**: "We can pick this up anytime"
@@ -321,7 +332,7 @@ When it feels like things are crystallizing, you might summarize:
**Open questions**: [if any remain]
**Next steps** (if ready):
- Create a change proposal
- Turn this into a change: `/openspec-propose`
- Keep exploring: just keep talking
```
@@ -331,11 +342,11 @@ But this summary is optional. Sometimes the thinking IS the value.
## Guardrails
- **Don't implement** - Never write code or implement features. Workflow configuration counts too: creating or editing schemas, templates, or `openspec/config.yaml` is a change, not thinking. Creating or updating OpenSpec change artifacts within the confirmed scope is fine, writing anything else is not.
- **Don't implement** - Never write code or implement features. Workflow configuration counts too: creating or editing schemas, templates, or `openspec/config.yaml` is a change, not thinking. Creating or updating OpenSpec change artifacts within the confirmed scope is fine, writing anything else is not. When the user is ready to build, name the handoff rather than starting: `/openspec-propose` turns the discussion into a change, and the work happens there.
- **Don't fake understanding** - If something is unclear, dig deeper
- **Don't rush** - Discovery is thinking time, not task time
- **Don't force structure** - Let patterns emerge naturally
- **Don't auto-capture** - Offer to save insights, don't just do it. Read-only commands and tools need no confirmation. Before the first write-capable action—including `openspec new change` or another command that writes files—name the artifacts or files and proposed changes, ask a direct yes/no question, and wait for explicit confirmation in a separate user message. That confirmation covers only the described scope; ask again before expanding it. Answers to design or clarifying questions are never consent to write.
- **Don't auto-capture** - Offer to save insights, don't just do it. Read-only commands and tools need no confirmation. Before the first write-capable action—including `openspec new change` or another command that writes files—name the artifacts or files and proposed changes, ask a direct yes/no question, and wait for explicit confirmation in a separate user message. That confirmation covers only the described scope; ask again before expanding it. Answers to design or clarifying questions are never consent to write. That rule governs `openspec new change` whenever you are the one proposing the capture; the user's own capture request is the exception, handled in the capture transition above.
- **Don't manually scaffold changes** - Never create a new change directory under `openspec/changes/` by hand. Always use `openspec new change "<name>"` (with `--store <id>` when applicable) so required metadata such as `.openspec.yaml` is created before writing artifacts.
- **Do visualize** - A good diagram is worth many paragraphs
- **Do explore the codebase** - Ground discussions in reality
+13 -2
View File
@@ -1,6 +1,6 @@
---
name: openspec-ff-change
description: Fast-forward through OpenSpec artifact creation. Use when the user wants to quickly create all artifacts needed for implementation without stepping through each one individually.
description: Fast-forward through OpenSpec artifact creation. Use when the user wants to quickly create all artifacts needed for implementation without stepping through each one individually. Also use when the user says "openspec ff" or "opsx ff".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -13,6 +13,17 @@ Fast-forward through artifact creation - generate everything needed to start imp
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
**Input**: The user's request should include a change name (kebab-case) OR a description of what they want to build.
**Steps**
@@ -80,7 +91,7 @@ Fast-forward through artifact creation - generate everything needed to start imp
- Dependencies are enablers, not gates: if a required artifact is still `blocked` only because you skipped a conditional dependency, write it anyway
- Stop when every artifact in the required set is `done`, `skipped`, or was deliberately skipped
c. **If an artifact requires user input** (unclear context):
c. **If an artifact requires user input** (critically unclear context):
- Ask the user to clarify
- Then continue with creation
+12 -1
View File
@@ -1,6 +1,6 @@
---
name: openspec-new-change
description: Start a new OpenSpec change using the experimental artifact workflow. Use when the user wants to create a new feature, fix, or modification with a structured step-by-step approach.
description: Start a new OpenSpec change using the experimental artifact workflow. Use when the user wants to create a new feature, fix, or modification with a structured step-by-step approach. Also use when the user says "openspec new change" or "opsx new".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -13,6 +13,17 @@ Start a new change using the experimental artifact-driven approach.
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
**Input**: The user's request should include a change name (kebab-case) OR a description of what they want to build.
**Steps**
+47 -33
View File
@@ -1,6 +1,6 @@
---
name: openspec-onboard
description: Guided onboarding for OpenSpec - walk through a complete workflow cycle with narration and real codebase work.
description: Guided onboarding for OpenSpec - walk through a complete workflow cycle with narration and real codebase work. Also use when the user says "openspec onboard" or "opsx onboard".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -13,6 +13,17 @@ Guide the user through their first complete OpenSpec workflow cycle. This is a t
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
---
## Preflight
@@ -220,6 +231,8 @@ Here's a draft proposal:
---
# Proposal
## Why
[1-2 sentences explaining the problem/opportunity]
@@ -287,6 +300,8 @@ Here's the spec:
---
# Spec Delta
## ADDED Requirements
### Requirement: <Name>
@@ -326,6 +341,8 @@ Here's the design:
---
# Design
## Context
[Brief context about the current state]
@@ -361,7 +378,7 @@ Save to the `resolvedOutputPath` from `openspec instructions design --change "<n
Finally, we break the work into implementation tasks—checkboxes that drive the apply phase.
These should be small, clear, and in logical order.
These should be small, clear, and in logical order. Each group carries the tests and documentation for its own work - the last group is only for integration checks.
```
**DO:** Generate tasks based on specs and design:
@@ -371,6 +388,8 @@ Here are the implementation tasks:
---
# Tasks
## 1. [Category or file]
- [ ] 1.1 [Specific task] — verify: [test, command, observable behavior, or delivered artifact]
@@ -382,12 +401,17 @@ Here are the implementation tasks:
---
Each checkbox becomes a unit of work in the apply phase. Ready to implement?
Each checkbox becomes a unit of work in the apply phase. Does this task breakdown look right?
```
**PAUSE** - Wait for user to confirm they're ready to implement.
**PAUSE** - Wait for user approval/feedback.
Save to the `resolvedOutputPath` from `openspec instructions tasks --change "<name>" --json`.
After approval, save to the `resolvedOutputPath` from `openspec instructions tasks --change "<name>" --json`.
Then ask:
> "Tasks are saved. Ready to implement?"
**PAUSE** - Wait for user to confirm before implementation.
---
@@ -472,23 +496,18 @@ This same rhythm works for any size change—a small fix or a major feature.
## Command Reference
**Core workflow:**
**The commands you have installed:**
| Command | What it does |
|-------------------|--------------------------------------------|
| Command | What it does |
|------------------|--------------------------------------------|
| `/openspec-propose` | Create a change and generate all artifacts |
| `/openspec-explore` | Think through problems before/during work |
| `/openspec-apply-change` | Implement tasks from a change |
| `/openspec-archive-change` | Archive a completed change |
**Additional commands** (only if installed - availability depends on your profile):
| Command | What it does |
|--------------------|----------------------------------------------------------|
| `/openspec-new-change` | Start a new change, step through artifacts one at a time |
| `/openspec-continue-change` | Continue working on an existing change |
| `/openspec-ff-change` | Fast-forward: create all artifacts at once |
| `/openspec-verify-change` | Verify implementation matches artifacts |
| `/openspec-new-change` | Start a new change, one artifact at a time |
| `/openspec-continue-change` | Continue working on an existing change |
| `/openspec-ff-change` | Fast-forward: create all artifacts at once |
| `/openspec-verify-change` | Verify implementation matches artifacts |
---
@@ -508,8 +527,8 @@ If the user says they need to stop, want to pause, or seem disengaged:
```
No problem! Your change is saved at the `changeRoot` reported by `openspec status --change "<name>" --json`.
To pick up where we left off later:
- `/openspec-continue-change <name>` - Resume artifact creation (if installed; otherwise `openspec status --change "<name>" --json` shows the next artifact)
To pick up where we left off later, `openspec status --change "<name>" --json` shows exactly where the change stands.
- `/openspec-continue-change <name>` - Resume artifact creation
- `/openspec-apply-change <name>` - Jump to implementation (if tasks exist)
The work won't be lost. Come back whenever you're ready.
@@ -524,23 +543,18 @@ If the user says they just want to see the commands or skip the tutorial:
```
## OpenSpec Quick Reference
**Core workflow:**
**The commands you have installed:**
| Command | What it does |
|--------------------------|--------------------------------------------|
| `/openspec-propose <name>` | Create a change and generate all artifacts |
| `/openspec-explore` | Think through problems (no code changes) |
| `/openspec-apply-change <name>` | Implement tasks |
| `/openspec-archive-change <name>` | Archive when done |
**Additional commands** (only if installed - availability depends on your profile):
| Command | What it does |
|---------------------------|-------------------------------------|
| `/openspec-new-change <name>` | Start a new change, step by step |
| `/openspec-continue-change <name>` | Continue an existing change |
| `/openspec-ff-change <name>` | Fast-forward: all artifacts at once |
| `/openspec-verify-change <name>` | Verify implementation |
| `/openspec-propose <name>` | Create a change and generate all artifacts |
| `/openspec-explore` | Think through problems (no code changes) |
| `/openspec-apply-change <name>` | Implement tasks |
| `/openspec-archive-change <name>` | Archive when done |
| `/openspec-new-change <name>` | Start a new change, step by step |
| `/openspec-continue-change <name>` | Continue an existing change |
| `/openspec-ff-change <name>` | Fast-forward: all artifacts at once |
| `/openspec-verify-change <name>` | Verify implementation |
Try `/openspec-propose` to start your first change.
```
+13 -2
View File
@@ -1,6 +1,6 @@
---
name: openspec-propose
description: Propose a new change with all artifacts generated in one step. Use when the user wants to quickly describe what they want to build and get a complete proposal with design, specs, and tasks ready for implementation.
description: Propose a new OpenSpec change with all artifacts generated in one step. Use when the user wants to quickly describe what they want to build and get a complete proposal with design, specs, and tasks ready for implementation. Also use when the user says "openspec propose" or "opsx propose".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -27,6 +27,17 @@ When the user is ready to implement, they must start the apply workflow explicit
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
**Input**: The user's request should include a change name (kebab-case) OR a description of what they want to build.
**Steps**
@@ -44,7 +55,7 @@ When the user is ready to implement, they must start the apply workflow explicit
2. **Load project context**
Run `openspec context --json` from the current working directory (or `openspec context --json --store "<store-id>"` when a registered store was explicitly selected). Use the returned `root.path` as the authoritative OpenSpec root. If context reports `no_openspec_root`, stop without creating or changing any files. Offer `openspec init` and wait for the user to request initialization. Do not initialize automatically or run `openspec new change`. After initialization, rerun this context check before continuing. For any other context failure, stop and report the error; do not fall back to the current directory or run later OpenSpec commands without the selected store.
Run `openspec context --json` from the current working directory (or `openspec context --json --store "<store-id>"` when a registered store was explicitly selected). Use the returned `root.path` as the authoritative OpenSpec root. If context reports `no_openspec_root`, stop without creating or changing any files and follow the **Project check** above for how this workflow was reached. Offer `openspec init` only for an explicit OpenSpec request, and wait for the user to request initialization. Do not initialize automatically or run `openspec new change`. After initialization, rerun this context check before continuing. For any other context failure, stop and report the error; do not fall back to the current directory or run later OpenSpec commands without the selected store.
Only when context returns a resolved `root.path`, read `<root.path>/openspec/config.yaml`. Use `config.yml` only when `config.yaml` does not exist. If neither file exists, continue without project context. Do not fall back to `config.yml` if `config.yaml` is unreadable or invalid.
+29 -1
View File
@@ -1,6 +1,6 @@
---
name: openspec-sync-specs
description: Sync delta specs from a change to main specs. Use when the user wants to update main specs with changes from a delta spec, without archiving the change.
description: Sync delta specs from an OpenSpec change to main specs. Use when the user wants to update main specs with changes from a delta spec, without archiving the change. Also use when the user says "openspec sync" or "opsx sync".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -15,6 +15,17 @@ This is an **agent-driven** operation - you will read delta specs and directly e
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
`<capability-path>` is the spec directory relative to `specs/` (for example, `user-auth` or `identity/user-auth`). Preserve the full path from each delta spec when resolving its main spec.
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
@@ -95,6 +106,13 @@ This is an **agent-driven** operation - you will read delta specs and directly e
b. **Read the main spec** at `<planningHome.root>/openspec/specs/<capability-path>/spec.md` (may not exist yet)
**If it does not exist yet** (a new capability), match what `openspec archive` does:
only ADDED requirements may be applied - step d creates the spec from them.
MODIFIED and RENAMED have no requirement to act on, so stop the sync for that
capability and report that its main spec does not exist and only ADDED is allowed
for a new spec; never invent the missing requirement. REMOVED has nothing to
remove - skip it and warn.
c. **Apply changes intelligently**:
**ADDED Requirements:**
@@ -142,6 +160,14 @@ This is an **agent-driven** operation - you will read delta specs and directly e
(this is what `openspec archive` does; it warns and moves on)
d. **Create new main spec** if capability doesn't exist yet:
- Only when the delta has ADDED requirements to put in it and no MODIFIED or
RENAMED requirements blocked this capability in step b. Otherwise create nothing
and leave the specs directory untouched. For a REMOVED-only delta, if the change's
`.openspec.yaml` declares `retire_capabilities: true`, report it as already retired
and continue without recreating the spec. Without that marker, report the sync as blocked:
`openspec archive` rejects it with `Spec must have at least one requirement`.
An empty delta has no operations to sync; report it as blocked too.
Never write an empty `## Requirements` section.
- Create `<planningHome.root>/openspec/specs/<capability-path>/spec.md`
- Add Purpose section: copy the delta's `## Purpose` body verbatim when it has one
(this is what `openspec archive` does); only write a brief TBD placeholder when it does not
@@ -166,6 +192,8 @@ This is an **agent-driven** operation - you will read delta specs and directly e
**Delta Spec Format Reference**
```markdown
# Spec Delta
## Purpose
Only on a delta that introduces a brand-new capability. Seeds the new main spec.
+29 -11
View File
@@ -1,6 +1,6 @@
---
name: openspec-update-change
description: Update an OpenSpec change by revising its existing planning artifacts and keeping them coherent with one another. Use when the user wants to revise a change's plan, fold new decisions into it, or reconcile its artifacts after an edit. Never edits code.
description: Update an OpenSpec change by revising its existing planning artifacts and keeping them coherent with one another. Use when the user wants to revise a change's plan, fold new decisions into it, or reconcile its artifacts after an edit. Also use when the user says "openspec update change" or "opsx update". If the user means the openspec update CLI command, which refreshes generated files, run that command instead. Never edits code.
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -13,9 +13,20 @@ Revise a change's existing planning artifacts and keep them coherent. Never edit
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
`/openspec-continue-change` is an optional workflow and may not be installed. Before suggesting it anywhere below, verify that it is available. If it is unavailable, `openspec status --change "<name>" --json` shows the next artifact and `openspec instructions "<artifact-id>" --change "<name>" --json` explains how to create it.
This workflow revises artifacts that already exist; `/openspec-continue-change` is what creates the ones that do not.
**Steps**
@@ -28,7 +39,6 @@ Revise a change's existing planning artifacts and keep them coherent. Never edit
When prompting, present the top 3-4 most recently modified changes as options, showing:
- Change name
- Schema (from `schema` field if present, otherwise "spec-driven")
- Status (e.g., "0/5 tasks", "complete", "no tasks")
- How recently it was modified (from `lastModified` field)
@@ -56,13 +66,20 @@ Revise a change's existing planning artifacts and keep them coherent. Never edit
4. **Read and reconcile**
- Read the artifact(s) the request touches and the change's other existing artifacts.
- Apply the requested edit. Then check every other existing artifact against it - in ANY direction: an edit to a later artifact may require revising an earlier one, not only the other way around. Build order is a useful reading order, not a constraint on which artifacts may be revised.
- Draft the requested edit in the conversation, not in files. Work out exactly what it changes; step 5 owns every write. Then check every other existing artifact against the drafted edit - in ANY direction: an edit to a later artifact may require revising an earlier one, not only the other way around. Build order is a useful reading order, not a constraint on which artifacts may be revised.
- Note everything that is now inconsistent, missing, or contradictory.
- Revise only files that already exist (`existingOutputPaths`). Do NOT create artifacts that don't exist yet, and do NOT invent new files under a glob artifact - note them and point the user to `/openspec-continue-change` to create them.
- If the change is already coherent, say so and make no edits.
- Propose revisions to files that already exist (`existingOutputPaths`). If an artifact has no existing output files and status `ready` or `blocked`, note it and point the user to `/openspec-continue-change` to create them. Leave `skipped` artifacts untouched; do not treat them as missing or defer them to the continue workflow.
- A glob artifact (e.g. `specs/**/*.md`) is marked `done` after at least one file matches, and the continue workflow only handles `ready` artifacts. When reconciliation identifies a missing file for a glob artifact whose `existingOutputPaths` is non-empty:
1. Run `openspec instructions "<artifact-id>" --change "<name>" --json` and use its `instruction` and `template`. Treat `context` and `rules` as constraints; do not copy them into the file. If instructions report `skipped: true`, do not create the file. Read current dependency files from disk; if a required non-skipped dependency is missing, stop and ask the user to restore it first.
2. Choose a concrete path inside `changeRoot` that matches `artifactPaths.<id>.outputPath` and does not already exist. Verify it remains inside `changeRoot` after resolving any symlinked parent directories. The glob `resolvedOutputPath` is not a valid target.
3. Include the new file in step 5's proposed revisions and create it only after the user confirms.
4. After confirmation, immediately before creation, refresh status and instructions. Verify the artifact is still in scope, not skipped, and partially populated; repeat the concrete-path checks above.
5. Use a create operation that fails if the target already exists. If `instruction` delegates creation to another skill or command, invoke it only if it can honor the confirmed path and these guardrails; otherwise stop. If any check fails or the confirmed draft is no longer valid, stop and reconcile with the user rather than replacing existing content or choosing a different path.
- If the change is already coherent, say so and propose no revisions.
5. **Confirm and apply, one artifact at a time**
- Show each proposed revision and why. Write only after the user confirms.
- This step performs every artifact write in this workflow; no earlier step edits an artifact.
- Show each proposed revision and why - including the requested edit drafted in step 4. Write only after the user confirms.
- If the user rejects a revision, do not write it - leave that artifact unchanged.
- When a substantial rewrite is needed, get that artifact's rules and template first:
```bash
@@ -70,7 +87,7 @@ Revise a change's existing planning artifacts and keep them coherent. Never edit
```
6. **Point to the next step (guidance only - NEVER act on it)**
- Artifacts still missing -> suggest `/openspec-continue-change` to create them.
- Artifacts with empty `existingOutputPaths` and status `ready` or `blocked` -> suggest `/openspec-continue-change` to create them.
- Change already implemented (tasks checked off / already applied) -> the code may no longer match the revised plan; suggest `/openspec-apply-change` to carry the delta into code.
- Everything done and implemented -> suggest `/openspec-archive-change`.
@@ -78,13 +95,14 @@ Revise a change's existing planning artifacts and keep them coherent. Never edit
After each invocation, show:
- Which artifacts were revised (and which proposed revisions were rejected)
- Anything deferred to `/openspec-continue-change` (not-yet-created artifacts or files)
- Any file created under a glob artifact that was already partially populated
- Anything deferred to `/openspec-continue-change` (artifacts with no files yet and status `ready` or `blocked`, never `skipped` artifacts)
- Where the change stands and the recommended next command
**Guardrails**
- Planning artifacts only - NEVER edit implementation code. If the revised plan implies code changes, stop and point to `/openspec-apply-change`.
- Use the artifact ids and paths reported by `openspec status`; never branch on hardcoded artifact names.
- Edit only the concrete files in `existingOutputPaths`; never write to a glob `resolvedOutputPath`.
- Do not advance the build frontier: no new artifacts, no new files under glob artifacts - that is `/openspec-continue-change`'s job.
- Do not advance the build frontier: if an artifact has empty `existingOutputPaths` and status `ready` or `blocked`, that is `/openspec-continue-change`'s job. Leave `skipped` artifacts untouched. The only new-file scope is a confirmed concrete path under a glob artifact whose `existingOutputPaths` is non-empty.
- Confirm every edit with the user before writing.
- If the request changes the change's *intent* rather than refining it, first verify whether the optional `/openspec-new-change` workflow is available. If it is, recommend starting fresh with `/openspec-new-change` (the "Update vs. Start Fresh" heuristic). If it is unavailable, ask for a distinct unused change name and recommend `openspec new change "<new-change-name>"` instead.
- If the request changes the change's *intent* rather than refining it, recommend starting fresh with `/openspec-new-change` (the "Update vs. Start Fresh" heuristic).
+70 -25
View File
@@ -1,6 +1,6 @@
---
name: openspec-verify-change
description: Verify implementation matches change artifacts. Use when the user wants to validate that implementation is complete, correct, and coherent before archiving.
description: Verify implementation matches OpenSpec change artifacts. Use when the user wants to validate that implementation is complete, correct, and coherent before archiving. Also use when the user says "openspec verify" or "opsx verify".
allowed-tools: Bash(openspec:*)
license: MIT
compatibility: Requires openspec CLI.
@@ -13,6 +13,17 @@ Verify that an implementation matches the change artifacts (specs, tasks, design
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
Otherwise, with no root, what happens next depends on how this workflow was reached:
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
**Steps**
@@ -24,7 +35,7 @@ Verify that an implementation matches the change artifacts (specs, tasks, design
- Auto-select if only one active change exists
- If ambiguous, run `openspec list --json` to get available changes and ask the user to select one
When prompting, show changes that have implementation tasks (tasks artifact exists).
When prompting, show all active changes returned by the list, including changes with `status: "no-tasks"`.
Include the schema used for each change if available.
Mark changes with incomplete tasks as "(In Progress)".
@@ -45,7 +56,9 @@ Verify that an implementation matches the change artifacts (specs, tasks, design
openspec instructions apply --change "<name>" --json
```
This returns the change directory and `contextFiles` (artifact ID -> array of concrete file paths). Read all available artifacts from `contextFiles`.
This returns the change directory, `contextFiles` (artifact ID -> array of concrete file paths), `taskTrackingConfigured`, and top-level `tasks` and `progress` aggregated from every concrete file matched by the schema's `apply.tracks` configuration that could be read. Read all available artifacts from `contextFiles`.
Treat apply `state` and `instruction` as context, not a verification verdict. Do not implement tasks or archive the change during verification.
4. **Initialize verification report structure**
@@ -56,30 +69,59 @@ Verify that an implementation matches the change artifacts (specs, tasks, design
Each dimension can have CRITICAL, WARNING, or SUGGESTION issues.
Verification is advisory. Respect intentional omissions such as `skip_specs: true`, optional design documents, and schemas without task tracking. Do not require or invent optional or intentionally omitted artifacts to obtain a clean report. `Not verified` describes a limit of this report, not a new archive prerequisite. Archive retains its own checks and user-confirmation behavior.
Mark checks the schema does not define, or artifacts the status reports as intentionally skipped, as **Not applicable**. The correctness checks of a change whose readable delta specs contain REMOVED or RENAMED requirements but no ADDED or MODIFIED requirements are also **Not applicable** (see step 6). Exclude them from skipped-check counts and the archive-readiness assessment. Reserve **Not verified** for applicable checks whose evidence is missing or unusable.
If only task evidence is available for applicable checks, verify task completion only and mark the remaining applicable checks, including **Code Pattern Consistency**, as not verified with the reason "Only task evidence available".
If artifacts cannot be read or contain no usable requirements, scenarios, or design decisions, mark the affected checks as not verified with the specific reason. Continue checks supported by the remaining evidence, but a partially checked input set is not a fully verified check. Missing requirements affect Spec Coverage and Requirement Implementation Mapping; missing scenarios affect Scenario Coverage; missing design decisions affect Design Adherence.
5. **Verify Completeness**
**Task Completion**:
- If `contextFiles.tasks` exists, read every file path in it
- Parse checkboxes: `- [ ]` (incomplete) vs `- [x]` (complete)
- Count complete vs total tasks
- If incomplete tasks exist:
- Add CRITICAL issue for each incomplete task
- If `taskTrackingConfigured` is false, report **Task Completion** as not applicable. Do not treat empty `tasks` as missing evidence.
- Otherwise, use the top-level `tasks` and `progress` fields. They already aggregate every readable concrete file matched by `apply.tracks`, regardless of the tracked artifact's ID; do not infer tracking from a `contextFiles` key.
- If `unavailableTrackingFiles` is nonempty, mark **Task Completion** as not verified and include every unavailable path and reason. Continue using any readable task evidence, but do not infer completion from the partial `tasks` and `progress` fields.
- If `taskTrackingConfigured` is true and `tasks` is empty, mark **Task Completion** as not verified and record the reason from apply `state` and `instruction`. Nonzero totals alone do not establish evaluable task descriptions.
- Report complete vs total tasks from `progress`.
- If `progress.remaining` is greater than 0:
- Add CRITICAL issue for each listed incomplete task. If the remaining count exceeds the listed incomplete tasks, also report the incomplete checkboxes without descriptions and recommend adding descriptions and completing them. Do not infer completion from the listed tasks alone.
- Recommendation: "Complete task: <description>" or "Mark as done if already implemented"
**Spec Coverage**:
- If status marks the spec artifact skipped by `skip_specs: true`, or the schema defines no spec artifact, report the spec-dependent checks as not applicable.
- Otherwise, `contextFiles` is keyed by artifact id, and artifact ids come from the active schema. If `contextFiles.specs` is absent or empty, mark **Spec Coverage**, **Requirement Implementation Mapping**, and **Scenario Coverage** as not verified; do not treat any of them as clean.
- If delta specs exist in `contextFiles.specs`:
- Extract all requirements (marked with "### Requirement:")
- For each requirement:
- Extract all requirements (marked with "### Requirement:", or listed as `FROM:`/`TO:` pairs under `## RENAMED Requirements`) and note the delta section each one sits under: `## ADDED`, `## MODIFIED`, `## REMOVED`, or `## RENAMED Requirements`. The section decides what the check looks for.
- For each ADDED or MODIFIED requirement (for MODIFIED, check the text in the delta, not the old wording):
- Search codebase for keywords related to the requirement
- Assess if implementation likely exists
- If requirements appear unimplemented:
- If ADDED or MODIFIED requirements appear unimplemented:
- Add CRITICAL issue: "Requirement not found: <requirement name>"
- Recommendation: "Implement requirement X: <description>"
- For each REMOVED requirement, the change asks for the behavior to be gone, so invert the check:
- Search codebase for the removed behavior. Matches in `openspec/` artifacts or docs, or in code that serves only the Migration note or an ADDED requirement, are not evidence by themselves. Report any code path that still delivers the removed behavior, including one shared with an ADDED requirement.
- Finding no implementation is the expected result. Never report a REMOVED requirement as "Requirement not found" or recommend implementing it.
- If the behavior is still present:
- Add CRITICAL issue: "Removed requirement still implemented: <requirement name>"
- Recommendation: "Remove the remaining implementation at <file>:<lines>, following the requirement's Migration note if it has one"
- For each RENAMED entry (`FROM:`/`TO:`), the name changes but the behavior stays, so check the TO requirement for that unchanged behavior:
- Do not report the FROM name as missing, and do not require code symbols, identifiers, or file names to be renamed.
- If the TO name also appears under MODIFIED, its behavior is checked there against the MODIFIED text; skip it here.
- Otherwise, read the baseline requirement in the main spec at `<planningHome.root>/openspec/specs/<capability-path>/spec.md`, using the same capability path as the delta spec: the requirement under the FROM name, or under the TO name only when the FROM name is absent because the main spec is already synced. Its body and scenarios are the evidence for the behavior the TO requirement keeps.
- Search codebase for that behavior and assess if it is still implemented.
- If it appears unimplemented:
- Add CRITICAL issue: "Renamed requirement not found: <TO name>"
- Recommendation: "Restore the behavior of <TO name> (renamed from <FROM name>); a rename must not change behavior"
- If the baseline requirement cannot be found or read, mark **Spec Coverage** as not verified for that entry with the reason. Never count an unchecked rename as passing.
6. **Verify Correctness**
If the delta specs are readable and contain at least one REMOVED or RENAMED requirement but no ADDED or MODIFIED requirements (the change only removes or renames requirements), report **Requirement Implementation Mapping** and **Scenario Coverage** as **Not applicable**. The REMOVED and RENAMED checks under Spec Coverage are the evidence for such a change (each RENAMED entry is checked there against its baseline behavior), so do not mark these two checks as not verified. A delta spec with no parseable requirements at all is unusable evidence, not a removal-only change: mark these checks as not verified.
**Requirement Implementation Mapping**:
- For each requirement from delta specs:
- For each ADDED or MODIFIED requirement from delta specs (REMOVED entries, and RENAMED entries without a MODIFIED block, were settled under Spec Coverage):
- Search codebase for implementation evidence
- If found, note file paths and line ranges
- Assess if implementation matches requirement intent
@@ -88,26 +130,29 @@ Verify that an implementation matches the change artifacts (specs, tasks, design
- Recommendation: "Review <file>:<lines> against requirement X"
**Scenario Coverage**:
- For each scenario in delta specs (marked with "#### Scenario:"):
- For each scenario under an ADDED or MODIFIED requirement in delta specs (marked with "#### Scenario:"):
- Check if conditions are handled in code
- Check if tests exist covering the scenario
- If scenario appears uncovered:
- Add WARNING: "Scenario not covered: <scenario name>"
- Recommendation: "Add test or implementation for scenario: <description>"
- Skip scenarios under a REMOVED requirement; that behavior is meant to be gone.
7. **Verify Coherence**
**Design Adherence**:
- If the schema defines no design artifact, report **Design Adherence** as not applicable.
- If `contextFiles.design` exists:
- Extract key decisions (look for sections like "Decision:", "Approach:", "Architecture:")
- Verify implementation follows those decisions
- If contradiction detected:
- Add WARNING: "Design decision not followed: <decision>"
- Recommendation: "Update implementation or revise design.md to match reality"
- If no design.md: Skip design adherence check, note "No design.md to verify against"
- Otherwise, if `contextFiles.design` is absent or empty: mark **Design Adherence** as not verified. With other supporting artifacts, **Code Pattern Consistency** still runs; the task-only case remains limited to task completion.
**Code Pattern Consistency**:
- Review new code for consistency with project patterns
- If implementation changes cannot be identified, mark **Code Pattern Consistency** as not verified and explain the missing evidence.
- Otherwise, review new code for consistency with project patterns
- Check file naming, directory structure, coding style
- If significant deviations found:
- Add SUGGESTION: "Code pattern deviation: <details>"
@@ -127,11 +172,15 @@ Verify that an implementation matches the change artifacts (specs, tasks, design
| Coherence | Followed/Issues |
```
In each Status cell, report the results of checks that ran and `Not verified (<reason>)` for every skipped check. If all checks in a dimension were skipped, start the cell with `Not verified`. Never score a skipped check as passing. Treat every not verified or partially verified check as skipped in the final assessment. Count only ADDED and MODIFIED requirements in N, and report REMOVED and RENAMED requirements separately (for example, "1 removal confirmed, 1 rename verified"). For a change that only removes or renames requirements, the Correctness cell reads `Not applicable (no ADDED or MODIFIED requirements)`.
**Issues by Priority**:
1. **CRITICAL** (Must fix before archive):
- Incomplete tasks
- Missing requirement implementations
- Removed requirements still implemented
- Renamed requirements whose behavior is no longer implemented
- Each with specific, actionable recommendation
2. **WARNING** (Should fix):
@@ -145,9 +194,12 @@ Verify that an implementation matches the change artifacts (specs, tasks, design
- Each with specific recommendation
**Final Assessment**:
- If CRITICAL issues: "X critical issue(s) found. Fix before archiving."
- If only warnings: "No critical issues. Y warning(s) to consider. Ready for archive (with noted improvements)."
- If all clear: "All checks passed. Ready for archive."
- If CRITICAL issues: "X critical issue(s) found. Fix before archiving." If any check was skipped, also name every skipped check and its reason.
- If no CRITICAL issues, one or more warnings, and no checks were skipped: "No critical issues. Y warning(s) to consider. Ready for archive (with noted improvements)."
- If only suggestions and no checks were skipped: "No critical issues or warnings. Z suggestion(s) to consider. Ready for archive (with noted improvements)."
- If no issues and no checks were skipped: "All checks passed. Ready for archive."
- If any check was skipped and there are no CRITICAL issues: do not claim readiness. Say "No critical issues found in the checks that ran. <check(s)> not verified: <reason>." Include the warning count when nonzero.
- Include the suggestion count when nonzero in every final assessment.
**Verification Heuristics**
@@ -157,13 +209,6 @@ Verify that an implementation matches the change artifacts (specs, tasks, design
- **False Positives**: When uncertain, prefer SUGGESTION over WARNING, WARNING over CRITICAL
- **Actionability**: Every issue must have a specific recommendation with file/line references where applicable
**Graceful Degradation**
- If only tasks.md exists: verify task completion only, skip spec/design checks
- If tasks + specs exist: verify completeness and correctness, skip design
- If full artifacts: verify all three dimensions
- Always note which checks were skipped and why
**Output Format**
Use clear markdown with:
+15 -1
View File
@@ -9,6 +9,10 @@ import { Change, Delta } from '../core/schemas/index.js';
import type { RootOutput } from '../core/root-selection.js';
import { isInteractive } from '../utils/interactive.js';
import { getActiveChangeIds } from '../utils/item-discovery.js';
import {
describeNestedChange,
findNestedChangesIn,
} from '../utils/nested-change.js';
import { getTaskProgressForChange } from '../utils/task-progress.js';
import { FileSystemUtils } from '../utils/file-system.js';
import { discoverSpecFiles } from '../utils/spec-discovery.js';
@@ -133,6 +137,13 @@ export class ChangeCommand {
.then((stats) => stats.isDirectory())
.catch(() => false);
if (isChangeDirectory) {
// A folder holding nested change directories has no proposal of its
// own and never will; pointing at `status --change` would send the
// user down a second dead end (#1846).
const nested = await findNestedChangesIn(changesPath, changeName);
if (nested) {
throw new Error(describeNestedChange(nested));
}
throw new Error(
`Change "${changeName}" has no proposal.md yet. ` +
`Run "openspec status --change ${changeName}" to see which artifact comes next.`
@@ -562,7 +573,10 @@ export class ChangeCommand {
private extractTitle(content: string, changeName: string): string {
const match = content.match(/^#\s+(?:Change:\s+)?(.+)$/im);
return match ? match[1].trim() : changeName;
const title = match?.[1].trim();
// The packaged template opens every proposal with a bare `# Proposal`,
// which names the document rather than the change.
return title && title.toLowerCase() !== 'proposal' ? title : changeName;
}
private printNextSteps(issues: Array<{ message: string }> = []): void {
+167 -21
View File
@@ -1,10 +1,13 @@
import { Command } from 'commander';
import { spawn } from 'node:child_process';
import type { ChildProcess, spawn as nodeSpawn } from 'node:child_process';
import * as fs from 'node:fs';
import { createRequire } from 'node:module';
import * as path from 'node:path';
import {
getGlobalConfigPath,
getGlobalConfig,
isConfigRootObject,
isGlobalConfigUnreadable,
saveGlobalConfig,
GlobalConfig,
} from '../core/global-config.js';
@@ -26,8 +29,144 @@ import { hasProjectConfigDrift } from '../core/profile-sync-drift.js';
import { UpdateCommand } from '../core/update.js';
import { asErrorMessage, isPromptCancellationError } from './shared-output.js';
type EditorOutcome =
| { code: number | null; signal: NodeJS.Signals | null }
| { error: Error };
// cross-spawn finds `.cmd` shims such as `code.cmd` on Windows and escapes each
// argument for cmd.exe; elsewhere it is plain spawn. Loaded lazily so other
// commands skip its module graph.
let cachedSpawn: typeof nodeSpawn | undefined;
function loadSpawn(): typeof nodeSpawn {
if (cachedSpawn === undefined) {
cachedSpawn = createRequire(import.meta.url)('cross-spawn') as typeof nodeSpawn;
}
return cachedSpawn;
}
/**
* Splits an EDITOR or VISUAL value into a program and its arguments without
* running a shell, so `;`, `|`, `$VAR`, `~` and backticks are plain characters.
* Double quotes group words. On POSIX, single quotes group words too and a
* backslash escapes the next character (inside double quotes only `"` and `\`).
* On Windows a backslash is a path separator and a single quote is a plain
* character. Returns null when a quote is left open.
*/
export function splitEditorCommand(value: string, platform: NodeJS.Platform = process.platform): string[] | null {
const posix = platform !== 'win32';
const words: string[] = [];
let word = '';
let inWord = false;
let quote: '"' | "'" | null = null;
for (let i = 0; i < value.length; i++) {
const ch = value[i];
if (quote === "'") {
if (ch === "'") quote = null;
else word += ch;
continue;
}
if (posix && ch === '\\' && i + 1 < value.length) {
const next = value[i + 1];
if (quote === '"' && next !== '"' && next !== '\\') {
word += ch;
} else {
word += next;
i++;
}
inWord = true;
continue;
}
if (quote === '"') {
if (ch === '"') quote = null;
else word += ch;
continue;
}
if (ch === '"' || (posix && ch === "'")) {
quote = ch;
inWord = true;
continue;
}
if (/\s/.test(ch)) {
if (inWord) words.push(word);
word = '';
inWord = false;
continue;
}
word += ch;
inWord = true;
}
if (quote) return null;
if (inWord) words.push(word);
return words;
}
/**
* Starts the user's editor on `filePath`, never through a shell.
*
* EDITOR and VISUAL hold a command line, not a program name: `code --wait`
* and `"/path with spaces/subl" -w` are both ordinary values, so the value is
* split into words and the file path is appended as its own argument. A value
* that is itself the absolute path of an existing file is run as-is, so an
* unquoted editor path with spaces keeps working.
*/
function spawnEditor(editor: string, filePath: string): ChildProcess {
const words = path.isAbsolute(editor) && fs.existsSync(editor) ? [editor] : splitEditorCommand(editor);
if (words === null) {
throw new Error('the value has an unterminated quote');
}
if (words.length === 0) {
throw new Error('the value is blank');
}
const [program, ...args] = words;
return loadSpawn()(program, [...args, filePath], { stdio: 'inherit', shell: false });
}
/** Runs the editor on `filePath` and resolves once it has closed or failed to start. */
function runEditor(editor: string, filePath: string): Promise<EditorOutcome> {
return new Promise((resolve) => {
try {
const child = spawnEditor(editor, filePath);
child.once('error', (error) => resolve({ error }));
child.once('close', (code, signal) => resolve({ code, signal }));
} catch (error) {
resolve({ error: error instanceof Error ? error : new Error(String(error)) });
}
});
}
function reportEditorFailure(editor: string, outcome: EditorOutcome): void {
if ('error' in outcome) {
console.error(`Error: Could not start editor "${editor}": ${outcome.error.message}`);
} else if (outcome.signal) {
console.error(`Error: Editor "${editor}" was terminated by ${outcome.signal}`);
} else {
console.error(`Error: Editor "${editor}" exited with code ${outcome.code}`);
}
// Only a missing program earns the hint: EACCES or EPERM means it exists.
if ('error' in outcome && (outcome.error as NodeJS.ErrnoException).code === 'ENOENT') {
console.error('Set EDITOR or VISUAL to an installed editor command, for example: export EDITOR="code --wait"');
}
}
type ProfileAction = 'both' | 'delivery' | 'workflows' | 'keep';
/**
* A config file that exists but cannot be parsed is still the user's file:
* getGlobalConfig() reads it as defaults, and saving those back would erase
* every setting in it. Reports the fix instead, and returns true when it did.
*/
function refuseUnreadableConfig(): boolean {
if (!isGlobalConfigUnreadable()) {
return false;
}
console.error(`Error: ${getGlobalConfigPath()} could not be parsed, so it was left unchanged.`);
console.error('Fix it with "openspec config edit", or reset it with "openspec config reset --all".');
process.exitCode = 1;
return true;
}
interface ProfileState {
profile: Profile;
delivery: Delivery;
@@ -248,7 +387,12 @@ export function registerConfigCommand(program: Command): void {
let rawConfig: Record<string, unknown> = {};
try {
if (fs.existsSync(configPath)) {
rawConfig = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
const parsed: unknown = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
// A non-object root holds no explicit settings, and reading a key
// off `null` would crash this read-only command.
if (isConfigRootObject(parsed)) {
rawConfig = parsed as Record<string, unknown>;
}
}
} catch {
// If reading fails, treat all as defaults
@@ -314,6 +458,10 @@ export function registerConfigCommand(program: Command): void {
return;
}
if (refuseUnreadableConfig()) {
return;
}
const config = getGlobalConfig() as Record<string, unknown>;
const coercedValue = coerceValue(value, options.string || false);
@@ -343,6 +491,10 @@ export function registerConfigCommand(program: Command): void {
.command('unset <key>')
.description('Remove a key (revert to default)')
.action((key: string) => {
if (refuseUnreadableConfig()) {
return;
}
const config = getGlobalConfig() as Record<string, unknown>;
const existed = deleteNestedValue(config, key);
@@ -391,7 +543,8 @@ export function registerConfigCommand(program: Command): void {
}
}
saveGlobalConfig({ ...DEFAULT_CONFIG });
// A reset is the one write meant to replace a file that cannot be parsed.
saveGlobalConfig({ ...DEFAULT_CONFIG }, { replaceUnreadable: true });
console.log('Configuration reset to defaults');
});
@@ -417,24 +570,13 @@ export function registerConfigCommand(program: Command): void {
saveGlobalConfig({ ...DEFAULT_CONFIG });
}
// Spawn editor and wait for it to close
// Avoid shell parsing to correctly handle paths with spaces in both
// the editor path and config path
const child = spawn(editor, [configPath], {
stdio: 'inherit',
shell: false,
});
await new Promise<void>((resolve, reject) => {
child.on('close', (code) => {
if (code === 0) {
resolve();
} else {
reject(new Error(`Editor exited with code ${code}`));
}
});
child.on('error', reject);
});
// Wait for the editor to close; a failure is reported, never thrown.
const outcome = await runEditor(editor, configPath);
if ('error' in outcome || outcome.code !== 0) {
reportEditorFailure(editor, outcome);
process.exitCode = 1;
return;
}
try {
const rawConfig = fs.readFileSync(configPath, 'utf-8');
@@ -463,6 +605,10 @@ export function registerConfigCommand(program: Command): void {
.command('profile [preset]')
.description('Configure workflow profile (interactive picker or preset shortcut)')
.action(async (preset?: string) => {
if (refuseUnreadableConfig()) {
return;
}
// Preset shortcut: `openspec config profile core`
if (preset === 'core') {
const config = getGlobalConfig();
+6 -4
View File
@@ -1,4 +1,4 @@
import { execSync, execFileSync } from 'child_process';
import { execFileSync } from 'child_process';
import { createRequire } from 'module';
import os from 'os';
@@ -12,8 +12,10 @@ const TITLE_PREFIX = 'Feedback: ';
*/
function isGhInstalled(): boolean {
try {
const command = process.platform === 'win32' ? 'where gh' : 'which gh';
execSync(command, { stdio: 'pipe' });
// execFileSync, not execSync: no shell is needed to look a binary up, and
// spawning one next to free-form issue text is the shape a future refactor
// most easily turns into command injection.
execFileSync(process.platform === 'win32' ? 'where' : 'which', ['gh'], { stdio: 'pipe' });
return true;
} catch {
return false;
@@ -25,7 +27,7 @@ function isGhInstalled(): boolean {
*/
function isGhAuthenticated(): boolean {
try {
execSync('gh auth status', { stdio: 'pipe' });
execFileSync('gh', ['auth', 'status'], { stdio: 'pipe' });
return true;
} catch {
return false;
+35 -9
View File
@@ -12,7 +12,11 @@ import {
isSchemaDir,
listSchemas,
} from '../core/artifact-graph/resolver.js';
import { parseSchema, SchemaValidationError } from '../core/artifact-graph/schema.js';
import {
findApplyTracksWarning,
parseSchema,
SchemaValidationError,
} from '../core/artifact-graph/schema.js';
import type { SchemaYaml, Artifact } from '../core/artifact-graph/types.js';
import { resolveConfigFilePath } from '../core/project-config.js';
import { FileSystemUtils } from '../utils/file-system.js';
@@ -227,13 +231,20 @@ function validateSchema(
}
}
// Dependency graph validation is already done by parseSchema
// (it throws on cycles and invalid references)
// Dependency graph validation is already done by parseSchema (it throws on
// cycles, invalid references, and an unknown apply.requires id)
if (verbose) {
console.log(' Dependency graph validation passed (via parseSchema)');
}
return { valid: issues.length === 0, issues };
// An apply.tracks value that matches no generates value exactly still loads
// (apply reads the path as written), so it is a warning, not an error.
const tracksWarning = findApplyTracksWarning(schema);
if (tracksWarning) {
issues.push({ level: 'warning', path: 'apply.tracks', message: tracksWarning });
}
return { valid: !issues.some((issue) => issue.level === 'error'), issues };
}
/**
@@ -740,6 +751,9 @@ export function registerSchemaCommand(program: Command): void {
} else {
if (result.valid) {
console.log(`✓ Schema '${name}' is valid`);
for (const issue of result.issues) {
console.log(` ${issue.level}: ${issue.message}`);
}
} else {
console.log(`✗ Schema '${name}' has errors:`);
for (const issue of result.issues) {
@@ -1408,11 +1422,17 @@ export function registerSchemaCommand(program: Command): void {
/**
* Create default template content for an artifact.
*
* Every template opens with a top-level heading so the artifact it produces is
* a well-formed markdown document rather than a file whose first line is a
* section header (markdownlint MD041, #1138).
*/
function createDefaultTemplate(artifactId: string): string {
switch (artifactId) {
case 'proposal':
return `## Why
return `# Proposal
## Why
<!-- Describe the motivation for this change -->
@@ -1434,7 +1454,9 @@ function createDefaultTemplate(artifactId: string): string {
`;
case 'specs':
return `## ADDED Requirements
return `# Spec Delta
## ADDED Requirements
### Requirement: Example requirement
@@ -1446,7 +1468,9 @@ Description of the requirement.
`;
case 'design':
return `## Context
return `# Design
## Context
<!-- Background and context -->
@@ -1473,7 +1497,9 @@ Description and rationale.
`;
case 'tasks':
return `## Implementation Tasks
return `# Tasks
## Implementation Tasks
- [ ] Task 1
- [ ] Task 2
@@ -1481,7 +1507,7 @@ Description and rationale.
`;
default:
return `## ${artifactId}
return `# ${artifactId}
<!-- Add content here -->
`;
+5 -2
View File
@@ -294,9 +294,12 @@ async function resolveSetupInput(
async function prepareSetupInput(
input: ResolvedStoreSetupInput,
_options: StoreSetupOptions
options: StoreSetupOptions
) {
return prepareStoreSetup(input);
return prepareStoreSetup({
...input,
...(options.initGit !== undefined ? { initGit: options.initGit } : {}),
});
}
async function confirmSetup(
+76 -1
View File
@@ -1,6 +1,12 @@
import ora from 'ora';
import path from 'path';
import {
describeNestedChange,
findNestedChangesIn,
NESTED_CHANGE_ISSUE_MARKER,
} from '../utils/nested-change.js';
import { Validator } from '../core/validation/validator.js';
import type { ValidationIssue } from '../core/validation/types.js';
import { VALIDATION_MESSAGES } from '../core/validation/constants.js';
import {
resolveRootForCommand,
@@ -16,6 +22,7 @@ import { nearestMatches } from '../utils/match.js';
import { promises as fs } from 'fs';
import { getTaskProgressDetailForChange, type SchemaGlobCache } from '../utils/task-progress.js';
import { FileSystemUtils } from '../utils/file-system.js';
import { folderStyleNameProblem } from '../core/id.js';
type ItemType = 'change' | 'spec';
@@ -270,11 +277,63 @@ export class ValidateCommand {
await this.validateByType(root, type, itemName, opts);
}
/**
* A namespace folder wrapping nested change directories has no deltas of its
* own and never will. The usual "add a delta spec" error points the author at
* a directory that is not the change, so the nesting is reported instead
* (#1846). Returns undefined for every ordinary change.
*/
private async nestedChangeReport(
root: ResolvedOpenSpecRoot,
id: string
): Promise<{ valid: false; issues: ValidationIssue[] } | undefined> {
const nested = await findNestedChangesIn(root.changesDir, id);
if (!nested) return undefined;
return {
valid: false,
issues: [{ level: 'ERROR', path: 'file', message: describeNestedChange(nested) }],
};
}
private async validateByType(root: ResolvedOpenSpecRoot, type: ItemType, id: string, opts: { strict: boolean; json: boolean }): Promise<void> {
// `--type` skips the membership check above, so the name still has to be
// guarded before it is joined onto a directory. `show` already rejects a
// traversing id.
//
// Spec ids are nested (`specs/<area>/<capability>/spec.md`, #1353), so the
// guard runs per segment - rejecting the whole id for containing a `/`
// would break every nested capability, including the hint that
// `validate --specs` prints. Change names are flat, so they keep the
// whole-value check.
const nameProblem =
type === 'change'
? folderStyleNameProblem(id, 'Change name')
: (id.split('/').map((segment) => folderStyleNameProblem(segment, 'Spec id')).find(Boolean) ?? null);
if (nameProblem) {
if (opts.json) {
console.log(
JSON.stringify(
{ status: [{ severity: 'error', code: 'invalid_item', message: nameProblem }] },
null,
2
)
);
} else {
console.error(nameProblem);
}
process.exitCode = 1;
return;
}
const validator = new Validator(opts.strict);
if (type === 'change') {
const changeDir = path.join(root.changesDir, id);
const start = Date.now();
const nestedReport = await this.nestedChangeReport(root, id);
if (nestedReport) {
this.printReport('change', id, nestedReport, Date.now() - start, opts.json, root);
process.exitCode = 1;
return;
}
const report = await validator.validateChangeDeltaSpecs(changeDir, {
mainSpecsDir: root.specsDir,
projectRoot: root.path,
@@ -325,7 +384,13 @@ export class ValidateCommand {
const invalidMarkerIssue = issues.some(i =>
i.message.includes(VALIDATION_MESSAGES.CHANGE_SKIP_SPECS_INVALID_METADATA)
);
if (type === 'change' && conflictIssue) {
// A namespace folder has no deltas to author, so the delta-authoring
// bullets below would point at a directory that is not the change (#1846).
const nestedIssue = issues.some(i => i.message.includes(NESTED_CHANGE_ISSUE_MARKER));
if (type === 'change' && nestedIssue) {
bullets.push('- Move each nested change directly under openspec/changes/, folding the namespace into its name');
bullets.push('- Only specs may be nested by domain; change directories are always flat');
} else if (type === 'change' && conflictIssue) {
bullets.push('- This change declares skip_specs (no spec deltas): delete the files under specs/, or remove skip_specs from .openspec.yaml if requirements do change');
bullets.push('- skip_specs is only honored when .openspec.yaml is valid change metadata (schema: <name> naming a known schema is required)');
} else if (type === 'change' && invalidMarkerIssue) {
@@ -392,6 +457,16 @@ export class ValidateCommand {
queue.push(async () => {
const start = Date.now();
const changeDir = path.join(root.changesDir, id);
const nestedReport = await this.nestedChangeReport(root, id);
if (nestedReport) {
return {
id,
type: 'change' as const,
valid: false,
issues: nestedReport.issues,
durationMs: Date.now() - start,
};
}
const report = await validator.validateChangeDeltaSpecs(changeDir, {
mainSpecsDir: root.specsDir,
projectRoot: root.path,
+79 -22
View File
@@ -12,11 +12,11 @@ import {
loadChangeContext,
generateInstructions,
resolveSchema,
resolveArtifactOutputPath,
resolveArtifactOutputs,
type ArtifactInstructions,
} from '../../core/artifact-graph/index.js';
import { isSpecsArtifactPath } from '../../core/artifact-graph/outputs.js';
import { findUnreadDeltaFiles } from '../../utils/spec-discovery.js';
import {
getChangeDir,
resolveCurrentPlanningHomeSync,
@@ -31,8 +31,11 @@ import {
} from '../../core/root-selection.js';
import {
assembleReferenceIndex,
escapeEnvelopeAttribute,
escapeEnvelopeTags,
renderReferencedStoresBlock,
renderReferencedStoresSection,
sanitizeInline,
type ReferenceIndexEntry,
} from '../../core/references.js';
import { readRegistrySnapshot } from '../../core/store/registry.js';
@@ -198,8 +201,14 @@ export function printInstructionsText(instructions: ArtifactInstructions, isBloc
unlocks,
} = instructions;
// Opening tag
console.log(`<artifact id="${artifactId}" change="${changeName}" schema="${schemaName}">`);
// Opening tag. The change name is a directory name read from disk, and the
// read path rejects only separators and NUL - a quote in it would otherwise
// close the attribute and forge siblings on this tag.
console.log(
`<artifact id="${escapeEnvelopeAttribute(artifactId)}"` +
` change="${escapeEnvelopeAttribute(changeName)}"` +
` schema="${escapeEnvelopeAttribute(schemaName)}">`
);
console.log();
// Artifacts skipped via skip_specs get no creation directive: emitting the
@@ -226,8 +235,10 @@ export function printInstructionsText(instructions: ArtifactInstructions, isBloc
// Task directive
console.log('<task>');
console.log(`Create the ${artifactId} artifact for change "${changeName}".`);
console.log(description);
console.log(
`Create the ${escapeEnvelopeTags(artifactId)} artifact for change "${escapeEnvelopeTags(changeName)}".`
);
console.log(escapeEnvelopeTags(description));
console.log('</task>');
console.log();
@@ -235,7 +246,7 @@ export function printInstructionsText(instructions: ArtifactInstructions, isBloc
if (context) {
console.log('<project_context>');
console.log('<!-- This is background information for you. Do NOT include this in your output. -->');
console.log(context);
console.log(escapeEnvelopeTags(context));
console.log('</project_context>');
console.log();
}
@@ -251,7 +262,9 @@ export function printInstructionsText(instructions: ArtifactInstructions, isBloc
console.log('<rules>');
console.log('<!-- These are constraints for you to follow. Do NOT include this in your output. -->');
for (const rule of rules) {
console.log(`- ${rule}`);
// Flattened so a newline cannot forge a sibling bullet, but never
// truncated: these are instructions an agent has to follow in full.
console.log(`- ${escapeEnvelopeTags(sanitizeInline(rule, Infinity))}`);
}
console.log('</rules>');
console.log();
@@ -276,7 +289,7 @@ export function printInstructionsText(instructions: ArtifactInstructions, isBloc
const fullPath = path.join(changeDir, dep.path);
console.log(`<dependency id="${dep.id}" status="${status}">`);
console.log(` <path>${fullPath}</path>`);
console.log(` <description>${dep.description}</description>`);
console.log(` <description>${escapeEnvelopeTags(dep.description)}</description>`);
console.log('</dependency>');
}
console.log('</dependencies>');
@@ -292,7 +305,7 @@ export function printInstructionsText(instructions: ArtifactInstructions, isBloc
// Instruction (guidance)
if (instruction) {
console.log('<instruction>');
console.log(instruction.trim());
console.log(escapeEnvelopeTags(instruction.trim()));
console.log('</instruction>');
console.log();
}
@@ -300,7 +313,10 @@ export function printInstructionsText(instructions: ArtifactInstructions, isBloc
// Template
console.log('<template>');
console.log('<!-- Use this as the structure for your output file. Fill in the sections. -->');
console.log(template.trim());
// Copied verbatim into the artifact file, so its `<!-- ... -->` comments and
// `<placeholder>` markers must survive - only the envelope's own closing
// tags are neutralized.
console.log(escapeEnvelopeTags(template.trim()));
console.log('</template>');
console.log();
@@ -436,14 +452,18 @@ function collectMissingPrerequisites(input: {
* reached tasks yet, the missing specs are the next step rather than a warning.
* Schemas that declare no spec-producing artifact carry `skip_specs` from
* creation, so this never fires on them.
*
* A delta file the merge path never reads (specs/<capability>.md, a note
* beside spec.md) still satisfies the specs glob, so it reads as written here
* while validate rejects it and archive would drop it. Each one is named.
*/
function collectApplyWarnings(input: {
async function collectApplyWarnings(input: {
state: ApplyInstructions['state'];
schema: { artifacts: { id: string; generates: string }[] };
changeDir: string;
changeName: string;
skippedArtifacts?: Set<string>;
}): string[] {
}): Promise<string[]> {
const { state, schema, changeDir, changeName, skippedArtifacts } = input;
if (state === 'blocked') return [];
@@ -452,10 +472,15 @@ function collectApplyWarnings(input: {
);
if (specArtifacts.length === 0) return [];
if (specArtifacts.some((artifact) => skippedArtifacts?.has(artifact.id))) return [];
const warnings = (await findUnreadDeltaFiles(path.join(changeDir, 'specs'))).map(
(file) =>
`specs/${file.path} is not a capability's spec.md, so \`openspec validate ${changeName}\` rejects it and archive never merges it. ` +
`Move its requirements into specs/${file.expected}.`
);
const hasDeltas = specArtifacts.some(
(artifact) => resolveArtifactOutputs(changeDir, artifact.generates).length > 0
);
if (hasDeltas) return [];
if (hasDeltas) return warnings;
const metadataPath = path.join(changeDir, METADATA_FILENAME);
// The command names the artifact this schema actually declares, never the
@@ -466,6 +491,7 @@ function collectApplyWarnings(input: {
// a placeholder rather than a guess.
const specTarget = specArtifacts.length === 1 ? specArtifacts[0].id : '<artifact-id>';
return [
...warnings,
`This change has no delta specs and does not declare \`skip_specs: true\`, so \`openspec validate ${changeName}\` fails on it. ` +
`Write the delta specs before implementing (\`openspec instructions ${specTarget} --change ${changeName}\`), ` +
`or add \`skip_specs: true\` to ${metadataPath} if this change really changes no specified behavior.`,
@@ -542,15 +568,27 @@ export async function generateApplyInstructions(
}
}
// Parse tasks if tracking file exists
// Parse every concrete file matched by apply.tracks. A tracking path may be
// a glob owned by an artifact with any ID, so treating it as one literal
// path loses task evidence for valid custom schemas.
let parsedTasks: ParsedTask[] = [];
const unavailableTrackingFiles: Array<{ path: string; reason: string }> = [];
let tracksFileExists = false;
if (tracksFile) {
const tracksPath = resolveArtifactOutputPath(changeDir, tracksFile);
tracksFileExists = fs.existsSync(tracksPath);
if (tracksFileExists) {
const tasksContent = await fs.promises.readFile(tracksPath, 'utf-8');
parsedTasks = parseTaskLines(tasksContent);
const tracksPaths = resolveArtifactOutputs(changeDir, tracksFile);
tracksFileExists = tracksPaths.length > 0;
for (const tracksPath of tracksPaths) {
try {
const tasksContent = await fs.promises.readFile(tracksPath, 'utf-8');
parsedTasks.push(...parseTaskLines(tasksContent));
} catch (error) {
const code = (error as NodeJS.ErrnoException)?.code;
const message = error instanceof Error ? error.message : String(error);
unavailableTrackingFiles.push({
path: tracksPath,
reason: code && !message.includes(code) ? `${code}: ${message}` : message,
});
}
}
}
const tasks = toTaskItems(parsedTasks);
@@ -588,6 +626,9 @@ export async function generateApplyInstructions(
instruction =
`The ${tracksFilename} file is missing and must be created.` +
`\n${describeArtifactRemedy(changeName, findArtifactIdFor(schema, tracksFile))}`;
} else if (tracksFile && unavailableTrackingFiles.length > 0 && tasks.length === 0) {
state = 'blocked';
instruction = 'No readable task descriptions are available.';
} else if (tracksFile && tracksFileExists && tasks.length === 0) {
// Tracking file exists but lists nothing an agent can work on: either no
// checkboxes at all, or only checkboxes with no text after them.
@@ -596,7 +637,12 @@ export async function generateApplyInstructions(
instruction =
`The ${tracksFilename} file exists but contains no tasks to work on.` +
`\nAdd tasks to ${tracksFilename}, or rebuild it: ${describeArtifactRemedy(changeName, findArtifactIdFor(schema, tracksFile))}`;
} else if (tracksFile && remaining === 0 && total > 0) {
} else if (
tracksFile &&
unavailableTrackingFiles.length === 0 &&
remaining === 0 &&
total > 0
) {
state = 'all_done';
instruction = 'All tasks are complete! This change is ready to be archived.\nConsider running tests and reviewing the changes before archiving.';
} else if (!tracksFile) {
@@ -608,7 +654,14 @@ export async function generateApplyInstructions(
instruction = schemaInstruction?.trim() ?? 'Read context files, work through pending tasks, mark complete as you go.\nPause if you hit blockers or need clarification.';
}
const warnings = collectApplyWarnings({
if (unavailableTrackingFiles.length > 0) {
const unavailableDetails = unavailableTrackingFiles
.map((file) => `- ${file.path}: ${file.reason}`)
.join('\n');
instruction += `\nTask completion is not verified because tracking evidence was unavailable:\n${unavailableDetails}`;
}
const warnings = await collectApplyWarnings({
state,
schema,
changeDir,
@@ -623,6 +676,8 @@ export async function generateApplyInstructions(
contextFiles,
progress: { total, complete, remaining },
tasks,
taskTrackingConfigured: tracksFile !== null,
...(unavailableTrackingFiles.length > 0 ? { unavailableTrackingFiles } : {}),
state,
missingArtifacts: missingArtifacts.length > 0 ? missingArtifacts : undefined,
...(missingPrerequisites.length > 0 ? { missingPrerequisites } : {}),
@@ -814,6 +869,8 @@ function printOperationInputsText(inputs: {
}): void {
if (inputs.context) {
console.log('### Project Context (required instruction input)');
// Printed verbatim on purpose. Escaping a leading `#` would also fire inside
// fenced code (`# install deps`), so heading forgery is not guarded here.
console.log(inputs.context);
console.log();
}
@@ -821,7 +878,7 @@ function printOperationInputsText(inputs: {
if (inputs.operationGuidance && inputs.operationGuidance.length > 0) {
console.log('### Operation Guidance (advisory)');
for (const guidance of inputs.operationGuidance) {
console.log(`- ${guidance}`);
console.log(`- ${sanitizeInline(guidance, Infinity)}`);
}
console.log();
}
+29
View File
@@ -7,6 +7,7 @@
* this command.
*/
import chalk from 'chalk';
import ora from 'ora';
import path from 'path';
import { createChange, validateChangeName } from '../../utils/change-utils.js';
@@ -85,6 +86,33 @@ function printCreatedChangeHuman(
console.log(`Next: ${withStoreFlag(root, `openspec status --change ${payload.change.id}`)}`);
}
/**
* An implicit root is the fallback taken when no `openspec/` directory was
* found: creating a change there materializes OpenSpec in whatever directory
* the caller happened to be in, which is how an agent ends up adopting a
* project that never ran `openspec init` (#1645). The creation itself stays
* zero-config; this only makes it visible.
*/
function printImplicitRootNotice(root: ResolvedOpenSpecRoot): void {
if (root.source !== 'implicit') {
return;
}
const openspecDir = path.dirname(root.changesDir);
const relative = path.relative(process.cwd(), openspecDir);
const location = relative && !relative.startsWith('..') ? relative : openspecDir;
console.log();
console.log(
chalk.dim(`Note: no OpenSpec root was found here, so one was created at ${location}/.`)
);
console.log(
chalk.dim(
'Run `openspec init` to finish setting this project up, or delete that directory if you meant a different project.'
)
);
}
export async function newChangeCommand(name: string | undefined, options: NewChangeOptions): Promise<void> {
const spinner = options.json ? undefined : ora();
@@ -153,6 +181,7 @@ export async function newChangeCommand(name: string | undefined, options: NewCha
spinner?.stop();
printCreatedChangeHuman(payload, root);
printImplicitRootNotice(root);
} catch (error) {
spinner?.stop();
if (options.json) {
+17
View File
@@ -7,6 +7,10 @@
import chalk from 'chalk';
import path from 'path';
import {
describeNestedChange,
findNestedChangesIn,
} from '../../utils/nested-change.js';
import * as fs from 'fs';
import { getSchemaDir, listSchemas } from '../../core/artifact-graph/index.js';
import type { ReferenceIndexEntry } from '../../core/references.js';
@@ -41,6 +45,11 @@ export interface ApplyInstructions {
remaining: number;
};
tasks: TaskItem[];
taskTrackingConfigured: boolean;
unavailableTrackingFiles?: Array<{
path: string;
reason: string;
}>;
state: 'blocked' | 'all_done' | 'ready';
missingArtifacts?: string[];
/**
@@ -231,6 +240,14 @@ export async function validateChangeExists(
);
}
// The directory exists but is a namespace folder wrapping nested change
// directories. Every artifact lookup below it would report "not started" for
// work that is in fact there, so say what is actually wrong instead (#1846).
const nested = await findNestedChangesIn(changesDir, changeName);
if (nested) {
throw new Error(describeNestedChange(nested));
}
return changeName;
}
+56 -5
View File
@@ -19,7 +19,12 @@ import {
formatChangeStatus,
type ChangeStatus,
} from '../../core/artifact-graph/index.js';
import { resolveNextStep } from '../../core/change-status-policy.js';
import { asStatus } from '../shared-output.js';
import {
describeNestedChange,
findNestedChanges,
} from '../../utils/nested-change.js';
import type { StoreDiagnostic } from '../../core/store/errors.js';
import {
validateChangeExists,
@@ -82,6 +87,11 @@ export async function statusCommand(options: StatusOptions): Promise<void> {
const rootOutput = toRootOutput(root);
const newChangeHint = withStoreFlag(root, 'openspec new change <name>');
// One store-flag decision serves the JSON `nextSteps` sentence and the text
// `Next:` line, so a store-selected root can never carry `--store` in one
// and drop it from the other.
const storeOptions = isStoreSelectedRoot(root) ? { storeId: root.storeId } : {};
// Single definition of "load one change's status" so the batch and
// single-change payloads can never drift apart.
const loadStatus = (changeName: string): ChangeStatus =>
@@ -90,7 +100,7 @@ export async function statusCommand(options: StatusOptions): Promise<void> {
changeDir: getChangeDir(planningHome, changeName),
planningHome,
}),
isStoreSelectedRoot(root) ? { storeId: root.storeId } : {}
storeOptions
);
// Handle no-changes case gracefully — status is informational,
@@ -124,7 +134,25 @@ export async function statusCommand(options: StatusOptions): Promise<void> {
// with the same comparator validate --all uses so the two batch
// commands order a given change set identically.
const entries: BatchStatusEntry[] = [];
// The sweep reads each directory straight through `loadStatus`, so a
// namespace folder wrapping nested changes would report a whole
// artifact plan for work that is not there (#1846). It carries the same
// per-change diagnostic a malformed change does.
const nestedByName = new Map(
(await findNestedChanges(root.changesDir, available)).map((finding) => [
finding.name,
finding,
])
);
for (const changeName of available.sort((a, b) => a.localeCompare(b))) {
const nested = nestedByName.get(changeName);
if (nested) {
entries.push({
changeName,
status: [asStatus(new Error(describeNestedChange(nested)), 'change_error')],
});
continue;
}
try {
entries.push(loadStatus(changeName));
} catch (error) {
@@ -150,7 +178,7 @@ export async function statusCommand(options: StatusOptions): Promise<void> {
console.log();
}
if ('artifacts' in entry) {
printStatusText(entry);
printStatusText(entry, storeOptions);
} else {
console.log(chalk.red(`✗ ${entry.changeName}: ${entry.status[0]?.message}`));
}
@@ -195,14 +223,19 @@ export async function statusCommand(options: StatusOptions): Promise<void> {
return;
}
printStatusText(status);
printStatusText(status, storeOptions);
} catch (error) {
spinner?.stop();
throw error;
}
}
export function printStatusText(status: ChangeStatus): void {
export interface PrintStatusTextOptions {
/** Selected store id, so the printed command carries `--store`. */
storeId?: string;
}
export function printStatusText(status: ChangeStatus, options: PrintStatusTextOptions = {}): void {
const doneCount = status.artifacts.filter((a) => a.status === 'done').length;
const skippedCount = status.artifacts.filter((a) => a.status === 'skipped').length;
const total = status.artifacts.length - skippedCount;
@@ -232,8 +265,26 @@ export function printStatusText(status: ChangeStatus): void {
console.log(line);
}
if (status.isPlanningComplete) {
// Derived from the same inputs as the JSON `nextSteps` sentence, so the two
// surfaces always name the same command. Without this line the text surface
// reports state and no verb, which leaves someone resuming a change - after a
// lost session, or on a change they did not start - with nowhere to go.
const nextStep = resolveNextStep({
changeName: status.changeName,
artifactStatuses: status.artifacts,
allArtifactsComplete: status.isPlanningComplete,
...(options.storeId ? { storeId: options.storeId } : {}),
});
if (status.isPlanningComplete || nextStep) {
console.log();
}
if (status.isPlanningComplete) {
console.log(chalk.green('All planning artifacts complete!'));
}
if (nextStep) {
console.log(`Next: ${nextStep.command}`);
}
}
+330 -80
View File
@@ -21,13 +21,18 @@ import {
writeUpdatedSpec,
retireSpec,
finalizeRetiredSpec,
pruneEmptyDirs,
type SpecUpdate,
} from './specs-apply.js';
import { discoverSpecFiles, hasAnyFileUnder } from '../utils/spec-discovery.js';
import { discoverSpecFiles, findUnreadDeltaFiles, hasAnyFileUnder } from '../utils/spec-discovery.js';
import { METADATA_FILENAME, readRetireCapabilitiesMarker, readSkipSpecsMarker } from '../utils/change-metadata.js';
import { confirmPrompt, isNonInteractivePromptError } from '../utils/interactive.js';
import { FileSystemUtils } from '../utils/file-system.js';
import { folderStyleNameProblem } from './id.js';
import {
describeNestedChange,
findNestedChangesIn,
} from '../utils/nested-change.js';
function isMissingPathError(error: unknown): boolean {
return (
@@ -374,6 +379,17 @@ async function copyDirContents(src: string, dest: string): Promise<void> {
await fs.chmod(dest, sourceStat.mode & 0o7777);
}
type TreeEntry = { relative: string; kind: 'directory' | 'file' | 'symlink' };
/** SHA-256 of one file's bytes, streamed so a large file is never held whole. */
async function fingerprintFileContents(filePath: string): Promise<Buffer> {
const fileHash = createHash('sha256');
for await (const chunk of createReadStream(filePath)) {
fileHash.update(chunk);
}
return fileHash.digest();
}
async function fingerprintDirectoryContents(root: string): Promise<string> {
const hash = createHash('sha256');
const updateHashField = (label: string, value: string | Buffer): void => {
@@ -386,13 +402,7 @@ async function fingerprintDirectoryContents(root: string): Promise<string> {
hash.update(labelBuffer);
hash.update(valueBuffer);
};
const fingerprintFile = async (filePath: string): Promise<Buffer> => {
const fileHash = createHash('sha256');
for await (const chunk of createReadStream(filePath)) {
fileHash.update(chunk);
}
return fileHash.digest();
};
const fingerprintFile = fingerprintFileContents;
const visit = async (dir: string, relativeDir: string): Promise<void> => {
const before = await fs.lstat(dir, { bigint: true });
@@ -466,14 +476,225 @@ async function assertCopiedDirectoryUnchanged(
/**
* Move a directory from src to dest. On Windows, fs.rename() can fail with
* EPERM, and cross-device moves fail with EXDEV. When the source can first be
* renamed to a private sibling, fall back to a verified copy-then-remove. A
* source that cannot be staged is left untouched rather than copied and deleted
* through a path another process may still be editing.
* EPERM, and cross-device moves fail with EXDEV. Prefer renaming the source
* to a private sibling first, then copy-then-remove. When that staging rename
* also fails with EPERM/EXDEV — the usual Windows case for a directory that
* still has children, because a watcher holds a directory-enumeration handle —
* copy from the original source instead. Fingerprints still abort if the tree
* changes mid-copy. A staging failure that is not EPERM/EXDEV still leaves
* the source untouched rather than copying through a path we could not claim.
*/
class MoveDestinationRetainedError extends Error {}
class RetirementBackupsRetainedError extends Error {}
function isFallbackRenameCode(code: string | undefined): boolean {
return code === 'EPERM' || code === 'EXDEV';
}
/**
* Every entry under `root`, deepest first, as paths relative to it.
*
* The listing is what bounds the removal below. Anything that appears after it
* is simply not in the set, so it cannot be deleted by the cleanup.
*/
async function listTreeEntriesDeepestFirst(
root: string
): Promise<TreeEntry[]> {
const entries: TreeEntry[] = [];
const visit = async (dir: string, relativeDir: string): Promise<void> => {
for (const entry of await fs.readdir(dir, { withFileTypes: true })) {
const relative = relativeDir === '' ? entry.name : path.join(relativeDir, entry.name);
if (entry.isDirectory()) {
await visit(path.join(dir, entry.name), relative);
entries.push({ relative, kind: 'directory' });
} else {
// A symlink to a directory is not a directory here, and its content is
// its target, not bytes to read - reading one raises EISDIR. Record the
// kind so cleanup compares each entry the way the copy wrote it.
entries.push({ relative, kind: entry.isSymbolicLink() ? 'symlink' : 'file' });
}
}
};
await visit(root, '');
return entries;
}
/**
* Remove exactly the entries that were copied and verified, deepest first.
*
* The move is only safe to finish by deleting the source, and the source of the
* unstaged fallback is still the live change directory: the archive claim
* covers the destination, not it. A recursive remove would delete whatever is
* there at that moment, including a file a concurrent writer added after the
* final fingerprint - data that never reached the destination.
*
* Removing a named set instead means a late arrival is never in it. It is left
* on disk, and the `rmdir` of its parent fails with ENOTEMPTY, which the caller
* reports as a retained destination. The move does not complete silently.
*
* `entries` must be listed before the final fingerprint, so that an arrival is
* either caught by that fingerprint or absent from the set.
*
* An edit to a file that is already in the set is covered by claiming each file
* before reading it: `rename` is atomic, so once a file is under its claim name
* the bytes there are ours. A writer that rewrites the file by path after that
* point creates a new file at the original path, which is not in `entries`, is
* never deleted, and makes the parent `rmdir` fail with ENOTEMPTY - reported as
* a retained destination. A writer that got there first is caught by comparing
* the claimed bytes against the copy: on a mismatch the file is put back and
* the move is abandoned with both trees intact, because the destination holds
* the older content and deleting the source would lose the newer.
*
* What remains outside this, as for any copy, is a writer holding an open
* descriptor that writes through it after the comparison. Staging is still
* preferred whenever the rename is permitted at all.
*/
/**
* A claim suffix no entry in this move can already carry.
*
* A fixed suffix collides with a source file that legitimately ends in it:
* claiming `x` would rename it over a real `x.openspec-claim`, and that file's
* own turn would then fail with ENOENT after part of the live source had
* already been removed. So draw a fresh suffix per move and prove it against
* the very set being removed - if no entry ends with the suffix, no claim of
* one entry can land on another.
*/
function makeClaimSuffix(entries: TreeEntry[]): string {
const names = entries.map((entry) => entry.relative);
for (;;) {
const suffix = `.openspec-claim-${randomUUID()}`;
if (!names.some((name) => name.endsWith(suffix))) return suffix;
}
}
/** What the entry holds now, for comparison against the copy. */
async function readEntryIdentity(
entryPath: string,
kind: 'file' | 'symlink'
): Promise<string> {
return kind === 'symlink'
? `symlink:${await fs.readlink(entryPath)}`
: `file:${(await fingerprintFileContents(entryPath)).toString('hex')}`;
}
async function removeVerifiedTree(
root: string,
entries: TreeEntry[],
destination: string
): Promise<void> {
const claimSuffix = makeClaimSuffix(entries);
for (const entry of entries) {
const target = path.join(root, entry.relative);
if (entry.kind === 'directory') {
await fs.rmdir(target);
continue;
}
const claimed = target + claimSuffix;
await fs.rename(target, claimed);
let claimedIdentity: string;
let copiedIdentity: string;
try {
claimedIdentity = await readEntryIdentity(claimed, entry.kind);
copiedIdentity = await readEntryIdentity(
path.join(destination, entry.relative),
entry.kind
);
} catch (error) {
await fs.rename(claimed, target).catch(() => undefined);
throw error;
}
if (claimedIdentity !== copiedIdentity) {
await fs.rename(claimed, target).catch(() => undefined);
throw new Error(
`${target} changed after it was verified, so the copy at ${destination} ` +
'does not hold its current content.'
);
}
await fs.rm(claimed, { force: true });
}
await fs.rmdir(root);
}
async function copyThenRemoveDirectory(
source: string,
dest: string,
options: {
verifyCopiedDestination?: (copiedSource: string) => Promise<void>;
},
restoreSource?: () => Promise<void>
): Promise<void> {
let destIsOurs = false;
let sourceFingerprint: string;
try {
sourceFingerprint = await fingerprintDirectoryContents(source);
await fs.mkdir(dest, { mode: 0o700 });
destIsOurs = true;
await copyDirContents(source, dest);
await options.verifyCopiedDestination?.(source);
await assertCopiedDirectoryUnchanged(source, dest, sourceFingerprint);
} catch (copyError) {
if (destIsOurs) {
await fs.rm(dest, { recursive: true, force: true }).catch(() => undefined);
}
if (restoreSource) {
try {
await restoreSource();
} catch (restoreError) {
throw new Error(
`${copyError instanceof Error ? copyError.message : String(copyError)} ` +
`Could not restore the staged source at ${source} ` +
`(${restoreError instanceof Error ? restoreError.message : String(restoreError)}).`
);
}
}
if ((copyError as NodeJS.ErrnoException).code === 'EEXIST') {
throw new ArchiveBlockedError(
'archive_target_exists',
`Archive '${path.basename(dest)}' already exists.`
);
}
throw copyError;
}
let verifiedEntries: TreeEntry[];
try {
// Listed before the verification, not after it. A file that arrives before
// the fingerprint changes it and aborts the move; one that arrives after is
// not in this set. Listing afterwards would leave a window in which an
// arrival is both unverified and deletable.
verifiedEntries = await listTreeEntriesDeepestFirst(source);
await options.verifyCopiedDestination?.(source);
await assertCopiedDirectoryUnchanged(source, dest, sourceFingerprint);
} catch (verificationError) {
await fs.rm(dest, { recursive: true, force: true }).catch(() => undefined);
if (restoreSource) {
try {
await restoreSource();
} catch (restoreError) {
throw new Error(
`${verificationError instanceof Error ? verificationError.message : String(verificationError)} ` +
`Could not restore the staged source at ${source} ` +
`(${restoreError instanceof Error ? restoreError.message : String(restoreError)}).`
);
}
}
throw verificationError;
}
try {
await removeVerifiedTree(source, verifiedEntries, dest);
} catch (cleanupError) {
// Removal may already have deleted part of the source, or stopped on an
// entry that appeared after verification. The destination is now the only
// complete copy, so never erase it while trying to make this failed move
// look atomic.
throw new MoveDestinationRetainedError(
`Copied ${source} to ${dest}, but could not remove the source at ` +
`${source} completely ` +
`(${cleanupError instanceof Error ? cleanupError.message : String(cleanupError)}). ` +
'The complete destination was retained for recovery.'
);
}
}
async function moveDirectory(
src: string,
dest: string,
@@ -493,76 +714,25 @@ async function moveDirectory(
`Archive '${path.basename(dest)}' already exists.`
);
}
if (code === 'EPERM' || code === 'EXDEV') {
if (isFallbackRenameCode(code)) {
const stagedSource = path.join(path.dirname(src), `.openspec-move-${randomUUID()}`);
try {
await fs.rename(src, stagedSource);
} catch (stageError) {
const stageCode = (stageError as NodeJS.ErrnoException)?.code;
if (isFallbackRenameCode(stageCode)) {
await copyThenRemoveDirectory(src, dest, options);
return;
}
throw new Error(
`Could not safely stage ${src} before the fallback archive copy ` +
`(${stageError instanceof Error ? stageError.message : String(stageError)}). ` +
'No fallback copy was attempted.'
);
}
let destIsOurs = false;
let stagedFingerprint: string;
try {
stagedFingerprint = await fingerprintDirectoryContents(stagedSource);
await fs.mkdir(dest, { mode: 0o700 });
destIsOurs = true;
await copyDirContents(stagedSource, dest);
await options.verifyCopiedDestination?.(stagedSource);
await assertCopiedDirectoryUnchanged(stagedSource, dest, stagedFingerprint);
} catch (copyError) {
if (destIsOurs) {
await fs.rm(dest, { recursive: true, force: true }).catch(() => undefined);
}
try {
await fs.rename(stagedSource, src);
} catch (restoreError) {
throw new Error(
`${copyError instanceof Error ? copyError.message : String(copyError)} ` +
`Could not restore the staged source at ${stagedSource} ` +
`(${restoreError instanceof Error ? restoreError.message : String(restoreError)}).`
);
}
if ((copyError as NodeJS.ErrnoException).code === 'EEXIST') {
throw new ArchiveBlockedError(
'archive_target_exists',
`Archive '${path.basename(dest)}' already exists.`
);
}
throw copyError;
}
try {
await options.verifyCopiedDestination?.(stagedSource);
await assertCopiedDirectoryUnchanged(stagedSource, dest, stagedFingerprint);
} catch (verificationError) {
await fs.rm(dest, { recursive: true, force: true }).catch(() => undefined);
try {
await fs.rename(stagedSource, src);
} catch (restoreError) {
throw new Error(
`${verificationError instanceof Error ? verificationError.message : String(verificationError)} ` +
`Could not restore the staged source at ${stagedSource} ` +
`(${restoreError instanceof Error ? restoreError.message : String(restoreError)}).`
);
}
throw verificationError;
}
try {
await fs.rm(stagedSource, { recursive: true, force: true });
} catch (cleanupError) {
// Recursive removal may already have deleted part of the source. The
// destination is now the only complete copy, so never erase it while
// trying to make this failed move look atomic.
throw new MoveDestinationRetainedError(
`Copied ${src} to ${dest}, but could not remove the staged source at ` +
`${stagedSource} completely ` +
`(${cleanupError instanceof Error ? cleanupError.message : String(cleanupError)}). ` +
'The complete destination was retained for recovery.'
);
}
await copyThenRemoveDirectory(stagedSource, dest, options, async () => {
await fs.rename(stagedSource, src);
});
} else {
throw err;
}
@@ -594,6 +764,21 @@ interface ArchiveClaim {
contents: string;
}
interface ArchiveClaimFileIdentity {
dev: bigint;
ino: bigint;
}
function isSameArchiveClaimFile(
first: ArchiveClaimFileIdentity,
second: ArchiveClaimFileIdentity
): boolean {
return (
first.ino === second.ino &&
(first.dev === second.dev || first.dev === 0n || second.dev === 0n)
);
}
async function releaseArchiveClaim(
claim: ArchiveClaim,
claimPath: string
@@ -609,10 +794,8 @@ async function releaseArchiveClaim(
const contents = await fs.readFile(claimPath, 'utf8');
const currentAfterRead = await fs.lstat(claimPath, { bigint: true });
if (
current.dev === owned.dev &&
current.ino === owned.ino &&
current.dev === currentAfterRead.dev &&
current.ino === currentAfterRead.ino &&
isSameArchiveClaimFile(current, owned) &&
isSameArchiveClaimFile(current, currentAfterRead) &&
contents === claim.contents
) {
await fs.unlink(claimPath);
@@ -656,6 +839,14 @@ async function claimArchiveDestination(
interface SpecSnapshot {
target: string;
existed: boolean;
/**
* The deepest directory at or above the target's parent that already existed
* before the mutation. Rollback prunes up to but never past it, so a
* capability directory the user already had keeps its permissions and ACLs -
* including an intermediate one under a nested capability id, where only the
* leaf was created by this write.
*/
pruneBoundary?: string;
outcome: 'write' | 'retire';
expectedContent?: Buffer;
content?: Buffer;
@@ -845,7 +1036,31 @@ async function assertDistinctMutationTargets(mutations: SpecMutation[]): Promise
}
}
async function captureSpecSnapshots(mutations: SpecMutation[]): Promise<SpecSnapshot[]> {
/**
* The deepest directory at or above `dir` that exists, never going above
* `boundaryDir`. Used as the floor for a rollback prune: everything below it
* was created by the write being undone, and it was not.
*/
async function deepestExistingAncestor(dir: string, boundaryDir: string): Promise<string> {
let current = dir;
for (;;) {
if (current === boundaryDir || !current.startsWith(boundaryDir + path.sep)) {
return boundaryDir;
}
try {
await fs.lstat(current);
return current;
} catch (error) {
if ((error as NodeJS.ErrnoException).code !== 'ENOENT') throw error;
}
current = path.dirname(current);
}
}
async function captureSpecSnapshots(
mutations: SpecMutation[],
mainSpecsDir: string
): Promise<SpecSnapshot[]> {
return Promise.all(
mutations.map(async ({ update, outcome, rebuilt }) => {
try {
@@ -891,6 +1106,10 @@ async function captureSpecSnapshots(mutations: SpecMutation[]): Promise<SpecSnap
target: update.target,
existed: false,
outcome,
pruneBoundary: await deepestExistingAncestor(
path.dirname(update.target),
mainSpecsDir
),
...(outcome === 'write' ? { expectedContent: Buffer.from(rebuilt) } : {}),
};
}
@@ -900,7 +1119,10 @@ async function captureSpecSnapshots(mutations: SpecMutation[]): Promise<SpecSnap
);
}
async function restoreSpecSnapshots(snapshots: SpecSnapshot[]): Promise<void> {
async function restoreSpecSnapshots(
snapshots: SpecSnapshot[],
mainSpecsDir: string
): Promise<void> {
const errors: Error[] = [];
for (const snapshot of [...snapshots].reverse()) {
try {
@@ -991,6 +1213,13 @@ async function restoreSpecSnapshots(snapshots: SpecSnapshot[]): Promise<void> {
if (!snapshot.existed) {
await fs.rm(snapshot.target, { force: true });
// Only a capability directory this write created is ours to take back.
// One the user already had stays, empty or not, with its own mode -
// pruneEmptyDirs never removes its boundary.
await pruneEmptyDirs(
path.dirname(snapshot.target),
snapshot.pruneBoundary ?? mainSpecsDir
);
continue;
}
if (snapshot.symlink !== undefined) {
@@ -1177,6 +1406,19 @@ export class ArchiveCommand {
);
}
// Archiving a namespace folder moves an active, unfinished change into the
// archive under a name nobody will look for, and never applies its deltas.
// That is silent data loss, so it is refused outright rather than warned
// about (#1846).
const nested = await findNestedChangesIn(changesDir, changeName);
if (nested) {
throw new ArchiveBlockedError(
'archive_change_is_namespace_folder',
`Cannot archive '${changeName}': ${describeNestedChange(nested)}`,
`Rename openspec/changes/${nested.nested[0]}/ to a flat change directory, then archive it.`
);
}
const skipValidation = options.validate === false || options.noValidate === true;
// Validate specs and change before archiving
@@ -1225,6 +1467,13 @@ export class ArchiveCommand {
// folder, so only a regular file counts.
const rootSpecStat = await fs.stat(path.join(changeSpecsDir, 'spec.md')).catch(() => null);
let hasDeltaSpecs = rootSpecStat?.isFile() === true;
// Likewise for delta sections in any other file the merge path does not
// read (specs/<capability>.md, a note beside spec.md): without this the
// zero-delta leniency below archives the change as done with nothing
// merged, although validate rejects it.
if (!hasDeltaSpecs) {
hasDeltaSpecs = (await findUnreadDeltaFiles(changeSpecsDir)).length > 0;
}
// A change that declares skip_specs must not carry any file under
// specs/ — validate reports that as a conflict, so archive has to run
// the same check instead of skipping validation because the files
@@ -1719,7 +1968,7 @@ export class ArchiveCommand {
);
}
}
const specSnapshots = await captureSpecSnapshots(mutations);
const specSnapshots = await captureSpecSnapshots(mutations, mainSpecsDir);
const specSnapshotsByTarget = new Map(
specSnapshots.map((snapshot) => [snapshot.target, snapshot])
);
@@ -1991,7 +2240,8 @@ export class ArchiveCommand {
const rollbackErrors: Error[] = [];
try {
await restoreSpecSnapshots(
specSnapshots.filter(({ target }) => mutationAttempts.has(target))
specSnapshots.filter(({ target }) => mutationAttempts.has(target)),
mainSpecsDir
);
} catch (rollbackError) {
rollbackErrors.push(
+45 -15
View File
@@ -3,11 +3,31 @@ import * as path from 'node:path';
import fg from 'fast-glob';
import { FileSystemUtils } from '../../utils/file-system.js';
const EXTGLOB_RE = /[!*+?@]\([^(]*\)/u;
const BRACE_EXPANSION_SEPARATORS_RE = /,|\.\./u;
function hasBraceExpansion(pattern: string): boolean {
const openings: number[] = [];
for (let index = 0; index < pattern.length; index += 1) {
if (pattern[index] === '{') openings.push(index);
if (pattern[index] !== '}') continue;
const opening = openings.pop();
if (opening !== undefined && BRACE_EXPANSION_SEPARATORS_RE.test(pattern.slice(opening, index))) {
return true;
}
}
return false;
}
/**
* Checks if a path contains glob pattern characters.
* Recognizes artifact globs while preserving literal output filenames.
*/
export function isGlobPattern(pattern: string): boolean {
return pattern.includes('*') || pattern.includes('?') || pattern.includes('[');
// Keep the original wildcard rules and recognize brace expansions and extglobs.
// Its full dynamic predicate also reinterprets literal !, parentheses, and backslashes.
const normalized = FileSystemUtils.toPosixPath(pattern);
return normalized.includes('*') || normalized.includes('?') || normalized.includes('[')
|| EXTGLOB_RE.test(normalized) || hasBraceExpansion(normalized);
}
/**
@@ -108,20 +128,30 @@ export function resolveArtifactOutputs(changeDir: string, generates: string): st
}
const normalizedPattern = FileSystemUtils.toPosixPath(generates);
assertGlobDirectoryTraversal(
changeDir,
changeDir,
normalizedPattern.split('/').slice(0, -1)
);
const globOptions = {
cwd: changeDir,
onlyFiles: true,
absolute: true,
// Preserve linked artifact directories; confine traversal and concrete matches.
followSymbolicLinks: true,
};
// Task generation expands braces without accessing the filesystem. Validate
// every task base before globbing, including paths introduced by expansion.
const tasks = fg.generateTasks(normalizedPattern, globOptions);
for (const task of tasks) {
FileSystemUtils.assertPathWithin(changeDir, path.resolve(changeDir, task.base));
}
for (const task of tasks) {
for (const positivePattern of task.positive) {
assertGlobDirectoryTraversal(
changeDir,
changeDir,
positivePattern.split('/').slice(0, -1)
);
}
}
const matches = fg
.sync(normalizedPattern, {
cwd: changeDir,
onlyFiles: true,
absolute: true,
// Preserve existing support for linked artifact directories. Every
// concrete match is canonically confined below before it is returned.
followSymbolicLinks: true,
})
.sync(normalizedPattern, globOptions)
.map((match) => {
const normalizedMatch = path.normalize(match);
FileSystemUtils.assertPathWithin(changeDir, normalizedMatch);
+58
View File
@@ -38,6 +38,9 @@ export function parseSchema(yamlContent: string): SchemaYaml {
// Check that all requires references are valid
validateRequiresReferences(schema.artifacts);
// Check that the apply phase names artifacts this schema declares
validateApplyReferences(schema);
// Check for cycles
validateNoCycles(schema.artifacts);
@@ -74,6 +77,61 @@ function validateRequiresReferences(artifacts: Artifact[]): void {
}
}
/**
* Validates that every `apply.requires` id is an artifact the schema declares.
*
* Apply skips an id that no artifact declares, so a typo silently dropped that
* artifact from the apply gate. An unknown artifact `requires` is already a
* load error, and this is the same kind of reference.
*
* `apply.tracks` is deliberately not checked here. It is a path, not an id:
* apply reads it as written, so a schema whose `tracks` value does not exactly
* match any `generates` value (a hand-written `TODO.md`, or `tasks/main.md`
* under a glob `generates: tasks/*.md` that really does produce it) works
* today, and failing the load would break every command on it.
* `openspec schema validate` reports that case as a warning instead
* (see `findApplyTracksWarning`).
*/
function validateApplyReferences(schema: SchemaYaml): void {
const apply = schema.apply;
if (!apply) return;
const validIds = schema.artifacts.map(a => a.id);
for (const req of apply.requires) {
if (!validIds.includes(req)) {
throw new SchemaValidationError(
`Invalid apply.requires reference: '${req}' does not exist (artifacts: ${validIds.join(', ')})`
);
}
}
}
/**
* Describes an `apply.tracks` value that is not exactly equal to any artifact's
* `generates` value, or returns undefined when there is nothing to report.
*
* The tracked-tasks lookups select the artifact whose `generates` string equals
* `tracks`, so this is a progress-discovery problem, not a claim that nothing
* produces the file: a glob `generates: tasks/*.md` really does generate
* `tracks: tasks/main.md`, yet the strings differ, so the lookup still misses.
* Either way apply keeps working (it reads the path directly), but `openspec
* list` and `openspec status` fall back to counting the top-level `tasks.md`,
* and apply's remedy cannot name an artifact to build. A typo such as
* `task.md` is the other usual cause.
*/
export function findApplyTracksWarning(schema: SchemaYaml): string | undefined {
const tracks = schema.apply?.tracks;
if (tracks == null || schema.artifacts.some(a => a.generates === tracks)) return undefined;
return (
`apply.tracks '${tracks}' does not exactly match any artifact's generates value ` +
`(generates: ${schema.artifacts.map(a => a.generates).join(', ')}), ` +
`so OpenSpec cannot tell which artifact's progress it tracks. ` +
`Apply still reads that file as written, but list and status count tasks.md instead. ` +
`Make apply.tracks exactly equal one of those generates values, ` +
`or confirm that file is maintained outside the artifact graph.`
);
}
/**
* Validates that there are no cyclic dependencies.
* Uses DFS to detect cycles and reports the full cycle path.
+13 -1
View File
@@ -22,6 +22,10 @@ function relativePathSchema(fieldName: string) {
}
// Artifact definition schema
// Upper bound on artifacts in one schema. Keeps `validateNoCycles`' recursive
// DFS well inside the stack limit for any accepted input.
const MAX_ARTIFACTS = 1000;
export const ArtifactSchema = z.object({
id: z.string().min(1, { error: 'Artifact ID is required' }),
generates: relativePathSchema('generates field'),
@@ -46,7 +50,15 @@ export const SchemaYamlSchema = z.object({
name: z.string().min(1, { error: 'Schema name is required' }),
version: z.number().int().positive({ error: 'Version must be a positive integer' }),
description: z.string().optional(),
artifacts: z.array(ArtifactSchema).min(1, { error: 'At least one artifact required' }),
artifacts: z
.array(ArtifactSchema)
.min(1, { error: 'At least one artifact required' })
// Bounded so a hostile schema cannot drive the cycle-detection DFS past the
// V8 stack limit and crash with an uncaught RangeError instead of a
// validation error.
.max(MAX_ARTIFACTS, {
error: `A schema may declare at most ${MAX_ARTIFACTS} artifacts`,
}),
// Optional apply phase configuration (for schema-aware apply instructions)
apply: ApplyPhaseSchema.optional(),
});
+31 -10
View File
@@ -62,20 +62,41 @@ export function buildActionContext(input: ActionContextInput): ActionContext {
};
}
export function buildNextSteps(input: ChangeNextStepsInput): string[] {
/**
* The one next action for a change, in both the forms the CLI needs.
*
* `sentence` is what the JSON `nextSteps` contract publishes; `command` is the
* bare command the text surface prints. Both are built here so the two
* surfaces can never name a different next step.
*/
export interface ChangeNextStep {
/** Ready-to-run command, including any `--store` flag. */
command: string;
/** Sentence form carried by the JSON `nextSteps` array. */
sentence: string;
}
export function resolveNextStep(input: ChangeNextStepsInput): ChangeNextStep | undefined {
const readyArtifact = input.artifactStatuses.find((artifact) => artifact.status === 'ready');
const steps: string[] = [];
const storeFlag = input.storeId ? ` --store ${input.storeId}` : '';
if (readyArtifact) {
steps.push(
`Run openspec instructions ${readyArtifact.id} --change "${input.changeName}"${storeFlag} --json before writing that artifact.`
);
} else if (input.allArtifactsComplete) {
steps.push(
`All planning artifacts are complete. Run openspec instructions apply --change "${input.changeName}"${storeFlag} --json to inspect implementation progress.`
);
const command = `openspec instructions ${readyArtifact.id} --change "${input.changeName}"${storeFlag} --json`;
return { command, sentence: `Run ${command} before writing that artifact.` };
}
return steps;
if (input.allArtifactsComplete) {
const command = `openspec instructions apply --change "${input.changeName}"${storeFlag} --json`;
return {
command,
sentence: `All planning artifacts are complete. Run ${command} to inspect implementation progress.`,
};
}
return undefined;
}
export function buildNextSteps(input: ChangeNextStepsInput): string[] {
const step = resolveNextStep(input);
return step ? [step.sentence] : [];
}
@@ -21,12 +21,16 @@ export const continueAdapter: ToolCommandAdapter = {
},
formatFile(content: CommandContent): string {
// Continue injects an invoked prompt into the model context. Smaller local
// models can otherwise mistake the workflow name for a tool to call (#925).
return `---
name: ${escapeYamlValue(`opsx-${content.id}`)}
description: ${escapeYamlValue(content.description)}
invokable: true
---
This workflow prompt is already active. Follow its instructions directly. Do not call a tool named after this workflow.
${content.body}
`;
},

Some files were not shown because too many files have changed in this diff Show More