Skip to content

usage.md

Latest commit

 

History

History
90 lines (64 loc) · 3.09 KB

usage.md

File metadata and controls

90 lines (64 loc) · 3.09 KB
Raw

Usage Guide

Back to README | 中文

This document describes the recommended way to use opencode-spec.

1. Install the Plugin

Configure opencode.json in the project root:

{
  "$schema": "https://opencode.ai/config.json",
  "plugin": ["@devcxl/opencode-spec"]
}

Prerequisite: the shell used by OpenCode must be able to run node directly.

Reason: skills invoke JavaScript reference scripts that run via node.

2. Workflow

propose → apply → archive
explore (optional, use anytime)

propose

Create change and generate proposal / specs / design / tasks.

explore

Explore problems, clarify requirements. No implementation.

apply

Implement tasks and mark them complete.

archive

Archive completed change.

3. Entry Points

Core Commands

Type Entry Description
Command /opsx-propose Recommended starting point: create change and all planning artifacts
Command /opsx-explore Requirement exploration
Command /opsx-apply Task implementation
Command /opsx-archive Archive completed
Skill openspec-propose Agent invokes directly
Skill openspec-explore Agent invokes directly
Skill openspec-apply Agent invokes directly
Skill openspec-archive Agent invokes directly

Extension Commands

Type Entry Description
Command /opsx-new-change Start a new change, step by step
Command /opsx-continue-change Continue to the next artifact
Command /opsx-ff-change Generate all planning artifacts quickly
Command /opsx-update-change Revise planning artifacts coherently
Command /opsx-sync-specs Sync delta specs to main specs
Command /opsx-verify-change Verify implementation matches artifacts
Command /opsx-bulk-archive Archive multiple changes at once
Command /opsx-onboard Guided full workflow tutorial
Skill openspec-new-change Agent invokes directly
Skill openspec-continue-change Agent invokes directly
Skill openspec-ff-change Agent invokes directly
Skill openspec-update-change Agent invokes directly
Skill openspec-sync-specs Agent invokes directly
Skill openspec-verify-change Agent invokes directly
Skill openspec-bulk-archive-change Agent invokes directly
Skill openspec-onboard Agent invokes directly

4. Built-in Reference Scripts

Each skill includes JavaScript scripts in the plugin's assets/skills/<skill-name>/references/ directory, executed via node:

  • openspec-propose: new-change.js, status.js, instructions.js
  • openspec-explore: list.js
  • openspec-apply: prepare-apply.js, mark-tasks.js
  • openspec-archive: archive.js

These scripts replace external openspec CLI and directly manipulate the openspec/ directory structure. Extension skills (new-change / continue-change / ff-change / update-change / verify-change / sync-specs / bulk-archive-change / onboard) reuse the core scripts above for their workflows.