realpython/materials/openspec-archive-change

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.

Steps

1. Select the change

If a name is provided, use it. Otherwise:

• Infer from conversation context if the user mentioned a change
• 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 only active changes (not already archived). Include the schema used for each change if available.

Always announce: "Using change: <name>" and how to override (e.g., /opsx:archive <other>).

Load current archive inputs before the existing archive checks:

After resolving the selected change and planning root, run: ``bash openspec instructions archive --change "<name>" --json `` Keep the same selected-root flags on this command. This lookup is advisory and optional: it only supplies extra prompt inputs, so it must never block archiving. If it exits non-zero or returns invalid JSON — for example on an older CLI that does not support this command yet — continue the archive workflow with no context and no operation guidance. Do not report an error and do not stop.

A successful response may omit both optional fields. Treat context as a required prompt-level input: read and consider it, and apply relevant project facts, conventions, and constraints. Treat operationGuidance as optional additive advice: read and consider every entry, and follow entries that are applicable and compatible with the built-in archive workflow.

Keep both fields separate from built-in steps, explicit user choices, resolved paths, CLI checks, and command contracts. If context conflicts with one of those controlling inputs, report the conflict and preserve the controlling value. If guidance is inapplicable or conflicts with a controlling input, do not follow it and explain why. Do not infer replacement paths, skipped prompts, or flags from either field, and do not copy their text verbatim into specs, change artifacts, or archive summaries unless the user separately asks for it. These are prompt-level behavior contracts, not enforceable checks.

1. Check artifact completion status

Run openspec status --change "<name>" --json to check artifact completion.

Parse the JSON to understand:

• schemaName: The workflow being used
• planningHome, changeRoot, artifactPaths, and actionContext: path and scope context
• artifacts: List of artifacts with their status (done, skipped, or other)

If any artifacts are neither `done` nor `skipped` (skipped artifacts satisfy the requirement - the change declares skip_specs):

• Display warning listing incomplete artifacts
• Ask the user to confirm they want to proceed
• Proceed if user confirms

1. Check task completion status

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.

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 `totalTasks` is zero: Proceed without a task-related warning.

1. Assess delta spec sync state

Use artifactPaths.specs.existingOutputPaths from status JSON as the only delta-spec source. If the specs entry is missing or existingOutputPaths is empty, proceed without a sync prompt and do not infer delta specs from other artifacts.

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)
• Continue assessing the remaining capabilities even when one is sync-blocked. Show a combined summary before prompting.

Prompt options:

• 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). 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 openspec instructions specs --change "<name>" --json once with the same selected-root flags. Require a zero exit status and valid artifact-instruction JSON. If the lookup fails or returns invalid JSON, report the error and stop before writing any main spec or moving the change. A valid response with omitted rules is the no-rules case. Apply returned rules only to the content and form of main specs produced by this merge; do not use them as archive guidance, change CLI behavior, or copy the rule text into any output file.

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.

If the sync reports any stop or blocking condition, treat the sync as failed. Stop the archive immediately. Do not perform the post-sync content comparison and do not move its changeRoot. Nothing has moved, so the user can fix the blocking condition or re-run the sync.