@agdf/cli 0.3.4 → 0.4.0

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 +80 -11
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -13,17 +13,24 @@ GitHub Copilot and OpenCode.
13
13
 
14
14
  ## Quick Start
15
15
 
16
- Use the primary CLI when command semantics matter:
16
+ Prepare one repository:
17
+
18
+ ```bash
19
+ npx --yes @agdf/cli@latest codex
20
+ npx --yes @agdf/cli@latest codex-repo
21
+ npx --yes @agdf/cli@latest claude
22
+ npx --yes @agdf/cli@latest opencode-repo
23
+ npx --yes @agdf/cli@latest copilot
24
+ ```
25
+
26
+ Install the user-wide OpenCode hook:
17
27
 
18
28
  ```bash
19
- npx --yes @agdf/cli@latest init
20
- npx --yes @agdf/cli@latest doctor
21
- npx --yes @agdf/cli@latest gate-check --json
22
29
  npx --yes @agdf/cli@latest opencode
23
30
  ```
24
31
 
25
- Install globally when AGDF should be available as a regular command on your
26
- machine:
32
+ Install the AGDF CLI globally when `agdf` should be available as a regular
33
+ shell command on your machine:
27
34
 
28
35
  ```bash
29
36
  npm install -g @agdf/cli
@@ -32,9 +39,6 @@ agdf doctor
32
39
  agdf gate-check --json
33
40
  ```
34
41
 
35
- `npm create agdf@latest -- ...` remains supported through the companion
36
- `create-agdf` package for scaffold-style setup flows.
37
-
38
42
  ## What This Package Does
39
43
 
40
44
  `@agdf/cli` is the stable user-facing wrapper. It delegates to `create-agdf`
@@ -46,5 +50,70 @@ Use it to:
46
50
  - install AGDF instructions and skills into a target repository
47
51
  - initialize durable `.agdf/control` state when a repository should own it
48
52
  - run deterministic validators such as `doctor` and `gate-check --json`
49
- - prepare Codex, Claude Code, GitHub Copilot or OpenCode surfaces from the same
50
- source of truth
53
+ - prepare Codex, GitHub Copilot and OpenCode surfaces from the same source of
54
+ truth while keeping Claude Code installation explicitly separate
55
+
56
+ ## Durable Control State
57
+
58
+ When a repository owns live AGDF control state,
59
+ `.agdf/control/MASTER_BACKLOG.md` is its human-readable steering view. It links
60
+ active work to the current UR, Brownfield Review, PRD, SD, TP, QA and OR
61
+ artefacts without turning the backlog into a second specification.
62
+
63
+ - [View the canonical Master Backlog template](https://github.com/ArndtGold/ai-native-governance-delivery-framework/blob/main/plugin/control/templates/MASTER_BACKLOG.md)
64
+ - [Read the durable control-state guide](https://github.com/ArndtGold/ai-native-governance-delivery-framework/blob/main/plugin/control/README.md)
65
+
66
+ Each repository maintains its own live backlog. The linked template is the
67
+ authoritative reusable format, not AGDF's internal project backlog.
68
+
69
+ ## Commands
70
+
71
+ | Command | Purpose |
72
+ | --- | --- |
73
+ | `codex` | Install the AGDF plugin globally for Codex. |
74
+ | `codex-repo` | Add a repository-local Codex marketplace and AGDF plugin copy. |
75
+ | `claude` | Install the AGDF plugin globally for Claude Code. |
76
+ | `opencode` | Install the AGDF npm plugin as a user-wide OpenCode hook. |
77
+ | `opencode-repo` | Add OpenCode repository instructions, subagents, permissions and control templates. |
78
+ | `copilot` | Add `AGENTS.md`, Copilot instructions, skills and control templates. |
79
+ | `both` | Prepare the repository-file and plugin surfaces together. |
80
+ | `init` | Create durable `.agdf/control` files when repository-owned control state is required. |
81
+ | `config --language de\|en` | Persist the project language without creating the full control scaffold. |
82
+ | `doctor [--json]` | Check whether the durable control state is consistent and actionable. |
83
+ | `gate-check [--json]` | Report the current gate, blockers and next permitted action. |
84
+ | `delivery-map [--json]` | Report artefact relationships, evidence, risks and Context Graph effects. |
85
+
86
+ Examples:
87
+
88
+ ```bash
89
+ npx --yes @agdf/cli@latest opencode
90
+ npx --yes @agdf/cli@latest opencode-repo
91
+ npx --yes @agdf/cli@latest config --language en
92
+ npx --yes @agdf/cli@latest init
93
+ npx --yes @agdf/cli@latest doctor
94
+ npx --yes @agdf/cli@latest gate-check --json
95
+ npx --yes @agdf/cli@latest delivery-map --json
96
+ ```
97
+
98
+ The CLI validators provide deterministic evidence for agents and automation.
99
+ They do not replace AGDF skill judgement or user approvals.
100
+
101
+ ## Surface Notes
102
+
103
+ - **Codex:** `codex` installs the AGDF plugin globally for Codex, while
104
+ `codex-repo` prepares a repository-local marketplace for testing AGDF in one
105
+ repository.
106
+ - **Claude Code:** `claude` installs the AGDF plugin globally for Claude Code.
107
+ - **OpenCode:** `opencode` installs the user-wide npm plugin hook, while
108
+ `opencode-repo` writes the repository instructions, agents and permissions
109
+ AGDF needs. Repository instructions, generated agents and control files remain
110
+ the AGDF source of truth. The generated
111
+ OpenCode agents are intentional `mode: subagent` workflow controls, not
112
+ `.opencode/skills/` entries or primary menu agents; use `@agdf-gate-check`
113
+ as the visible entry point for new build/change intent.
114
+ - **GitHub Copilot:** `copilot` writes repository instructions and skills. If
115
+ `AGENTS.md` already exists, AGDF preserves it and writes `AGENTS.agdf.md` for
116
+ manual merging.
117
+
118
+ `npm create agdf@latest -- ...` remains supported through the companion
119
+ `create-agdf` package for scaffold-style setup flows.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agdf/cli",
3
- "version": "0.3.4",
3
+ "version": "0.4.0",
4
4
  "description": "Primary AGDF CLI for repository-local AI governance, delivery controls and agent setup.",
5
5
  "type": "module",
6
6
  "files": [
@@ -15,7 +15,7 @@
15
15
  "smoke-test": "node ./scripts/smoke-test.js"
16
16
  },
17
17
  "dependencies": {
18
- "create-agdf": "0.3.4"
18
+ "create-agdf": "0.4.0"
19
19
  },
20
20
  "keywords": [
21
21
  "agdf",