opencode-onboard 0.2.7 → 0.2.12
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 +30 -6
- package/content/AGENTS.md +384 -384
- package/package.json +1 -1
- package/src/index.js +180 -18
- package/src/steps/__tests__/check-rtk.test.js +3 -2
- package/src/steps/__tests__/clean-ai-files.test.js +1 -1
- package/src/steps/__tests__/copy-content.test.js +4 -2
- package/src/steps/__tests__/token-optimization.test.js +78 -0
- package/src/steps/check-rtk.js +22 -4
- package/src/steps/choose-source-scope.js +1 -1
- package/src/steps/enable-caveman-guidance.js +93 -0
- package/src/steps/install-caveman.js +42 -0
- package/src/steps/install-quota.js +82 -0
- package/src/steps/token-optimization.js +59 -0
- package/src/steps/write-onboard-config.js +2 -0
- package/src/utils/exec.js +19 -7
package/README.md
CHANGED
|
@@ -31,13 +31,36 @@ Most codebases have no `AGENTS.md`, no architecture docs agents can read, and no
|
|
|
31
31
|
npx opencode-onboard@latest
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Requires **Node.js 18+**.
|
|
34
|
+
Requires **Node.js 18+**.
|
|
35
|
+
|
|
36
|
+
### Run specific steps
|
|
37
|
+
|
|
38
|
+
You can also run individual maintenance/setup steps without the full wizard:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# Run one step directly
|
|
42
|
+
npx opencode-onboard clean
|
|
43
|
+
npx opencode-onboard platform
|
|
44
|
+
npx opencode-onboard copy
|
|
45
|
+
npx opencode-onboard openspec
|
|
46
|
+
npx opencode-onboard skills
|
|
47
|
+
npx opencode-onboard models
|
|
48
|
+
npx opencode-onboard optimization
|
|
49
|
+
npx opencode-onboard browser
|
|
50
|
+
npx opencode-onboard metadata
|
|
51
|
+
|
|
52
|
+
# Show CLI help and all commands
|
|
53
|
+
npx opencode-onboard --help
|
|
54
|
+
npx opencode-onboard -h
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
When available, step commands reuse context from `.opencode/opencode-onboard.json`.
|
|
35
58
|
|
|
36
59
|
---
|
|
37
60
|
|
|
38
61
|
## How it works
|
|
39
62
|
|
|
40
|
-
The CLI clears the screen, shows a welcome banner, and walks you through
|
|
63
|
+
The CLI clears the screen, shows a welcome banner, and walks you through 12 steps. The screen always shows the last 2 completed steps + the current one so you always know where you are.
|
|
41
64
|
|
|
42
65
|
| Step | What happens |
|
|
43
66
|
|------|-------------|
|
|
@@ -48,9 +71,10 @@ The CLI clears the screen, shows a welcome banner, and walks you through 10 step
|
|
|
48
71
|
| **5. Copy scaffolding** | Drops agents, skills, and bootstrap docs into your project |
|
|
49
72
|
| **6. Init OpenSpec** | Runs `npx @fission-ai/openspec init` silently for structured change management |
|
|
50
73
|
| **7. Install skills** | Installs built-in `ob-` skills + optional additional skills provider |
|
|
51
|
-
| **8. Choose models** | Fetches live model list from [models.dev](https://models.dev), lets you pick plan / build / fast models with cost indicators and canonical pricing |
|
|
52
|
-
| **9.
|
|
53
|
-
| **
|
|
74
|
+
| **8. Choose models** | Fetches live model list from [models.dev](https://models.dev), lets you pick plan / build / fast models with cost indicators and canonical pricing |
|
|
75
|
+
| **9. Token optimization tools** | Optional (recommended). One checklist step for RTK check, opencode-quota setup, and caveman install (all preselected) |
|
|
76
|
+
| **11. Install browser plugin** | Installs `@different-ai/opencode-browser` globally for agent browser automation |
|
|
77
|
+
| **12. Write onboarding metadata** | Writes `.opencode/opencode-onboard.json` with selected setup details |
|
|
54
78
|
|
|
55
79
|
When it finishes, open OpenCode in your project and type:
|
|
56
80
|
|
|
@@ -181,7 +205,7 @@ After this, every agent has accurate, persistent context about your project, no
|
|
|
181
205
|
| **Node.js 18+** | Required |
|
|
182
206
|
| **[OpenCode](https://opencode.ai)** | The agent runtime |
|
|
183
207
|
| **[OpenCode Ensemble](https://github.com/hueyexe/opencode-ensemble)** | Multi-agent parallel execution |
|
|
184
|
-
| **[rtk](https://github.com/rtk-ai/rtk#pre-built-binaries)** |
|
|
208
|
+
| **[rtk](https://github.com/rtk-ai/rtk#pre-built-binaries)** | Recommended for safer agent CLI command execution |
|
|
185
209
|
| **[gh CLI](https://cli.github.com)** | GitHub platform, must be authenticated |
|
|
186
210
|
| **[az CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** + azure-devops extension | Azure DevOps platform |
|
|
187
211
|
|