@agdf/cli 0.6.4 → 0.6.6
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 +89 -19
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -11,25 +11,103 @@ GitHub Copilot and OpenCode.
|
|
|
11
11
|
- Repository: https://github.com/arndtgold/ai-native-governance-delivery-framework
|
|
12
12
|
- Installation guide: https://github.com/arndtgold/ai-native-governance-delivery-framework/blob/main/INSTALL.md
|
|
13
13
|
|
|
14
|
+
## Prerequisites
|
|
15
|
+
|
|
16
|
+
AGDF is distributed as an npm package and run through `npx`, so Node.js and
|
|
17
|
+
npm must be installed first (npm bundles `npx`).
|
|
18
|
+
|
|
19
|
+
Check whether you already have them:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
node -v
|
|
23
|
+
npm -v
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
If either command fails, install Node.js 18 or later:
|
|
27
|
+
|
|
28
|
+
- **Windows:** `winget install OpenJS.NodeJS.LTS`
|
|
29
|
+
- **macOS:** `brew install node`
|
|
30
|
+
- **Linux (Debian/Ubuntu):** `sudo apt install nodejs npm`
|
|
31
|
+
- **Any OS:** download the LTS installer from https://nodejs.org
|
|
32
|
+
|
|
33
|
+
Then re-run `node -v` and `npm -v` to confirm before continuing.
|
|
34
|
+
|
|
14
35
|
## Quick Start
|
|
15
36
|
|
|
16
|
-
|
|
37
|
+
Commands are either **global** (installed once per machine through the
|
|
38
|
+
coding agent's own CLI, then available in every repository you open with
|
|
39
|
+
that agent) or **repository** (write files only into the current
|
|
40
|
+
repository). Run only the command(s) for the agent(s) you actually use.
|
|
41
|
+
|
|
42
|
+
### Codex
|
|
17
43
|
|
|
18
44
|
```bash
|
|
19
45
|
npx --yes @agdf/cli@latest codex
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**Global.** Requires the `codex` CLI on `PATH`. Runs
|
|
49
|
+
`codex plugin marketplace add/upgrade` and `codex plugin add` to install the
|
|
50
|
+
`agdf` plugin (skills, hooks, control templates) for every repository opened
|
|
51
|
+
in Codex.
|
|
52
|
+
|
|
53
|
+
```bash
|
|
20
54
|
npx --yes @agdf/cli@latest codex-repo
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
**Repository.** Writes a repo-local marketplace and plugin copy instead of
|
|
58
|
+
using the global one: `.agents/plugins/marketplace.json` and
|
|
59
|
+
`plugins/agdf/**` (skills, hooks, meta, control templates).
|
|
60
|
+
|
|
61
|
+
### Claude Code
|
|
62
|
+
|
|
63
|
+
```bash
|
|
21
64
|
npx --yes @agdf/cli@latest claude
|
|
22
|
-
npx --yes @agdf/cli@latest opencode-repo
|
|
23
|
-
npx --yes @agdf/cli@latest copilot
|
|
24
65
|
```
|
|
25
66
|
|
|
26
|
-
|
|
67
|
+
**Global only.** Requires the `claude` CLI on `PATH`. Runs
|
|
68
|
+
`claude plugin marketplace add/update` and `claude plugin install/update` to
|
|
69
|
+
install the `agdf` plugin for every repository opened in Claude Code. There
|
|
70
|
+
is no repository-local Claude Code plugin copy.
|
|
71
|
+
|
|
72
|
+
### OpenCode
|
|
27
73
|
|
|
28
74
|
```bash
|
|
29
75
|
npx --yes @agdf/cli@latest opencode
|
|
30
76
|
npx --yes @agdf/cli@latest opencode-status
|
|
31
77
|
```
|
|
32
78
|
|
|
79
|
+
**Global.** Adds the AGDF npm plugin as a user-wide hook in
|
|
80
|
+
`~/.config/opencode/opencode.json` (or `$OPENCODE_CONFIG_DIR`). `opencode-status`
|
|
81
|
+
verifies the install.
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
npx --yes @agdf/cli@latest opencode-repo
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
**Repository.** Writes `opencode.json` (or a fragment if one already
|
|
88
|
+
exists), repository instructions, generated subagents and control templates
|
|
89
|
+
under `.opencode/`.
|
|
90
|
+
|
|
91
|
+
### GitHub Copilot
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
npx --yes @agdf/cli@latest copilot
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
**Repository only** — Copilot does not consume the AGDF plugin package, so
|
|
98
|
+
there is no global command. Writes `AGENTS.md` (or `AGENTS.agdf.md`
|
|
99
|
+
alongside an existing `AGENTS.md`), plus `.github/copilot-instructions.md`,
|
|
100
|
+
`.github/instructions/agdf-governance.instructions.md` and
|
|
101
|
+
`.github/skills/**`.
|
|
102
|
+
|
|
103
|
+
### Both repository-local surfaces at once
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
npx --yes @agdf/cli@latest both
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Runs `codex-repo` and `copilot` together.
|
|
110
|
+
|
|
33
111
|
Install the AGDF CLI globally when `agdf` should be available as a regular
|
|
34
112
|
shell command on your machine:
|
|
35
113
|
|
|
@@ -124,21 +202,13 @@ evidence. It writes `DELIVERY_PATH_SEARCH.json` and
|
|
|
124
202
|
|
|
125
203
|
## Surface Notes
|
|
126
204
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
AGDF needs. Repository instructions, generated agents and control files remain
|
|
135
|
-
the AGDF source of truth. The generated
|
|
136
|
-
OpenCode agents are intentional `mode: subagent` workflow controls, not
|
|
137
|
-
`.opencode/skills/` entries or primary menu agents; use `@agdf-gate-check`
|
|
138
|
-
as the visible entry point for new build/change intent.
|
|
139
|
-
- **GitHub Copilot:** `copilot` writes repository instructions and skills. If
|
|
140
|
-
`AGENTS.md` already exists, AGDF preserves it and writes `AGENTS.agdf.md` for
|
|
141
|
-
manual merging.
|
|
205
|
+
See [Quick Start](#quick-start) for what each command installs and its
|
|
206
|
+
global-vs-repository scope. One extra OpenCode detail: repository
|
|
207
|
+
instructions, generated agents and control files remain the AGDF source of
|
|
208
|
+
truth even after the global hook is installed. The generated OpenCode agents
|
|
209
|
+
are intentional `mode: subagent` workflow controls, not `.opencode/skills/`
|
|
210
|
+
entries or primary menu agents; use `@agdf-gate-check` as the visible entry
|
|
211
|
+
point for new build/change intent.
|
|
142
212
|
|
|
143
213
|
`npm create agdf@latest -- ...` remains supported through the companion
|
|
144
214
|
`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.6.
|
|
3
|
+
"version": "0.6.6",
|
|
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.6.
|
|
18
|
+
"create-agdf": "0.6.6"
|
|
19
19
|
},
|
|
20
20
|
"keywords": [
|
|
21
21
|
"agdf",
|