Skip to content

Commit 316a139

Browse files
committed
docs(plugin): add marketplace install and skill reference to README
Document plugin installation via marketplace, local development auto-discovery, and list all 28 skills by category.
1 parent 273323b commit 316a139

1 file changed

Lines changed: 72 additions & 0 deletions

File tree

README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,3 +237,75 @@ spm md2json ./.spm .spm.json
237237
```
238238

239239
> **Important:** Always keep `.spm.json` and `./.spm/` up to date with current activity and in sync with each other. Record all decisions, changes, and new capabilities as they happen. After any change to either representation, run the appropriate conversion command above. Validate with `spm validate` before committing.
240+
241+
## Claude Code Plugin
242+
243+
SysProM is available as a Claude Code plugin with 28 skills for managing provenance documents. The plugin is defined in `.claude-plugin/marketplace.json` with skills in `.claude/skills/`.
244+
245+
### Install from Marketplace
246+
247+
```sh
248+
# Add the SysProM marketplace
249+
/plugin marketplace add ExaDev/SysProM
250+
251+
# Install the plugin
252+
/plugin install sysprom@sysprom
253+
```
254+
255+
Skills are namespaced when installed as a plugin (e.g. `/sysprom:add-decision`, `/sysprom:query-nodes`).
256+
257+
### Local Development
258+
259+
When working on the SysProM repo itself, skills in `.claude/skills/` are auto-discovered without plugin installation. Skills use short names (e.g. `/add-decision`, `/query-nodes`).
260+
261+
### Skills by Category
262+
263+
**Node Creation (4 skills)**
264+
- `add-decision` — Create decision nodes with context, options, rationale, and invariant links
265+
- `add-change` — Create change nodes with scope, operations, and task tracking
266+
- `add-invariant` — Create invariant nodes representing system rules and constraints
267+
- `add-node` — Generic node creation for any SysProM type
268+
269+
**Node Modification (3 skills)**
270+
- `update-node` — Modify node fields, status, lifecycle, context, or rationale
271+
- `remove-node` — Delete nodes with safety flags (hard delete, recursive, repair)
272+
- `rename-node` — Rename node IDs across all references
273+
274+
**Relationships (2 skills)**
275+
- `add-relationship` — Create relationships between nodes with specific types
276+
- `remove-relationship` — Delete relationships
277+
278+
**Query & Analysis (5 skills)**
279+
- `query-nodes` — Search nodes by type, status, text, or ID
280+
- `query-relationships` — Query relationships by source, target, or type
281+
- `trace-node` — Trace refinement chains through abstraction layers
282+
- `check-document` — Validate document structure and report issues
283+
- `stats` — Show document statistics and composition metrics
284+
285+
**Visualisation (1 skill)**
286+
- `graph` — Generate Mermaid or DOT graphs with filtering
287+
288+
**Format Conversion (4 skills)**
289+
- `init-document` — Create new SysProM documents with metadata
290+
- `json-to-markdown` — Convert JSON to Markdown format
291+
- `markdown-to-json` — Convert Markdown to JSON format
292+
- `sync-formats` — Bidirectional sync between JSON and Markdown
293+
294+
**Spec-Kit Integration (4 skills)**
295+
- `speckit-import` — Import Spec-Kit features as SysProM nodes
296+
- `speckit-export` — Export SysProM nodes to Spec-Kit format
297+
- `speckit-sync` — Bidirectional sync with Spec-Kit specifications
298+
- `speckit-diff` — Show differences between SysProM and Spec-Kit
299+
300+
**Task Management (3 skills)**
301+
- `task-list` — List tasks in a change node with progress
302+
- `task-add` — Add tasks to a change
303+
- `task-mark-done` — Mark tasks as complete
304+
305+
**Plan Management (2 skills)**
306+
- `plan-init` — Initialise plans with phases and gates
307+
- `plan-status` — Show plan progress and phase gates
308+
309+
### Fallback to `npx`
310+
311+
If `spm` is not globally installed, skills automatically fall back to `npx -y sysprom` for command execution. All skills work with either global or per-project installation.

0 commit comments

Comments
 (0)