@mc1global/opencode-jarvis 0.10.0 → 0.11.0

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.
Files changed (16) hide show
  1. package/QUICK-GUIDE.md +42 -28
  2. package/README.md +288 -165
  3. package/dist/hooks/first-run-guide.d.ts.map +1 -1
  4. package/dist/hooks/first-run-guide.js +35 -2
  5. package/dist/hooks/first-run-guide.js.map +1 -1
  6. package/dist/hooks/slash-commands.d.ts +36 -0
  7. package/dist/hooks/slash-commands.d.ts.map +1 -0
  8. package/dist/hooks/slash-commands.js +121 -0
  9. package/dist/hooks/slash-commands.js.map +1 -0
  10. package/dist/index.d.ts.map +1 -1
  11. package/dist/index.js +14 -1
  12. package/dist/index.js.map +1 -1
  13. package/package.json +2 -1
  14. package/scripts/setup/setup-linux.sh +124 -0
  15. package/scripts/setup/setup-macos.sh +137 -0
  16. package/scripts/setup/setup-wsl.sh +175 -0
package/QUICK-GUIDE.md CHANGED
@@ -5,49 +5,63 @@
5
5
  ## Setup in 60 Seconds
6
6
 
7
7
  ```bash
8
- # 1. Prerequisites (macOS)
9
- curl -fsSL https://bun.sh/install | bash
10
- brew install ollama && ollama serve && ollama pull embeddinggemma
8
+ # 1. Prerequisites (choose your OS)
9
+ # macOS: curl -fsSL <repo-url>/scripts/setup/setup-macos.sh | bash
10
+ # Linux: curl -fsSL <repo-url>/scripts/setup/setup-linux.sh | bash
11
+ # WSL: curl -fsSL <repo-url>/scripts/setup/setup-wsl.sh | bash
11
12
 
12
- # 2. Add plugin to your project
13
+ # 2. Add plugin to your project (in YOUR PROJECT ROOT directory)
13
14
  echo '{ "plugin": ["@mc1global/opencode-jarvis"] }' > opencode.json
14
15
 
15
16
  # 3. Launch OpenCode — JARVIS auto-bootstraps everything
17
+ cd /path/to/your/project
16
18
  opencode
17
19
  ```
18
20
 
21
+ ## Where Does `opencode.json` Go?
22
+
23
+ ```
24
+ your-project/opencode.json <-- Per-project (recommended)
25
+ ~/.config/opencode/opencode.json <-- Global (all projects)
26
+ ```
27
+
28
+ Project-level overrides global. Both are merged for non-conflicting keys.
29
+
19
30
  ## First Session Checklist
20
31
 
21
- | Step | Tool / Command |
22
- |---|---|
23
- | Run diagnostics | `/healthcheck` |
24
- | Index codebase | `rag-index` tool |
25
- | Index docs | `rag-oracle-index` tool with `directory="obsidian-vault"` |
26
- | View board | `kanban-board-view` tool |
32
+ - Run diagnostics: `/healthcheck`
33
+ - Index codebase: `rag-index` tool
34
+ - Index docs: `rag-oracle-index` tool with `directory="obsidian-vault"`
35
+ - View board: `kanban-board-view` tool
27
36
 
28
37
  ## Key Commands
29
38
 
30
- | Command | What it does |
31
- |---|---|
32
- | `/healthcheck` | Diagnose environment + show fix commands |
33
- | `/sync-azure` | Sync kanban with Azure DevOps |
34
- | `/start-card CD-XXX` | Start working on a card (full lifecycle) |
39
+ - `/healthcheck` — Diagnose environment + show fix commands
40
+ - `/sync-azure` — Sync kanban with Azure DevOps
41
+ - `/start-card CD-XXX` — Start working on a card (full lifecycle)
42
+ - `/config` — Agent-guided configuration wizard
35
43
 
36
44
  ## Key Skills (load via `skill()` tool)
37
45
 
38
- | Skill | What it teaches |
39
- |---|---|
40
- | `jarvis-onboarding` | Setup, tools, orientation |
41
- | `jarvis-kanban` | Card lifecycle, grooming, sprints |
42
- | `jarvis-azure-sync` | Azure DevOps sync workflow |
46
+ - `jarvis-kanban` — Card lifecycle, grooming, sprints
47
+ - `jarvis-azure-sync` — Azure DevOps sync workflow
48
+ - `jarvis-onboarding` — Setup, tools, orientation
43
49
 
44
50
  ## Files Created by JARVIS
45
51
 
46
- | Path | In Git? | Purpose |
47
- |---|---|---|
48
- | `config/jarvis.yaml` | Yes | Configuration |
49
- | `AGENTS.md` | Yes | Agent instructions |
50
- | `obsidian-vault/` | Yes | Documentation |
51
- | `.jarvis/jarvis.db` | No | Local database |
52
- | `.jarvis/rag/` | No | RAG embeddings |
53
- | `~/.jarvis/registry.db` | No | Global workspace registry |
52
+ ```
53
+ config/jarvis.yaml In git — Configuration
54
+ AGENTS.md In git — Agent instructions
55
+ obsidian-vault/ In git — Documentation
56
+ .jarvis/jarvis.db Local — SQLite database (gitignored)
57
+ .jarvis/rag/ Local — RAG embeddings (gitignored)
58
+ ~/.jarvis/registry.db Global — Workspace registry
59
+ ```
60
+
61
+ ## Windows (WSL) Notes
62
+
63
+ - JARVIS must run inside WSL, not native Windows
64
+ - Use `setup-wsl.sh` for automated installation
65
+ - Best performance: keep project files in WSL filesystem (`~/code/`)
66
+ - Access Windows files via `/mnt/c/Users/YourName/...`
67
+ - See: https://opencode.ai/docs/windows-wsl