@agdf/cli 0.3.4 → 0.3.5
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.
- package/README.md +61 -9
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -13,13 +13,12 @@ GitHub Copilot and OpenCode.
|
|
|
13
13
|
|
|
14
14
|
## Quick Start
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Run commands inside the target Git repository:
|
|
17
17
|
|
|
18
18
|
```bash
|
|
19
|
-
npx --yes @agdf/cli@latest
|
|
20
|
-
npx --yes @agdf/cli@latest doctor
|
|
21
|
-
npx --yes @agdf/cli@latest gate-check --json
|
|
19
|
+
npx --yes @agdf/cli@latest codex
|
|
22
20
|
npx --yes @agdf/cli@latest opencode
|
|
21
|
+
npx --yes @agdf/cli@latest copilot
|
|
23
22
|
```
|
|
24
23
|
|
|
25
24
|
Install globally when AGDF should be available as a regular command on your
|
|
@@ -32,9 +31,6 @@ agdf doctor
|
|
|
32
31
|
agdf gate-check --json
|
|
33
32
|
```
|
|
34
33
|
|
|
35
|
-
`npm create agdf@latest -- ...` remains supported through the companion
|
|
36
|
-
`create-agdf` package for scaffold-style setup flows.
|
|
37
|
-
|
|
38
34
|
## What This Package Does
|
|
39
35
|
|
|
40
36
|
`@agdf/cli` is the stable user-facing wrapper. It delegates to `create-agdf`
|
|
@@ -46,5 +42,61 @@ Use it to:
|
|
|
46
42
|
- install AGDF instructions and skills into a target repository
|
|
47
43
|
- initialize durable `.agdf/control` state when a repository should own it
|
|
48
44
|
- run deterministic validators such as `doctor` and `gate-check --json`
|
|
49
|
-
- prepare Codex,
|
|
50
|
-
|
|
45
|
+
- prepare Codex, GitHub Copilot and OpenCode surfaces from the same source of
|
|
46
|
+
truth while keeping Claude Code installation explicitly separate
|
|
47
|
+
|
|
48
|
+
## Durable Control State
|
|
49
|
+
|
|
50
|
+
When a repository owns live AGDF control state,
|
|
51
|
+
`.agdf/control/MASTER_BACKLOG.md` is its human-readable steering view. It links
|
|
52
|
+
active work to the current UR, Brownfield Review, PRD, SD, TP, QA and OR
|
|
53
|
+
artefacts without turning the backlog into a second specification.
|
|
54
|
+
|
|
55
|
+
- [View the canonical Master Backlog template](https://github.com/ArndtGold/ai-native-governance-delivery-framework/blob/main/plugin/control/templates/MASTER_BACKLOG.md)
|
|
56
|
+
- [Read the durable control-state guide](https://github.com/ArndtGold/ai-native-governance-delivery-framework/blob/main/plugin/control/README.md)
|
|
57
|
+
|
|
58
|
+
Each repository maintains its own live backlog. The linked template is the
|
|
59
|
+
authoritative reusable format, not AGDF's internal project backlog.
|
|
60
|
+
|
|
61
|
+
## Commands
|
|
62
|
+
|
|
63
|
+
| Command | Purpose |
|
|
64
|
+
| --- | --- |
|
|
65
|
+
| `codex` | Add a repository-local Codex marketplace and AGDF plugin copy. |
|
|
66
|
+
| `opencode` | Add OpenCode instructions, agents, permissions and the npm plugin entry. |
|
|
67
|
+
| `copilot` | Add `AGENTS.md`, Copilot instructions, skills and control templates. |
|
|
68
|
+
| `both` | Prepare the repository-file and plugin surfaces together. |
|
|
69
|
+
| `init` | Create durable `.agdf/control` files when repository-owned control state is required. |
|
|
70
|
+
| `config --language de\|en` | Persist the project language without creating the full control scaffold. |
|
|
71
|
+
| `doctor [--json]` | Check whether the durable control state is consistent and actionable. |
|
|
72
|
+
| `gate-check [--json]` | Report the current gate, blockers and next permitted action. |
|
|
73
|
+
| `delivery-map [--json]` | Report artefact relationships, evidence, risks and Context Graph effects. |
|
|
74
|
+
|
|
75
|
+
Examples:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
npx --yes @agdf/cli@latest config --language en
|
|
79
|
+
npx --yes @agdf/cli@latest init
|
|
80
|
+
npx --yes @agdf/cli@latest doctor
|
|
81
|
+
npx --yes @agdf/cli@latest gate-check --json
|
|
82
|
+
npx --yes @agdf/cli@latest delivery-map --json
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
The CLI validators provide deterministic evidence for agents and automation.
|
|
86
|
+
They do not replace AGDF skill judgement or user approvals.
|
|
87
|
+
|
|
88
|
+
## Surface Notes
|
|
89
|
+
|
|
90
|
+
- **Codex:** `codex` prepares a repository-local marketplace. For a global
|
|
91
|
+
installation, use the Codex plugin marketplace commands documented on the
|
|
92
|
+
[AGDF website](https://agdf.iself.eu/#setup-codex).
|
|
93
|
+
- **Claude Code:** install the AGDF plugin with the Claude Code CLI; this is not
|
|
94
|
+
an `@agdf/cli` bootstrap target.
|
|
95
|
+
- **OpenCode:** `opencode` writes the npm plugin entry together with the
|
|
96
|
+
repository instructions, agents and permissions AGDF needs.
|
|
97
|
+
- **GitHub Copilot:** `copilot` writes repository instructions and skills. If
|
|
98
|
+
`AGENTS.md` already exists, AGDF preserves it and writes `AGENTS.agdf.md` for
|
|
99
|
+
manual merging.
|
|
100
|
+
|
|
101
|
+
`npm create agdf@latest -- ...` remains supported through the companion
|
|
102
|
+
`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.
|
|
3
|
+
"version": "0.3.5",
|
|
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.
|
|
18
|
+
"create-agdf": "0.3.5"
|
|
19
19
|
},
|
|
20
20
|
"keywords": [
|
|
21
21
|
"agdf",
|