@ggailabs/cli-context 0.5.0 → 0.5.3
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 +18 -18
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
# cli-context
|
|
1
|
+
# @ggailabs/cli-context
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@ggailabs/cli-context)
|
|
4
|
+
[](https://github.com/ggailabs/ggailabs-context/actions/workflows/ci.yml)
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
6
|
|
|
7
7
|
<img width="663" height="192" alt="image" src="https://github.com/user-attachments/assets/4b07f61d-6800-420a-ae91-6e952cbc790d" />
|
|
@@ -25,39 +25,39 @@ A lightweight CLI that scaffolds living documentation and AI-agent playbooks for
|
|
|
25
25
|
Use `npx` to run the CLI without installing globally:
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
|
-
npx cli-context
|
|
28
|
+
npx @ggailabs/cli-context
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
Or add it to your dev dependencies:
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
|
-
npm install --save-dev cli-context
|
|
34
|
+
npm install --save-dev @ggailabs/cli-context
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
## 🚀 Quick Start
|
|
38
38
|
|
|
39
39
|
```bash
|
|
40
40
|
# Launch the interactive wizard
|
|
41
|
-
npx cli-context
|
|
41
|
+
npx @ggailabs/cli-context
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
# Scaffold docs and agents into ./.context
|
|
45
|
-
npx cli-context init ./my-repo
|
|
45
|
+
npx @ggailabs/cli-context init ./my-repo
|
|
46
46
|
|
|
47
47
|
# Only generate docs
|
|
48
|
-
npx cli-context init ./my-repo docs
|
|
48
|
+
npx @ggailabs/cli-context init ./my-repo docs
|
|
49
49
|
|
|
50
50
|
# Only generate agent playbooks, with a custom output directory
|
|
51
|
-
npx cli-context init ./my-repo agents --output ./knowledge-base
|
|
51
|
+
npx @ggailabs/cli-context init ./my-repo agents --output ./knowledge-base
|
|
52
52
|
|
|
53
53
|
# Fill docs and agents with the repo context (preview the first 3 updates)
|
|
54
|
-
npx cli-context fill ./my-repo --output ./.context --limit 3
|
|
54
|
+
npx @ggailabs/cli-context fill ./my-repo --output ./.context --limit 3
|
|
55
55
|
|
|
56
56
|
# Draft a collaboration plan seeded with agent and doc touchpoints
|
|
57
|
-
npx cli-context plan release-readiness --output ./.context
|
|
57
|
+
npx @ggailabs/cli-context plan release-readiness --output ./.context
|
|
58
58
|
|
|
59
59
|
# Let the LLM enrich an existing plan with the latest context
|
|
60
|
-
npx cli-context plan release-readiness --output ./.context --fill --dry-run
|
|
60
|
+
npx @ggailabs/cli-context plan release-readiness --output ./.context --fill --dry-run
|
|
61
61
|
```
|
|
62
62
|
|
|
63
63
|
> ℹ️ The CLI pings npm for fresh releases at startup. Set `AI_CONTEXT_DISABLE_UPDATE_CHECK=true` to skip the check.
|
|
@@ -109,7 +109,7 @@ When contributing, focus edits inside `agent-update` regions or `agent-fill` pla
|
|
|
109
109
|
Scaffold documentation and/or agent playbooks.
|
|
110
110
|
|
|
111
111
|
```
|
|
112
|
-
Usage: cli-context init <repo-path> [type]
|
|
112
|
+
Usage: ggailabs-cli-context init <repo-path> [type]
|
|
113
113
|
|
|
114
114
|
Arguments:
|
|
115
115
|
repo-path Path to the repository you want to scan
|
|
@@ -127,7 +127,7 @@ Options:
|
|
|
127
127
|
Use an LLM to refresh scaffolded docs and agent playbooks automatically.
|
|
128
128
|
|
|
129
129
|
```
|
|
130
|
-
Usage: cli-context fill <repo-path>
|
|
130
|
+
Usage: ggailabs-cli-context fill <repo-path>
|
|
131
131
|
|
|
132
132
|
Options:
|
|
133
133
|
-o, --output <dir> Scaffold directory containing docs/ and agents/ (default: ./.context)
|
|
@@ -146,7 +146,7 @@ Under the hood, the command loads the prompt above, iterates over every Markdown
|
|
|
146
146
|
Create a collaboration plan that links documentation guides and agent playbooks, or fill an existing plan with LLM assistance.
|
|
147
147
|
|
|
148
148
|
```
|
|
149
|
-
Usage: cli-context plan <plan-name>
|
|
149
|
+
Usage: ggailabs-cli-context plan <plan-name>
|
|
150
150
|
|
|
151
151
|
Options:
|
|
152
152
|
-o, --output <dir> Scaffold directory containing docs/ and agents/ (default: ./.context)
|
|
@@ -168,15 +168,15 @@ Options:
|
|
|
168
168
|
|
|
169
169
|
In scaffold mode the command creates `.context/plans/<plan-name>.md`, keeps a `plans/README.md` index, and reminds contributors to consult the agent handbook before delegating work to an AI assistant. In fill mode it will scaffold the plan automatically if it does not exist, then read the plan plus its referenced docs and agent playbooks, send that context to the LLM, and either preview or write the updated Markdown.
|
|
170
170
|
|
|
171
|
-
💡 Tip: run `npx cli-context` with no arguments to enter an interactive mode that guides you through scaffold and LLM-fill options.
|
|
171
|
+
💡 Tip: run `npx @ggailabs/cli-context` with no arguments to enter an interactive mode that guides you through scaffold and LLM-fill options.
|
|
172
172
|
|
|
173
173
|
Prefer driving the update elsewhere? Just grab [`prompts/update_scaffold_prompt.md`](./prompts/update_scaffold_prompt.md) and run it in your favorite playground or agent host. When you’re ready to automate, drop your API key in `.env` (for example `OPENROUTER_API_KEY` and `OPENROUTER_MODEL`) and let `fill` handle the edits inline.
|
|
174
174
|
|
|
175
175
|
## 🧰 Local Development
|
|
176
176
|
|
|
177
177
|
```bash
|
|
178
|
-
git clone https://github.com/
|
|
179
|
-
cd
|
|
178
|
+
git clone https://github.com/ggailabs/ggailabs-context.git
|
|
179
|
+
cd ggailabs-context
|
|
180
180
|
npm install
|
|
181
181
|
npm run build
|
|
182
182
|
npm run test
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ggailabs/cli-context",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.3",
|
|
4
4
|
"description": "CLI tool for generating codebase documentation and AI agent prompts",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"bin": {
|
|
@@ -32,11 +32,11 @@
|
|
|
32
32
|
},
|
|
33
33
|
"repository": {
|
|
34
34
|
"type": "git",
|
|
35
|
-
"url": "git+https://github.com/ggailabs/ggailabs-context.git"
|
|
35
|
+
"url": "git+https://github.com/ggailabs/ggailabs-cli-context.git"
|
|
36
36
|
},
|
|
37
|
-
"homepage": "https://github.com/ggailabs/ggailabs-context#readme",
|
|
37
|
+
"homepage": "https://github.com/ggailabs/ggailabs-cli-context#readme",
|
|
38
38
|
"bugs": {
|
|
39
|
-
"url": "https://github.com/ggailabs/ggailabs-context/issues"
|
|
39
|
+
"url": "https://github.com/ggailabs/ggailabs-cli-context/issues"
|
|
40
40
|
},
|
|
41
41
|
"keywords": [
|
|
42
42
|
"cli",
|