@wardrail/plugin 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +64 -52
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,52 +1,64 @@
1
- # @wardrail/plugin
2
-
3
- The **Wardrail Claude Code plugin**. One install gives your coding agent two things:
4
-
5
- 1. **The Wardrail contract, while it codes** — the four [`@wardrail/mcp`](https://www.npmjs.com/package/@wardrail/mcp)
6
- tools (`get_contract`, `check_path`, `get_findings`, `review_diff`), so the agent stays
7
- on the rails *before* a violation lands.
8
- 2. **A context-saving workflow** `/task` and `/checkpoint` slash commands, a SessionStart
9
- resume listing, and a machine **verifier** so a checkpoint *can't lie*: it reconciles a
10
- task file's claims against `git`, a real test run, and a diff scan before it's allowed to
11
- be marked done.
12
-
13
- This is the same anti-drift, verify-don't-trust thesis Wardrail applies to your *code*,
14
- turned on the agent's own working memory.
15
-
16
- ## Install
17
-
18
- ```bash
19
- # add the marketplace (served by Wardrail), then install the plugin
20
- claude plugin marketplace add https://wardrail.ghostables.io/marketplace.json
21
- claude plugin install wardrail@wardrail
22
- ```
23
-
24
- At enable time you'll be asked for:
25
-
26
- | Value | Required | What it is |
27
- |---|---|---|
28
- | `WARDRAIL_URL` | no | Your Wardrail server. Defaults to `https://wardrail.ghostables.io`. |
29
- | `WARDRAIL_INGEST_TOKEN` | **yes** | Project-scoped token from Wardrail → **Trust → Attest from CI**. Scopes reads to one project; never grants account access. |
30
- | `ANTHROPIC_API_KEY` | no | Only for `wardrail_review_diff`. Stays on your machine; Wardrail never sees it. |
31
-
32
- These feed the bundled MCP server's environment via `${user_config.*}`. The `@wardrail/mcp`
33
- server is fetched on demand by `npx`.
34
-
35
- ## What's in the box
36
-
37
- ```
38
- .claude-plugin/plugin.json manifest + userConfig prompts
39
- skills/task/SKILL.md /task new|resume <slug>
40
- skills/checkpoint/SKILL.md /checkpoint (runs the verifier)
41
- hooks/hooks.json SessionStart -> resume listing
42
- hooks/tasks-session-start.mjs
43
- hooks/verify-checkpoint.mjs the machine verifier
44
- .mcp.json the Wardrail MCP server (npx -y @wardrail/mcp)
45
- ```
46
-
47
- ## The workflow
48
-
49
- `/checkpoint``/clear` → `/task resume <slug>`. Task files live per-project in
50
- `./tasks/<slug>.md` and carry a small, honest snapshot so a fresh session rehydrates from
51
- ~3k tokens instead of a 150k transcript. `/checkpoint` stamps a tamper-evident
52
- `## Verification` block; `status: done` over a failed check is downgraded to FAIL.
1
+ # @wardrail/plugin
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@wardrail/plugin)](https://www.npmjs.com/package/@wardrail/plugin)
4
+ [![license](https://img.shields.io/npm/l/@wardrail/plugin)](./LICENSE)
5
+
6
+ The **Wardrail plugin for Claude Code**. One install gives your coding agent two things:
7
+
8
+ 1. **Your contract & codebase, while it codes** the full [`@wardrail/mcp`](https://www.npmjs.com/package/@wardrail/mcp)
9
+ toolset: consult your project's guardrails before editing, pull the latest security findings, get
10
+ an independent verdict on a diff, and **query the code graph** (who calls what, blast radius)
11
+ instead of reading files. The agent stays on the rails *before* a violation lands.
12
+ 2. **A context-saving workflow** — `/task` and `/checkpoint` slash commands, a SessionStart resume
13
+ listing, and a machine **verifier** so a checkpoint *can't lie*: it reconciles a task file's
14
+ claims against `git`, a real test run, and a diff scan before it can be marked done.
15
+
16
+ The same anti-drift, verify-don't-trust thesis Wardrail applies to your *code*, turned on the
17
+ agent's own working memory. Zero-knowledge: your key and code stay on your machine.
18
+
19
+ ## Install
20
+
21
+ ```bash
22
+ claude plugin marketplace add https://wardrail.ghostables.io/marketplace.json
23
+ claude plugin install wardrail@wardrail
24
+ ```
25
+
26
+ At enable time you'll be asked for:
27
+
28
+ | Value | Required | What it is |
29
+ |---|---|---|
30
+ | `WARDRAIL_INGEST_TOKEN` | **yes** | Project-scoped token from Wardrail **Trust → Attest from CI**. Scopes reads to one project; never grants account access. |
31
+ | `WARDRAIL_URL` | no | Your Wardrail server. Defaults to `https://wardrail.ghostables.io`. |
32
+ | `ANTHROPIC_API_KEY` | no | Only for the diff-review tool. Stays on your machine; Wardrail never sees it. |
33
+
34
+ These feed the bundled MCP server via `${user_config.*}`; `@wardrail/mcp` is fetched on demand by `npx`.
35
+
36
+ ## The context-saving workflow
37
+
38
+ `/checkpoint` → `/clear` → `/task resume <slug>`. Task files live per-project in `./tasks/<slug>.md`
39
+ and carry a small, honest snapshot, so a fresh session rehydrates from ~3k tokens instead of a 150k
40
+ transcript. `/checkpoint` stamps a tamper-evident `## Verification` block; a `status: done` that
41
+ fails its checks is downgraded to FAIL — so "done" actually means done.
42
+
43
+ ## What's in the box
44
+
45
+ ```
46
+ .claude-plugin/plugin.json manifest + setup prompts
47
+ skills/task/SKILL.md /task new|resume <slug>
48
+ skills/checkpoint/SKILL.md /checkpoint (runs the verifier)
49
+ hooks/hooks.json SessionStart → resume listing
50
+ hooks/tasks-session-start.mjs
51
+ hooks/verify-checkpoint.mjs the machine verifier
52
+ .mcp.json the Wardrail MCP server (npx -y @wardrail/mcp)
53
+ ```
54
+
55
+ ## Requirements
56
+
57
+ Node 20+ and Claude Code (the plugin uses Claude Code's plugin + MCP support).
58
+
59
+ ## Learn more
60
+
61
+ - **Wardrail** — the independent trust layer for AI-written code: https://wardrail.ghostables.io
62
+ - **`@wardrail/mcp`** — the MCP server on its own, for Cursor / Windsurf / Claude Desktop: https://www.npmjs.com/package/@wardrail/mcp
63
+
64
+ MIT licensed.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wardrail/plugin",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "Wardrail Claude Code plugin — consult your project's contract while coding (MCP) plus a checkpoint->clear->resume workflow with machine-verified checkpoints.",
5
5
  "type": "module",
6
6
  "files": [