@ggailabs/cli-context 0.5.0 → 0.5.2
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 +17 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
# cli-context
|
|
1
|
+
# @ggailabs/cli-context
|
|
2
2
|
|
|
3
|
-
[](https://github.com/vinilana/ai-coders-context/actions/workflows/ci.yml)
|
|
3
|
+
[](https://www.npmjs.com/package/@ggailabs/cli-context)
|
|
5
4
|
[](https://opensource.org/licenses/MIT)
|
|
6
5
|
|
|
7
6
|
<img width="663" height="192" alt="image" src="https://github.com/user-attachments/assets/4b07f61d-6800-420a-ae91-6e952cbc790d" />
|
|
@@ -25,39 +24,39 @@ A lightweight CLI that scaffolds living documentation and AI-agent playbooks for
|
|
|
25
24
|
Use `npx` to run the CLI without installing globally:
|
|
26
25
|
|
|
27
26
|
```bash
|
|
28
|
-
npx cli-context
|
|
27
|
+
npx @ggailabs/cli-context
|
|
29
28
|
```
|
|
30
29
|
|
|
31
30
|
Or add it to your dev dependencies:
|
|
32
31
|
|
|
33
32
|
```bash
|
|
34
|
-
npm install --save-dev cli-context
|
|
33
|
+
npm install --save-dev @ggailabs/cli-context
|
|
35
34
|
```
|
|
36
35
|
|
|
37
36
|
## 🚀 Quick Start
|
|
38
37
|
|
|
39
38
|
```bash
|
|
40
39
|
# Launch the interactive wizard
|
|
41
|
-
npx cli-context
|
|
40
|
+
npx @ggailabs/cli-context
|
|
42
41
|
|
|
43
42
|
|
|
44
43
|
# Scaffold docs and agents into ./.context
|
|
45
|
-
npx cli-context init ./my-repo
|
|
44
|
+
npx @ggailabs/cli-context init ./my-repo
|
|
46
45
|
|
|
47
46
|
# Only generate docs
|
|
48
|
-
npx cli-context init ./my-repo docs
|
|
47
|
+
npx @ggailabs/cli-context init ./my-repo docs
|
|
49
48
|
|
|
50
49
|
# Only generate agent playbooks, with a custom output directory
|
|
51
|
-
npx cli-context init ./my-repo agents --output ./knowledge-base
|
|
50
|
+
npx @ggailabs/cli-context init ./my-repo agents --output ./knowledge-base
|
|
52
51
|
|
|
53
52
|
# Fill docs and agents with the repo context (preview the first 3 updates)
|
|
54
|
-
npx cli-context fill ./my-repo --output ./.context --limit 3
|
|
53
|
+
npx @ggailabs/cli-context fill ./my-repo --output ./.context --limit 3
|
|
55
54
|
|
|
56
55
|
# Draft a collaboration plan seeded with agent and doc touchpoints
|
|
57
|
-
npx cli-context plan release-readiness --output ./.context
|
|
56
|
+
npx @ggailabs/cli-context plan release-readiness --output ./.context
|
|
58
57
|
|
|
59
58
|
# Let the LLM enrich an existing plan with the latest context
|
|
60
|
-
npx cli-context plan release-readiness --output ./.context --fill --dry-run
|
|
59
|
+
npx @ggailabs/cli-context plan release-readiness --output ./.context --fill --dry-run
|
|
61
60
|
```
|
|
62
61
|
|
|
63
62
|
> ℹ️ The CLI pings npm for fresh releases at startup. Set `AI_CONTEXT_DISABLE_UPDATE_CHECK=true` to skip the check.
|
|
@@ -109,7 +108,7 @@ When contributing, focus edits inside `agent-update` regions or `agent-fill` pla
|
|
|
109
108
|
Scaffold documentation and/or agent playbooks.
|
|
110
109
|
|
|
111
110
|
```
|
|
112
|
-
Usage: cli-context init <repo-path> [type]
|
|
111
|
+
Usage: ggailabs-cli-context init <repo-path> [type]
|
|
113
112
|
|
|
114
113
|
Arguments:
|
|
115
114
|
repo-path Path to the repository you want to scan
|
|
@@ -127,7 +126,7 @@ Options:
|
|
|
127
126
|
Use an LLM to refresh scaffolded docs and agent playbooks automatically.
|
|
128
127
|
|
|
129
128
|
```
|
|
130
|
-
Usage: cli-context fill <repo-path>
|
|
129
|
+
Usage: ggailabs-cli-context fill <repo-path>
|
|
131
130
|
|
|
132
131
|
Options:
|
|
133
132
|
-o, --output <dir> Scaffold directory containing docs/ and agents/ (default: ./.context)
|
|
@@ -146,7 +145,7 @@ Under the hood, the command loads the prompt above, iterates over every Markdown
|
|
|
146
145
|
Create a collaboration plan that links documentation guides and agent playbooks, or fill an existing plan with LLM assistance.
|
|
147
146
|
|
|
148
147
|
```
|
|
149
|
-
Usage: cli-context plan <plan-name>
|
|
148
|
+
Usage: ggailabs-cli-context plan <plan-name>
|
|
150
149
|
|
|
151
150
|
Options:
|
|
152
151
|
-o, --output <dir> Scaffold directory containing docs/ and agents/ (default: ./.context)
|
|
@@ -168,15 +167,15 @@ Options:
|
|
|
168
167
|
|
|
169
168
|
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
169
|
|
|
171
|
-
💡 Tip: run `npx cli-context` with no arguments to enter an interactive mode that guides you through scaffold and LLM-fill options.
|
|
170
|
+
💡 Tip: run `npx @ggailabs/cli-context` with no arguments to enter an interactive mode that guides you through scaffold and LLM-fill options.
|
|
172
171
|
|
|
173
172
|
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
173
|
|
|
175
174
|
## 🧰 Local Development
|
|
176
175
|
|
|
177
176
|
```bash
|
|
178
|
-
git clone https://github.com/
|
|
179
|
-
cd
|
|
177
|
+
git clone https://github.com/ggailabs/ggailabs-context.git
|
|
178
|
+
cd ggailabs-context
|
|
180
179
|
npm install
|
|
181
180
|
npm run build
|
|
182
181
|
npm run test
|