@orderful/droid 0.37.0 → 0.38.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.
- package/.claude-plugin/marketplace.json +1 -118
- package/.claude-plugin/plugin.json +49 -0
- package/AGENTS.md +4 -0
- package/CHANGELOG.md +43 -0
- package/README.md +53 -39
- package/dist/bin/droid.js +525 -212
- package/dist/commands/setup.d.ts.map +1 -1
- package/dist/commands/tui/components/PlatformBadges.d.ts.map +1 -1
- package/dist/commands/tui/components/SettingsDetails.d.ts.map +1 -1
- package/dist/commands/tui/hooks/useAppUpdate.d.ts.map +1 -1
- package/dist/commands/tui/views/SetupScreen.d.ts.map +1 -1
- package/dist/commands/update.d.ts.map +1 -1
- package/dist/index.js +345 -186
- package/dist/lib/agents.d.ts +4 -2
- package/dist/lib/agents.d.ts.map +1 -1
- package/dist/lib/migrations.d.ts.map +1 -1
- package/dist/lib/platform.codex.d.ts +36 -0
- package/dist/lib/platform.codex.d.ts.map +1 -0
- package/dist/lib/platforms.d.ts +30 -24
- package/dist/lib/platforms.d.ts.map +1 -1
- package/dist/lib/skills.d.ts +4 -2
- package/dist/lib/skills.d.ts.map +1 -1
- package/dist/lib/types.d.ts +2 -1
- package/dist/lib/types.d.ts.map +1 -1
- package/dist/tools/brain/.claude-plugin/plugin.json +8 -1
- package/dist/tools/brain/TOOL.yaml +1 -1
- package/dist/tools/brain/skills/brain/SKILL.md +6 -3
- package/dist/tools/brain/skills/brain/references/workflows.md +9 -5
- package/dist/tools/brain/skills/brain-obsidian/SKILL.md +2 -0
- package/dist/tools/coach/.claude-plugin/plugin.json +6 -0
- package/dist/tools/coach/skills/coach/SKILL.md +3 -0
- package/dist/tools/code-review/.claude-plugin/plugin.json +12 -0
- package/dist/tools/code-review/skills/code-review/SKILL.md +2 -0
- package/dist/tools/codex/.claude-plugin/plugin.json +9 -0
- package/dist/tools/codex/skills/codex/SKILL.md +3 -0
- package/dist/tools/comments/.claude-plugin/plugin.json +6 -0
- package/dist/tools/comments/skills/comments/SKILL.md +5 -0
- package/dist/tools/droid/.claude-plugin/plugin.json +8 -1
- package/dist/tools/droid/TOOL.yaml +4 -2
- package/dist/tools/droid/commands/setup.md +125 -0
- package/dist/tools/droid/skills/droid/SKILL.md +117 -2
- package/dist/tools/plan/.claude-plugin/plugin.json +6 -0
- package/dist/tools/plan/skills/plan/SKILL.md +2 -0
- package/dist/tools/project/.claude-plugin/plugin.json +6 -0
- package/dist/tools/project/skills/project/SKILL.md +3 -0
- package/dist/tools/tech-design/.claude-plugin/plugin.json +7 -1
- package/dist/tools/tech-design/TOOL.yaml +1 -1
- package/dist/tools/tech-design/commands/tech-design.md +2 -0
- package/dist/tools/tech-design/skills/tech-design/SKILL.md +39 -9
- package/dist/tools/tech-design/skills/tech-design/references/publish.md +272 -216
- package/dist/tools/tech-design/skills/tech-design/references/start.md +50 -20
- package/dist/tools/wrapup/.claude-plugin/plugin.json +6 -0
- package/dist/tools/wrapup/skills/wrapup/SKILL.md +2 -0
- package/package.json +1 -1
- package/scripts/build-plugins.ts +154 -6
- package/src/bin/droid.ts +16 -0
- package/src/commands/setup.ts +107 -2
- package/src/commands/tui/components/PlatformBadges.tsx +1 -0
- package/src/commands/tui/components/SettingsDetails.tsx +1 -0
- package/src/commands/tui/hooks/useAppUpdate.ts +21 -1
- package/src/commands/tui/views/SetupScreen.tsx +10 -1
- package/src/commands/update.ts +21 -1
- package/src/lib/agents.ts +13 -2
- package/src/lib/migrations.ts +81 -9
- package/src/lib/platform.codex.ts +131 -0
- package/src/lib/platforms.ts +127 -6
- package/src/lib/skills.ts +53 -6
- package/src/lib/types.ts +1 -0
- package/src/tools/brain/.claude-plugin/plugin.json +8 -1
- package/src/tools/brain/TOOL.yaml +1 -1
- package/src/tools/brain/skills/brain/SKILL.md +6 -3
- package/src/tools/brain/skills/brain/references/workflows.md +9 -5
- package/src/tools/brain/skills/brain-obsidian/SKILL.md +2 -0
- package/src/tools/coach/.claude-plugin/plugin.json +6 -0
- package/src/tools/coach/skills/coach/SKILL.md +3 -0
- package/src/tools/code-review/.claude-plugin/plugin.json +12 -0
- package/src/tools/code-review/skills/code-review/SKILL.md +2 -0
- package/src/tools/codex/.claude-plugin/plugin.json +9 -0
- package/src/tools/codex/skills/codex/SKILL.md +3 -0
- package/src/tools/comments/.claude-plugin/plugin.json +6 -0
- package/src/tools/comments/skills/comments/SKILL.md +5 -0
- package/src/tools/droid/.claude-plugin/plugin.json +8 -1
- package/src/tools/droid/TOOL.yaml +4 -2
- package/src/tools/droid/commands/setup.md +125 -0
- package/src/tools/droid/skills/droid/SKILL.md +117 -2
- package/src/tools/plan/.claude-plugin/plugin.json +6 -0
- package/src/tools/plan/skills/plan/SKILL.md +2 -0
- package/src/tools/project/.claude-plugin/plugin.json +6 -0
- package/src/tools/project/skills/project/SKILL.md +3 -0
- package/src/tools/tech-design/.claude-plugin/plugin.json +7 -1
- package/src/tools/tech-design/TOOL.yaml +1 -1
- package/src/tools/tech-design/commands/tech-design.md +2 -0
- package/src/tools/tech-design/skills/tech-design/SKILL.md +39 -9
- package/src/tools/tech-design/skills/tech-design/references/publish.md +272 -216
- package/src/tools/tech-design/skills/tech-design/references/start.md +50 -20
- package/src/tools/wrapup/.claude-plugin/plugin.json +6 -0
- package/src/tools/wrapup/skills/wrapup/SKILL.md +2 -0
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{
|
|
10
10
|
"name": "droid",
|
|
11
11
|
"description": "Core droid meta-skill for update awareness, tool discovery, and usage help. Checks for updates, helps users find tools, and answers 'how do I...' questions about droid workflows.",
|
|
12
|
-
"version": "0.
|
|
12
|
+
"version": "0.7.0",
|
|
13
13
|
"source": {
|
|
14
14
|
"source": "github",
|
|
15
15
|
"repo": "orderful/droid",
|
|
@@ -18,123 +18,6 @@
|
|
|
18
18
|
"author": {
|
|
19
19
|
"name": "Orderful"
|
|
20
20
|
}
|
|
21
|
-
},
|
|
22
|
-
{
|
|
23
|
-
"name": "droid-brain",
|
|
24
|
-
"description": "Your scratchpad (or brain) - a collaborative space for planning and research. Create docs with /brain plan, /brain research, or /brain review. Use @mentions for async discussion. Docs persist across sessions.",
|
|
25
|
-
"version": "0.3.9",
|
|
26
|
-
"source": {
|
|
27
|
-
"source": "github",
|
|
28
|
-
"repo": "orderful/droid",
|
|
29
|
-
"path": "src/tools/brain"
|
|
30
|
-
},
|
|
31
|
-
"author": {
|
|
32
|
-
"name": "Orderful"
|
|
33
|
-
}
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
"name": "droid-coach",
|
|
37
|
-
"description": "Learning-mode AI assistance - AI as coach, not crutch. Use /coach plan for co-authored planning, /coach scaffold for structure with hints, /coach review for Socratic questions.",
|
|
38
|
-
"version": "0.2.4",
|
|
39
|
-
"source": {
|
|
40
|
-
"source": "github",
|
|
41
|
-
"repo": "orderful/droid",
|
|
42
|
-
"path": "src/tools/coach"
|
|
43
|
-
},
|
|
44
|
-
"author": {
|
|
45
|
-
"name": "Orderful"
|
|
46
|
-
}
|
|
47
|
-
},
|
|
48
|
-
{
|
|
49
|
-
"name": "droid-code-review",
|
|
50
|
-
"description": "Comprehensive code review using specialized agents. Reviews PRs, staged changes, branches, or specific files with confidence scoring.",
|
|
51
|
-
"version": "0.2.3",
|
|
52
|
-
"source": {
|
|
53
|
-
"source": "github",
|
|
54
|
-
"repo": "orderful/droid",
|
|
55
|
-
"path": "src/tools/code-review"
|
|
56
|
-
},
|
|
57
|
-
"author": {
|
|
58
|
-
"name": "Orderful"
|
|
59
|
-
}
|
|
60
|
-
},
|
|
61
|
-
{
|
|
62
|
-
"name": "droid-codex",
|
|
63
|
-
"description": "Shared organizational knowledge - PRDs, tech designs, domains, proposals, patterns, and explored topics. Self-describing: structure and workflows defined in codex repo. Use when loading project context, searching codex, capturing decisions, or creating new entries.",
|
|
64
|
-
"version": "0.3.0",
|
|
65
|
-
"source": {
|
|
66
|
-
"source": "github",
|
|
67
|
-
"repo": "orderful/droid",
|
|
68
|
-
"path": "src/tools/codex"
|
|
69
|
-
},
|
|
70
|
-
"author": {
|
|
71
|
-
"name": "Orderful"
|
|
72
|
-
}
|
|
73
|
-
},
|
|
74
|
-
{
|
|
75
|
-
"name": "droid-comments",
|
|
76
|
-
"description": "Enable inline conversations using @droid/@user markers. Tag @droid to ask the AI, AI responds with @{your-name}. Use /comments check to address markers, /comments cleanup to remove resolved threads. Ideal for code review notes and async collaboration.",
|
|
77
|
-
"version": "0.3.5",
|
|
78
|
-
"source": {
|
|
79
|
-
"source": "github",
|
|
80
|
-
"repo": "orderful/droid",
|
|
81
|
-
"path": "src/tools/comments"
|
|
82
|
-
},
|
|
83
|
-
"author": {
|
|
84
|
-
"name": "Orderful"
|
|
85
|
-
}
|
|
86
|
-
},
|
|
87
|
-
{
|
|
88
|
-
"name": "droid-plan",
|
|
89
|
-
"description": "Task-scoped planning with portable, structured plans. Use when planning implementation for a PR, ticket, or small feature. User prompts like 'let's plan this', 'can we start a plan', 'think through the implementation'.",
|
|
90
|
-
"version": "0.1.4",
|
|
91
|
-
"source": {
|
|
92
|
-
"source": "github",
|
|
93
|
-
"repo": "orderful/droid",
|
|
94
|
-
"path": "src/tools/plan"
|
|
95
|
-
},
|
|
96
|
-
"author": {
|
|
97
|
-
"name": "Orderful"
|
|
98
|
-
}
|
|
99
|
-
},
|
|
100
|
-
{
|
|
101
|
-
"name": "droid-project",
|
|
102
|
-
"description": "Manage project context files for persistent AI memory across sessions. Load, update, or create project context before working on multi-session features.",
|
|
103
|
-
"version": "0.3.4",
|
|
104
|
-
"source": {
|
|
105
|
-
"source": "github",
|
|
106
|
-
"repo": "orderful/droid",
|
|
107
|
-
"path": "src/tools/project"
|
|
108
|
-
},
|
|
109
|
-
"author": {
|
|
110
|
-
"name": "Orderful"
|
|
111
|
-
}
|
|
112
|
-
},
|
|
113
|
-
{
|
|
114
|
-
"name": "droid-tech-design",
|
|
115
|
-
"description": "Technical design authoring tool for engineers. Create structured tech design docs with /tech-design start, iterate in brain, publish to codex. Three-document approach: research doc (codebase discoveries) + thought doc (design workspace) + roll-up (clean summary for review).",
|
|
116
|
-
"version": "0.2.5",
|
|
117
|
-
"source": {
|
|
118
|
-
"source": "github",
|
|
119
|
-
"repo": "orderful/droid",
|
|
120
|
-
"path": "src/tools/tech-design"
|
|
121
|
-
},
|
|
122
|
-
"author": {
|
|
123
|
-
"name": "Orderful"
|
|
124
|
-
}
|
|
125
|
-
},
|
|
126
|
-
{
|
|
127
|
-
"name": "droid-wrapup",
|
|
128
|
-
"description": "Session wrap-up that captures decisions, learnings, and open items to persistent docs.",
|
|
129
|
-
"version": "0.1.3",
|
|
130
|
-
"source": {
|
|
131
|
-
"source": "github",
|
|
132
|
-
"repo": "orderful/droid",
|
|
133
|
-
"path": "src/tools/wrapup"
|
|
134
|
-
},
|
|
135
|
-
"author": {
|
|
136
|
-
"name": "Orderful"
|
|
137
|
-
}
|
|
138
21
|
}
|
|
139
22
|
]
|
|
140
23
|
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "droid",
|
|
3
|
+
"version": "0.7.0",
|
|
4
|
+
"description": "AI-powered development tools for Claude Code",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Orderful",
|
|
7
|
+
"url": "https://github.com/orderful"
|
|
8
|
+
},
|
|
9
|
+
"repository": "https://github.com/orderful/droid",
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"droid",
|
|
13
|
+
"ai",
|
|
14
|
+
"tools"
|
|
15
|
+
],
|
|
16
|
+
"skills": [
|
|
17
|
+
"./src/tools/brain/skills/brain/SKILL.md",
|
|
18
|
+
"./src/tools/brain/skills/brain-obsidian/SKILL.md",
|
|
19
|
+
"./src/tools/coach/skills/coach/SKILL.md",
|
|
20
|
+
"./src/tools/code-review/skills/code-review/SKILL.md",
|
|
21
|
+
"./src/tools/codex/skills/codex/SKILL.md",
|
|
22
|
+
"./src/tools/comments/skills/comments/SKILL.md",
|
|
23
|
+
"./src/tools/droid/skills/droid/SKILL.md",
|
|
24
|
+
"./src/tools/droid/skills/droid-bootstrap/SKILL.md",
|
|
25
|
+
"./src/tools/plan/skills/plan/SKILL.md",
|
|
26
|
+
"./src/tools/project/skills/project/SKILL.md",
|
|
27
|
+
"./src/tools/tech-design/skills/tech-design/SKILL.md",
|
|
28
|
+
"./src/tools/wrapup/skills/wrapup/SKILL.md"
|
|
29
|
+
],
|
|
30
|
+
"commands": [
|
|
31
|
+
"./src/tools/brain/commands/brain.md",
|
|
32
|
+
"./src/tools/coach/commands/coach.md",
|
|
33
|
+
"./src/tools/code-review/commands/code-review.md",
|
|
34
|
+
"./src/tools/codex/commands/codex.md",
|
|
35
|
+
"./src/tools/comments/commands/comments.md",
|
|
36
|
+
"./src/tools/droid/commands/setup.md",
|
|
37
|
+
"./src/tools/plan/commands/plan.md",
|
|
38
|
+
"./src/tools/project/commands/project.md",
|
|
39
|
+
"./src/tools/tech-design/commands/tech-design.md",
|
|
40
|
+
"./src/tools/wrapup/commands/wrapup.md"
|
|
41
|
+
],
|
|
42
|
+
"agents": [
|
|
43
|
+
"./src/tools/code-review/agents/edi-standards-reviewer.md",
|
|
44
|
+
"./src/tools/code-review/agents/error-handling-reviewer.md",
|
|
45
|
+
"./src/tools/code-review/agents/test-coverage-analyzer.md",
|
|
46
|
+
"./src/tools/code-review/agents/type-reviewer.md",
|
|
47
|
+
"./src/tools/codex/agents/codex-document-processor.md"
|
|
48
|
+
]
|
|
49
|
+
}
|
package/AGENTS.md
CHANGED
|
@@ -101,6 +101,9 @@ Things that will bite you if you don't know:
|
|
|
101
101
|
| Config-first in commands | User overrides must take precedence | Always read `~/.droid/skills/{skill}/overrides.yaml` before using defaults |
|
|
102
102
|
| Changeset package name | npm package is scoped | Use `"@orderful/droid"` not `"droid"` in changesets |
|
|
103
103
|
| Run build before PR | Plugin manifests need regenerating when tools change | Run `bun run build` and commit plugin.json files before creating PR |
|
|
104
|
+
| Marketplace `path` field is ignored | Claude Code always looks for plugin.json at repo root, not at path | Must have `.claude-plugin/plugin.json` at repo root for marketplace |
|
|
105
|
+
| Plugin.json `name` must match install target | Mismatch causes recursive directory nesting and ENAMETOOLONG errors | If installing `droid-brain`, plugin.json must have `name: "droid-brain"` |
|
|
106
|
+
| Marketplace testing requires git push | Local marketplace reads marketplace.json locally but clones from GitHub | Push changes before testing; clearing cache: `rm -rf ~/.claude/plugins/cache/droid` |
|
|
104
107
|
|
|
105
108
|
## Testing
|
|
106
109
|
|
|
@@ -163,6 +166,7 @@ Each tool has a specific domain. Know where your feature belongs:
|
|
|
163
166
|
| `codex` | Shared org knowledge (PRDs, designs) | Codex content management, org context |
|
|
164
167
|
| `comments` | Inline @mentions in code | Comment handling, async collaboration |
|
|
165
168
|
| `droid` | **Meta-tool only** - updates, discovery | NEVER add skills here - create new tool instead |
|
|
169
|
+
| `plan` | Task-scoped planning | Portable, structured plans |
|
|
166
170
|
| `project` | Personal project context | Project file management |
|
|
167
171
|
| `tech-design` | Tech design authoring | Tech design workflows |
|
|
168
172
|
| `wrapup` | Session wrap-up and context capture | End-of-session persistence, context handoff |
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,48 @@
|
|
|
1
1
|
# @orderful/droid
|
|
2
2
|
|
|
3
|
+
## 0.38.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [#229](https://github.com/Orderful/droid/pull/229) [`742c2ef`](https://github.com/Orderful/droid/commit/742c2ef0d2f9ff28eec12d0923eb5c5bdd148dff) Thanks [@yanneg](https://github.com/yanneg)! - Add Claude Code marketplace support:
|
|
8
|
+
- Add skills, commands, and agents fields to plugin.json manifests (required for Claude Code to discover plugin content)
|
|
9
|
+
- Add /setup command for post-marketplace configuration
|
|
10
|
+
|
|
11
|
+
- [#233](https://github.com/Orderful/droid/pull/233) [`1794c20`](https://github.com/Orderful/droid/commit/1794c2020d863561081ba3cb626474cf175df760) Thanks [@frytyler](https://github.com/frytyler)! - Add OpenAI Codex as a supported platform with symlink-based skill installation
|
|
12
|
+
|
|
13
|
+
- [#237](https://github.com/Orderful/droid/pull/237) [`a1b85f0`](https://github.com/Orderful/droid/commit/a1b85f01365bd39cb8e3f324ca894e4e0271debf) Thanks [@frytyler](https://github.com/frytyler)! - Add skill overrides for user-defined behaviour customisation
|
|
14
|
+
|
|
15
|
+
Users can now customize skill behaviour without forking droid:
|
|
16
|
+
- New `~/.droid/skill_overrides/` directory created during setup
|
|
17
|
+
- Template file explains format and provides examples
|
|
18
|
+
- Override files use YAML frontmatter to declare which commands are affected
|
|
19
|
+
- Droid skill handles registration via `droid config --set`
|
|
20
|
+
- Brain skill respects search overrides (pilot implementation)
|
|
21
|
+
- `enabled` flag to toggle overrides on/off without removing config
|
|
22
|
+
|
|
23
|
+
- [#239](https://github.com/Orderful/droid/pull/239) [`6581cc2`](https://github.com/Orderful/droid/commit/6581cc2c2cf1cab72abd524ce091e7a786f4b146) Thanks [@frytyler](https://github.com/frytyler)! - Improve tech-design workflow with unified folder structure, search command, and draft/ready publish
|
|
24
|
+
- **Unified folder structure**: All tech design files now in `{brain_dir}/{inbox?}/tech-designs/{name}/` (research.md, thought-doc.md, diagrams all together)
|
|
25
|
+
- **Search command**: `/tech-design search {term}` finds and resumes existing designs
|
|
26
|
+
- **Draft publish**: Share work-in-progress for early feedback (copies tech-design/ folder only, creates GitHub draft PR)
|
|
27
|
+
- **Ready publish**: Complete design with auto-generated rollup (TECH-DESIGN.md + tech-design/ folder, creates regular PR)
|
|
28
|
+
- **Smart updates**: Update existing draft to ready, or update existing ready design
|
|
29
|
+
- **Research doc inclusion**: Optional research doc copy to codex for reviewer/LLM context
|
|
30
|
+
- **Brain files retained**: Never delete working files in brain after publish
|
|
31
|
+
|
|
32
|
+
### Patch Changes
|
|
33
|
+
|
|
34
|
+
- [#238](https://github.com/Orderful/droid/pull/238) [`358185e`](https://github.com/Orderful/droid/commit/358185e9ea2709dde6dbb9ca181fbe4b34f79271) Thanks [@frytyler](https://github.com/frytyler)! - Fix OpenCode reading outdated skills from platform-specific directory
|
|
35
|
+
|
|
36
|
+
OpenCode checks `~/.config/opencode/skill/` before `~/.claude/skills/`, so old skills there were shadowing updated versions in the unified location. This migration removes ONLY droid-managed skills from OpenCode's platform-specific directory, ensuring OpenCode reads from the unified source of truth.
|
|
37
|
+
|
|
38
|
+
Safety: Only deletes skills bundled with droid. User-authored skills are preserved (learned from PR #232).
|
|
39
|
+
|
|
40
|
+
- [#236](https://github.com/Orderful/droid/pull/236) [`fff41a9`](https://github.com/Orderful/droid/commit/fff41a9b940b4680325dff6f68c88e3bc23d8be8) Thanks [@frytyler](https://github.com/frytyler)! - Auto-sync tools during droid update
|
|
41
|
+
|
|
42
|
+
When droid auto-updates (either via TUI or `droid update` command), it now automatically syncs tools after the npm install completes. This ensures users get updated tool manifests without needing to run `droid update --tools` manually.
|
|
43
|
+
|
|
44
|
+
The implementation spawns the newly-installed binary to run `droid update --tools`, which has access to the new bundled tool manifests. Respects the `auto_update.tools` setting - if disabled, tools won't sync automatically.
|
|
45
|
+
|
|
3
46
|
## 0.37.0
|
|
4
47
|
|
|
5
48
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -16,12 +16,12 @@ AI workflow toolkit for sharing tools, commands, and agents across the engineeri
|
|
|
16
16
|
|
|
17
17
|
Before installing droid:
|
|
18
18
|
|
|
19
|
-
| Requirement
|
|
20
|
-
|
|
21
|
-
| **npm login to @orderful** | Droid is published to our private npm org
|
|
22
|
-
| **bun**
|
|
23
|
-
| **gh** (GitHub CLI)
|
|
24
|
-
| **Obsidian**
|
|
19
|
+
| Requirement | Why | Install |
|
|
20
|
+
| -------------------------- | -------------------------------------------- | ---------------------------------------- |
|
|
21
|
+
| **npm login to @orderful** | Droid is published to our private npm org | `npm login` (use Orderful credentials) |
|
|
22
|
+
| **bun** | Required for `droid exec` scripts | [bun.sh](https://bun.sh) |
|
|
23
|
+
| **gh** (GitHub CLI) | Highly recommended for PR workflows | [cli.github.com](https://cli.github.com) |
|
|
24
|
+
| **Obsidian** | Recommended for brain/codex markdown editing | [obsidian.md](https://obsidian.md) |
|
|
25
25
|
|
|
26
26
|
## Setup Gotchas
|
|
27
27
|
|
|
@@ -74,20 +74,16 @@ droid
|
|
|
74
74
|
|
|
75
75
|
The TUI guides you through setup and tool installation. Works with both Claude Code and OpenCode.
|
|
76
76
|
|
|
77
|
-
### Option B: Claude Code Plugin
|
|
77
|
+
### Option B: Claude Code Plugin
|
|
78
78
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
Install individual tools directly through Claude Code's plugin system:
|
|
79
|
+
Install directly through Claude Code's plugin system:
|
|
82
80
|
|
|
83
81
|
```bash
|
|
84
82
|
# Add the Droid marketplace
|
|
85
83
|
/plugin marketplace add orderful/droid
|
|
86
84
|
|
|
87
|
-
# Install
|
|
88
|
-
/plugin install droid
|
|
89
|
-
/plugin install droid-comments@droid
|
|
90
|
-
/plugin install droid-code-review@droid
|
|
85
|
+
# Install all droid tools
|
|
86
|
+
/plugin install droid@droid
|
|
91
87
|
```
|
|
92
88
|
|
|
93
89
|
## The TUI
|
|
@@ -108,17 +104,17 @@ Browse available tools, see what's installed, and manage everything from one pla
|
|
|
108
104
|
|
|
109
105
|
## Available Tools
|
|
110
106
|
|
|
111
|
-
| Tool
|
|
112
|
-
|
|
113
|
-
| **comments**
|
|
114
|
-
| **project**
|
|
115
|
-
| **brain**
|
|
116
|
-
| **plan**
|
|
117
|
-
| **coach**
|
|
118
|
-
| **codex**
|
|
119
|
-
| **code-review** | Multi-agent code review with specialized checkers
|
|
120
|
-
| **tech-design** | Three-document approach for technical designs
|
|
121
|
-
| **wrapup**
|
|
107
|
+
| Tool | Description | Status |
|
|
108
|
+
| --------------- | ----------------------------------------------------------------- | ------ |
|
|
109
|
+
| **comments** | Inline `@droid`/`@user` conversations in any file | beta |
|
|
110
|
+
| **project** | Persistent project context across sessions | beta |
|
|
111
|
+
| **brain** | Collaborative scratch pad for planning & research | beta |
|
|
112
|
+
| **plan** | Task-scoped planning with portable, structured plans | alpha |
|
|
113
|
+
| **coach** | Learning-mode AI - scaffolds don't implement, questions don't fix | beta |
|
|
114
|
+
| **codex** | Shared organizational knowledge - PRDs, tech designs, patterns | beta |
|
|
115
|
+
| **code-review** | Multi-agent code review with specialized checkers | alpha |
|
|
116
|
+
| **tech-design** | Three-document approach for technical designs | beta |
|
|
117
|
+
| **wrapup** | Session wrap-up that captures decisions to persistent docs | alpha |
|
|
122
118
|
|
|
123
119
|
### Comments
|
|
124
120
|
|
|
@@ -188,38 +184,55 @@ Config lives in `~/.droid/`:
|
|
|
188
184
|
|
|
189
185
|
```
|
|
190
186
|
~/.droid/
|
|
191
|
-
|
|
187
|
+
├── config.yaml # Global config (platform, user settings, tool config)
|
|
188
|
+
└── skill_overrides/ # User-defined skill behaviour overrides
|
|
189
|
+
├── _template.md # Template and instructions
|
|
190
|
+
└── {skill}.md # Override for specific skill
|
|
192
191
|
```
|
|
193
192
|
|
|
194
193
|
Key sections in `config.yaml`:
|
|
194
|
+
|
|
195
195
|
- `platform` - Primary platform (claude-code, opencode, cursor)
|
|
196
196
|
- `user_mention` - Your @mention for comments (e.g., `@fry`)
|
|
197
197
|
- `tools` - Per-tool configuration (brain paths, codex repo, etc.)
|
|
198
198
|
- `auto_update` - Auto-update settings for app and tools
|
|
199
199
|
- `repos` - Known repositories for context
|
|
200
200
|
|
|
201
|
+
### Skill Overrides
|
|
202
|
+
|
|
203
|
+
Customize skill behaviour without forking droid. Create override files in `~/.droid/skill_overrides/` to replace specific commands with your own instructions.
|
|
204
|
+
|
|
205
|
+
**Example:** Use semantic search with [qmd](https://github.com/qmdnls/qmd) instead of filename matching for `/brain search`:
|
|
206
|
+
|
|
207
|
+
1. Ask droid: "Create an override for brain search that uses qmd"
|
|
208
|
+
2. Droid creates `~/.droid/skill_overrides/brain.md` with your instructions
|
|
209
|
+
3. Droid registers it in config
|
|
210
|
+
4. Next `/brain search` uses your qmd workflow
|
|
211
|
+
|
|
212
|
+
See `~/.droid/skill_overrides/_template.md` for format details.
|
|
213
|
+
|
|
201
214
|
**Where tools install:**
|
|
202
215
|
|
|
203
216
|
Skills are unified across all platforms to `~/.claude/skills/`. Commands and agents are platform-specific:
|
|
204
217
|
|
|
205
|
-
| Platform
|
|
206
|
-
|
|
207
|
-
| Claude Code | `~/.claude/skills/` | `~/.claude/commands/`
|
|
208
|
-
| OpenCode
|
|
209
|
-
| Cursor
|
|
218
|
+
| Platform | Skills | Commands | Agents |
|
|
219
|
+
| ----------- | ------------------- | ----------------------------- | --------------------------- |
|
|
220
|
+
| Claude Code | `~/.claude/skills/` | `~/.claude/commands/` | `~/.claude/agents/` |
|
|
221
|
+
| OpenCode | `~/.claude/skills/` | `~/.config/opencode/command/` | `~/.config/opencode/agent/` |
|
|
222
|
+
| Cursor | `~/.claude/skills/` | `~/.cursor/commands/` | `~/.cursor/agents/` |
|
|
210
223
|
|
|
211
224
|
## CLI Reference
|
|
212
225
|
|
|
213
226
|
While the TUI is the primary interface, direct commands are available:
|
|
214
227
|
|
|
215
|
-
| Command
|
|
216
|
-
|
|
217
|
-
| `droid`
|
|
218
|
-
| `droid setup`
|
|
219
|
-
| `droid install <tool>`
|
|
220
|
-
| `droid uninstall <tool>`
|
|
221
|
-
| `droid update`
|
|
222
|
-
| `droid config`
|
|
228
|
+
| Command | Description |
|
|
229
|
+
| ----------------------------- | ---------------------------------- |
|
|
230
|
+
| `droid` | Launch TUI dashboard |
|
|
231
|
+
| `droid setup` | Run setup wizard |
|
|
232
|
+
| `droid install <tool>` | Install a tool |
|
|
233
|
+
| `droid uninstall <tool>` | Remove a tool |
|
|
234
|
+
| `droid update` | Update droid and tools |
|
|
235
|
+
| `droid config` | View/edit config |
|
|
223
236
|
| `droid exec <skill> <script>` | Run a skill's deterministic script |
|
|
224
237
|
|
|
225
238
|
## Development
|
|
@@ -250,6 +263,7 @@ See [AGENTS.md](AGENTS.md) for detailed contributor guidance. Quick overview:
|
|
|
250
263
|
6. Submit a PR
|
|
251
264
|
|
|
252
265
|
The build script generates:
|
|
266
|
+
|
|
253
267
|
- `.claude-plugin/marketplace.json` at repo root (lists all plugins)
|
|
254
268
|
- `src/tools/{name}/.claude-plugin/plugin.json` for each tool
|
|
255
269
|
|