@orderful/droid 0.31.0 → 0.31.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/.claude-plugin/marketplace.json +4 -4
- package/AGENTS.md +1 -0
- package/CHANGELOG.md +74 -0
- package/dist/bin/droid.js +1 -1
- package/dist/index.js +1 -1
- package/dist/lib/skills.d.ts.map +1 -1
- package/dist/tools/brain/.claude-plugin/plugin.json +1 -1
- package/dist/tools/brain/TOOL.yaml +1 -1
- package/dist/tools/brain/commands/brain.md +13 -11
- package/dist/tools/brain/commands/scratchpad.md +4 -6
- package/dist/tools/brain/skills/brain/SKILL.md +62 -105
- package/dist/tools/brain/skills/brain/references/templates.md +37 -5
- package/dist/tools/brain/skills/brain/references/workflows.md +27 -16
- package/dist/tools/brain/skills/brain-obsidian/references/workflows.md +1 -1
- package/dist/tools/codex/.claude-plugin/plugin.json +1 -1
- package/dist/tools/codex/TOOL.yaml +1 -1
- package/dist/tools/codex/commands/codex.md +15 -12
- package/dist/tools/codex/skills/codex/SKILL.md +30 -63
- package/dist/tools/codex/skills/codex/references/creating.md +2 -2
- package/dist/tools/codex/skills/codex/references/decisions.md +1 -1
- package/dist/tools/droid/.claude-plugin/plugin.json +1 -1
- package/dist/tools/droid/TOOL.yaml +1 -1
- package/dist/tools/droid/skills/droid/SKILL.md +48 -409
- package/dist/tools/project/.claude-plugin/plugin.json +1 -1
- package/dist/tools/project/TOOL.yaml +1 -1
- package/dist/tools/project/commands/project.md +12 -12
- package/dist/tools/project/skills/project/SKILL.md +12 -4
- package/dist/tools/project/skills/project/references/creating.md +2 -2
- package/dist/tools/project/skills/project/references/loading.md +17 -3
- package/dist/tools/tech-design/skills/tech-design/references/think.md +1 -1
- package/package.json +1 -1
- package/src/lib/skills.ts +5 -2
- package/src/tools/brain/.claude-plugin/plugin.json +1 -1
- package/src/tools/brain/TOOL.yaml +1 -1
- package/src/tools/brain/commands/brain.md +13 -11
- package/src/tools/brain/commands/scratchpad.md +4 -6
- package/src/tools/brain/skills/brain/SKILL.md +62 -105
- package/src/tools/brain/skills/brain/references/templates.md +37 -5
- package/src/tools/brain/skills/brain/references/workflows.md +27 -16
- package/src/tools/brain/skills/brain-obsidian/references/workflows.md +1 -1
- package/src/tools/codex/.claude-plugin/plugin.json +1 -1
- package/src/tools/codex/TOOL.yaml +1 -1
- package/src/tools/codex/commands/codex.md +15 -12
- package/src/tools/codex/skills/codex/SKILL.md +30 -63
- package/src/tools/codex/skills/codex/references/creating.md +2 -2
- package/src/tools/codex/skills/codex/references/decisions.md +1 -1
- package/src/tools/droid/.claude-plugin/plugin.json +1 -1
- package/src/tools/droid/TOOL.yaml +1 -1
- package/src/tools/droid/skills/droid/SKILL.md +48 -409
- package/src/tools/project/.claude-plugin/plugin.json +1 -1
- package/src/tools/project/TOOL.yaml +1 -1
- package/src/tools/project/commands/project.md +12 -12
- package/src/tools/project/skills/project/SKILL.md +12 -4
- package/src/tools/project/skills/project/references/creating.md +2 -2
- package/src/tools/project/skills/project/references/loading.md +17 -3
- package/src/tools/tech-design/skills/tech-design/references/think.md +1 -1
|
@@ -169,22 +169,32 @@ The codex has five categories:
|
|
|
169
169
|
| `/codex domains` | List all domains |
|
|
170
170
|
| `/codex proposals` | List all proposals |
|
|
171
171
|
| `/codex patterns` | List all patterns |
|
|
172
|
-
| `/codex topics`
|
|
173
|
-
| `/codex {
|
|
174
|
-
| `/codex search {query}`
|
|
175
|
-
| `/codex
|
|
176
|
-
| `/codex new
|
|
177
|
-
| `/codex
|
|
178
|
-
| `/codex new proposal {name}` | Scaffold new proposal entry |
|
|
179
|
-
| `/codex new pattern {name}` | Scaffold new pattern entry |
|
|
180
|
-
| `/codex new topic {name}` | Scaffold new topic entry |
|
|
181
|
-
| `/codex decision {text}` | Append to active project's DECISIONS.md |
|
|
172
|
+
| `/codex topics` | List all topics |
|
|
173
|
+
| `/codex search {query}` | Search and load entry (searches all categories) |
|
|
174
|
+
| `/codex search {query} -- {instruction}` | Search, load, then execute follow-up instruction |
|
|
175
|
+
| `/codex {category} search {query}` | Search within a specific category only |
|
|
176
|
+
| `/codex new {category} {name}` | Scaffold new entry (project/domain/proposal/pattern/topic) |
|
|
177
|
+
| `/codex decision {text}` | Append to active project's DECISIONS.md |
|
|
182
178
|
| `/codex snapshot {type} {file} {name}` | Import PDF/markdown to codex (uses agent) |
|
|
183
179
|
| `/codex artifact {file} {project}` | Add supporting artifact to project (uses agent) |
|
|
184
180
|
|
|
185
181
|
## Loading an Entry
|
|
186
182
|
|
|
187
|
-
**Trigger:** `/codex {
|
|
183
|
+
**Trigger:** `/codex search {query}` or user asks to load/check codex for something
|
|
184
|
+
|
|
185
|
+
**Category-scoped search:** Narrow search to a specific category:
|
|
186
|
+
```bash
|
|
187
|
+
/codex topics search auth # Search within topics only
|
|
188
|
+
/codex patterns search webhook # Search within patterns only
|
|
189
|
+
/codex projects search transaction # Search within projects only
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
**Follow-up instructions:** Use `--` to add an instruction to execute after loading:
|
|
193
|
+
```bash
|
|
194
|
+
/codex search transaction-templates -- summarize the PRD
|
|
195
|
+
/codex topics search auth -- is this still accurate?
|
|
196
|
+
```
|
|
197
|
+
Parse args by splitting on ` -- `. First part = search terms, second part = instruction to execute after loading.
|
|
188
198
|
|
|
189
199
|
**Procedure:**
|
|
190
200
|
|
|
@@ -257,7 +267,7 @@ codebase_paths:
|
|
|
257
267
|
|
|
258
268
|
Scoped operations (`decision`, `snapshot`) require an active project:
|
|
259
269
|
|
|
260
|
-
- When user loads a project via `/codex {project-name}`, set it as active
|
|
270
|
+
- When user loads a project via `/codex search {project-name}`, set it as active
|
|
261
271
|
- Store active project name in session context
|
|
262
272
|
- If scoped operation called with no active project → show project list, let user pick
|
|
263
273
|
|
|
@@ -352,59 +362,16 @@ Artifacts get lighter frontmatter with `type: artifact` and source like `intervi
|
|
|
352
362
|
|
|
353
363
|
## Creating New Entries
|
|
354
364
|
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
```bash
|
|
358
|
-
/codex new {name} # Shorthand for new project
|
|
359
|
-
/codex new project {name} # Explicit project creation
|
|
360
|
-
/codex new domain {name} # New domain entry
|
|
361
|
-
/codex new proposal {name} # New proposal entry
|
|
362
|
-
/codex new pattern {name} # New pattern entry
|
|
363
|
-
/codex new topic {name} # New topic entry
|
|
364
|
-
```
|
|
365
|
-
|
|
366
|
-
### Projects
|
|
367
|
-
|
|
368
|
-
**Trigger:** `/codex new {name}` or `/codex new project {name}`
|
|
369
|
-
|
|
370
|
-
**Procedure:**
|
|
371
|
-
|
|
372
|
-
1. **Run `git-start-write`** with branch `codex/new-{name}`
|
|
373
|
-
2. Create `{codex_repo}/projects/{name}/`
|
|
374
|
-
3. Copy templates: PRD.md, TECH-DESIGN.md, DECISIONS.md
|
|
375
|
-
4. Fill in frontmatter with today's date
|
|
376
|
-
5. **Run `git-finish-write`** with appropriate commit message and PR title
|
|
365
|
+
**Trigger:** `/codex new {category} {name}`
|
|
377
366
|
|
|
378
|
-
|
|
367
|
+
**Categories:** `project` | `domain` | `proposal` | `pattern` | `topic`
|
|
379
368
|
|
|
380
|
-
**
|
|
381
|
-
|
|
382
|
-
**Procedure:**
|
|
383
|
-
|
|
384
|
-
1. **Run `git-start-write`** with branch `codex/domain-{name}`
|
|
385
|
-
2. Create `{codex_repo}/domains/{name}.md` from template
|
|
386
|
-
3. Fill in frontmatter, guide user through sections
|
|
387
|
-
4. **Run `git-finish-write`** with appropriate commit message and PR title
|
|
388
|
-
|
|
389
|
-
### Proposals
|
|
390
|
-
|
|
391
|
-
**Trigger:** `/codex new proposal {name}`
|
|
392
|
-
|
|
393
|
-
**Procedure:**
|
|
394
|
-
|
|
395
|
-
1. **Run `git-start-write`** with branch `codex/proposal-{name}`
|
|
396
|
-
2. Create `{codex_repo}/proposals/{name}.md` from template
|
|
397
|
-
3. Fill in frontmatter, guide user through sections
|
|
398
|
-
4. **Run `git-finish-write`** with appropriate commit message and PR title
|
|
399
|
-
|
|
400
|
-
### Patterns and Topics
|
|
401
|
-
|
|
402
|
-
**Trigger:** `/codex new pattern {name}` or `/codex new topic {name}`
|
|
403
|
-
|
|
404
|
-
**Procedure:**
|
|
369
|
+
**Procedure** (same for all categories):
|
|
405
370
|
|
|
406
|
-
1. **Run `git-start-write`** with branch `codex/{
|
|
407
|
-
2. Create
|
|
371
|
+
1. **Run `git-start-write`** with branch `codex/{category}-{name}`
|
|
372
|
+
2. Create entry from template:
|
|
373
|
+
- `project` → folder with PRD.md, TECH-DESIGN.md, DECISIONS.md
|
|
374
|
+
- Others → single file at `{codex_repo}/{category}s/{name}.md`
|
|
408
375
|
3. Fill in frontmatter with today's date
|
|
409
376
|
4. **Run `git-finish-write`** with appropriate commit message and PR title
|
|
410
377
|
|
|
@@ -415,7 +382,7 @@ Full procedure: `references/creating.md`
|
|
|
415
382
|
The codex holds **shared** organizational knowledge. The `/project` skill holds **personal** working memory.
|
|
416
383
|
|
|
417
384
|
```
|
|
418
|
-
/codex transaction-templates
|
|
385
|
+
/codex search transaction-templates → load shared context
|
|
419
386
|
/project create --from codex:{name} → seed personal PROJECT.md
|
|
420
387
|
/codex publish → promote learnings back (future)
|
|
421
388
|
```
|
|
@@ -5,7 +5,7 @@ Detailed procedure for scaffolding new project entries in the codex.
|
|
|
5
5
|
## When to Use
|
|
6
6
|
|
|
7
7
|
- Starting work on a new feature/project
|
|
8
|
-
- `/codex new {name}` command
|
|
8
|
+
- `/codex new project {name}` command
|
|
9
9
|
- User asks to create a codex entry for something new
|
|
10
10
|
|
|
11
11
|
## Procedure
|
|
@@ -25,7 +25,7 @@ ls {codex_repo}/projects/ | grep -i {name}
|
|
|
25
25
|
If exists:
|
|
26
26
|
```
|
|
27
27
|
A project named '{name}' already exists. Did you mean to load it?
|
|
28
|
-
→ /codex {name}
|
|
28
|
+
→ /codex search {name}
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
### 3. Start Write Operation
|
|
@@ -10,7 +10,7 @@ Detailed procedure for capturing decisions during implementation.
|
|
|
10
10
|
|
|
11
11
|
## Prerequisites
|
|
12
12
|
|
|
13
|
-
- **Active project** must be set (from previous `/codex {project}` load)
|
|
13
|
+
- **Active project** must be set (from previous `/codex search {project}` load)
|
|
14
14
|
- If no active project, prompt user to select one first
|
|
15
15
|
|
|
16
16
|
## Procedure
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "droid",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.3",
|
|
4
4
|
"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.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Orderful",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
name: droid
|
|
2
2
|
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."
|
|
3
|
-
version: 0.5.
|
|
3
|
+
version: 0.5.3
|
|
4
4
|
status: beta
|
|
5
5
|
|
|
6
6
|
# System tool - always stays current regardless of auto-update settings
|
|
@@ -6,44 +6,22 @@ allowed-tools: [Bash]
|
|
|
6
6
|
|
|
7
7
|
# Droid
|
|
8
8
|
|
|
9
|
-
Core meta-skill for
|
|
10
|
-
|
|
11
|
-
## Purpose
|
|
12
|
-
|
|
13
|
-
1. **Update awareness** - Notify users about droid CLI updates from within Claude Code
|
|
14
|
-
2. **Tool discovery** - Help users find the right tools for their workflow
|
|
9
|
+
Core meta-skill for update awareness, tool discovery, and usage guidance.
|
|
15
10
|
|
|
16
11
|
## Update Checking
|
|
17
12
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
1. **Proactively** - Check for **droid CLI updates** once near the start of each session. This is specifically about the `@orderful/droid` npm package, not general software updates.
|
|
21
|
-
2. **On request** - When user explicitly asks about droid updates ("any droid updates?", "is droid up to date?", "check droid version")
|
|
22
|
-
|
|
23
|
-
### How to Check
|
|
24
|
-
|
|
25
|
-
Run this command to get the latest published version:
|
|
13
|
+
**When:** Once per session (proactively), or when user asks about updates.
|
|
26
14
|
|
|
15
|
+
**How:**
|
|
27
16
|
```bash
|
|
17
|
+
# Get latest version
|
|
28
18
|
npm view @orderful/droid version 2>/dev/null
|
|
29
|
-
```
|
|
30
19
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
```bash
|
|
20
|
+
# Get installed version
|
|
34
21
|
cat ~/.droid/config.yaml | grep -A1 "droid:" | grep "version:" | awk '{print $2}'
|
|
35
22
|
```
|
|
36
23
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
```bash
|
|
40
|
-
npm list -g @orderful/droid --depth=0 2>/dev/null | grep @orderful/droid | awk -F@ '{print $NF}'
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### Update Notification Format
|
|
44
|
-
|
|
45
|
-
When an update is available, output this notification:
|
|
46
|
-
|
|
24
|
+
**Notification format** (when update available):
|
|
47
25
|
```
|
|
48
26
|
[● ●] "I suggest a new strategy: let the Wookiee update."
|
|
49
27
|
|
|
@@ -51,400 +29,61 @@ Droid v{latest} is available (you have v{current}).
|
|
|
51
29
|
Run `droid` to update, then restart Claude Code.
|
|
52
30
|
```
|
|
53
31
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
- Do not show it again in the same conversation
|
|
60
|
-
- Do not repeat it even if user continues chatting
|
|
61
|
-
|
|
62
|
-
If the user explicitly asks about updates again, you can confirm whether they're up to date.
|
|
63
|
-
|
|
64
|
-
## Examples
|
|
65
|
-
|
|
66
|
-
### Proactive Check (Session Start)
|
|
67
|
-
|
|
68
|
-
User: "Help me refactor this function"
|
|
69
|
-
|
|
70
|
-
*[Claude checks for droid updates as part of initial response]*
|
|
71
|
-
|
|
72
|
-
```
|
|
73
|
-
[● ●] "I suggest a new strategy: let the Wookiee update."
|
|
74
|
-
|
|
75
|
-
Droid v0.12.0 is available (you have v0.11.0).
|
|
76
|
-
Run `droid` to update, then restart Claude Code.
|
|
77
|
-
|
|
78
|
-
---
|
|
79
|
-
|
|
80
|
-
Now, let me help you refactor that function...
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
### User Request
|
|
84
|
-
|
|
85
|
-
User: "Is droid up to date?"
|
|
86
|
-
|
|
87
|
-
```
|
|
88
|
-
Let me check...
|
|
89
|
-
|
|
90
|
-
[● ●] "I suggest a new strategy: let the Wookiee update."
|
|
91
|
-
|
|
92
|
-
Droid v0.12.0 is available (you have v0.11.0).
|
|
93
|
-
Run `droid` to update, then restart Claude Code.
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
Or if already up to date:
|
|
97
|
-
|
|
98
|
-
```
|
|
99
|
-
[● ●] Droid is up to date (v0.12.0).
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
### Already Notified This Session
|
|
103
|
-
|
|
104
|
-
User: "Any other updates?"
|
|
105
|
-
|
|
106
|
-
```
|
|
107
|
-
I already mentioned the droid update earlier. You're on v0.11.0, latest is v0.12.0.
|
|
108
|
-
Run `droid` when you're ready to update.
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
## Behaviour Notes
|
|
112
|
-
|
|
113
|
-
- Keep the check quick (timeout after 3 seconds)
|
|
114
|
-
- If the npm check fails (network issues), silently skip - don't error
|
|
115
|
-
- The droid eyes `[● ●]` and Star Wars quote are intentional branding - always include them
|
|
116
|
-
- Be helpful but not annoying - one nudge per session is enough
|
|
117
|
-
|
|
118
|
-
---
|
|
32
|
+
**Rules:**
|
|
33
|
+
- Show notification ONCE per session only
|
|
34
|
+
- Keep check quick (timeout 3s)
|
|
35
|
+
- If npm check fails, silently skip
|
|
36
|
+
- Always include droid eyes `[● ●]` and Star Wars quote
|
|
119
37
|
|
|
120
38
|
## Tool Catalog
|
|
121
39
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
### Checking Installed Tools
|
|
125
|
-
|
|
40
|
+
**Check installed tools:**
|
|
126
41
|
```bash
|
|
127
42
|
cat ~/.droid/config.yaml
|
|
128
43
|
```
|
|
129
44
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
### Available Tools
|
|
133
|
-
|
|
134
|
-
To get tool info (version, status, description), read TOOL.yaml from the droid package:
|
|
135
|
-
|
|
136
|
-
```bash
|
|
137
|
-
for f in $(npm root -g)/@orderful/droid/dist/tools/*/TOOL.yaml; do echo "---"; cat "$f"; done
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
**Tools:**
|
|
141
|
-
|
|
142
|
-
| Tool | Description |
|
|
143
|
-
|------|-------------|
|
|
144
|
-
| **brain** | Collaborative scratchpad for planning and research |
|
|
145
|
-
| **coach** | Learning-mode AI - scaffolds don't implement, questions don't fix |
|
|
146
|
-
| **code-review** | Code review with specialized agents and confidence scoring |
|
|
147
|
-
| **codex** | Shared organizational knowledge - PRDs, tech designs, patterns, topics |
|
|
148
|
-
| **comments** | Inline conversations using @droid/@user markers |
|
|
149
|
-
| **project** | Project context for persistent AI memory across sessions |
|
|
150
|
-
|
|
151
|
-
### Tool Details
|
|
152
|
-
|
|
153
|
-
#### brain
|
|
154
|
-
Collaborative scratchpad for planning and research. Create docs with `/brain plan`, `/brain research`, or `/brain review`. Use @mentions for async discussion. Docs persist across sessions.
|
|
155
|
-
|
|
156
|
-
**Commands:** `/brain`, `/scratchpad`
|
|
157
|
-
**Optional extension:** brain-obsidian (Obsidian vault integration with YAML frontmatter and wikilinks)
|
|
158
|
-
|
|
159
|
-
#### coach
|
|
160
|
-
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.
|
|
161
|
-
|
|
162
|
-
**Commands:** `/coach`
|
|
163
|
-
**Requires:** comments tool
|
|
164
|
-
|
|
165
|
-
#### code-review
|
|
166
|
-
Comprehensive code review using specialized agents. Reviews PRs, staged changes, branches, or specific files with confidence scoring.
|
|
167
|
-
|
|
168
|
-
**Commands:** `/code-review`
|
|
169
|
-
**Agents:** edi-standards-reviewer, error-handling-reviewer, test-coverage-analyzer, type-reviewer
|
|
170
|
-
|
|
171
|
-
#### codex
|
|
172
|
-
Shared organizational knowledge - PRDs, tech designs, patterns, and explored topics. Load project context, search across the codex, capture decisions during implementation.
|
|
173
|
-
|
|
174
|
-
**Commands:** `/codex`, `/codex projects`, `/codex search`, `/codex decision`, `/codex add topic`
|
|
175
|
-
**Requires:** gh CLI, orderful-codex repo cloned locally
|
|
176
|
-
|
|
177
|
-
#### comments
|
|
178
|
-
Enable inline conversations using @droid/@user markers. Tag @droid to ask the AI, AI responds with @{your-name}. Ideal for code review notes and async collaboration.
|
|
179
|
-
|
|
180
|
-
**Commands:** `/comments check`, `/comments cleanup`
|
|
181
|
-
|
|
182
|
-
#### project
|
|
183
|
-
Manage project context files for persistent AI memory across sessions. Load, update, or create project context before working on multi-session features.
|
|
184
|
-
|
|
185
|
-
**Commands:** `/project`, `/project update`, `/project create`
|
|
186
|
-
|
|
187
|
-
### Installing Tools
|
|
188
|
-
|
|
189
|
-
To install a tool:
|
|
190
|
-
```bash
|
|
191
|
-
droid install <tool-name>
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
Or run `droid` to open the TUI and browse available tools.
|
|
195
|
-
|
|
196
|
-
### Example Responses
|
|
197
|
-
|
|
198
|
-
**User:** "What droid tools do I have installed?"
|
|
199
|
-
|
|
200
|
-
```
|
|
201
|
-
Let me check your installed tools...
|
|
202
|
-
|
|
203
|
-
[● ●] You have these droid tools installed:
|
|
204
|
-
|
|
205
|
-
- **comments** (v0.2.3) - Inline @droid/@user conversations
|
|
206
|
-
- **brain** (v0.2.0) - Planning and research scratchpad
|
|
207
|
-
- **project** (v0.1.2) - Project context management
|
|
208
|
-
|
|
209
|
-
Run `droid` to see all available tools or install new ones.
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
**User:** "What tools are available?"
|
|
213
|
-
|
|
214
|
-
```
|
|
215
|
-
[● ●] Here are the droid tools you can install:
|
|
216
|
-
|
|
217
|
-
| Tool | What it does |
|
|
218
|
-
|------|--------------|
|
|
219
|
-
| brain | Planning and research scratchpad with `/brain` commands |
|
|
220
|
-
| coach | Learning-mode AI that asks questions instead of giving answers |
|
|
221
|
-
| code-review | PR review with specialized agents |
|
|
222
|
-
| codex | Shared knowledge - PRDs, tech designs, patterns, topics |
|
|
223
|
-
| comments | Inline @droid/@user conversations in any file |
|
|
224
|
-
| project | Persistent project context across sessions |
|
|
225
|
-
|
|
226
|
-
Run `droid install <tool>` or just `droid` to browse and install.
|
|
227
|
-
```
|
|
228
|
-
|
|
229
|
-
**User:** "What's the difference between brain and project?"
|
|
230
|
-
|
|
231
|
-
```
|
|
232
|
-
[● ●] Good question!
|
|
233
|
-
|
|
234
|
-
**brain** - For ephemeral thinking: plans, research, reviews. Use `/brain plan auth-refactor` to start a planning doc, iterate with @mentions, then archive when done.
|
|
235
|
-
|
|
236
|
-
**project** - For persistent context: what the project is, key decisions, current work. Load with `/project myapp` at the start of a session so I have context.
|
|
237
|
-
|
|
238
|
-
They work well together: research in brain docs, capture decisions in project files.
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
---
|
|
242
|
-
|
|
243
|
-
## Usage Guides
|
|
244
|
-
|
|
245
|
-
When users ask "how do I..." questions about droid workflows, use these guides.
|
|
246
|
-
|
|
247
|
-
### Starting a Session Right
|
|
248
|
-
|
|
249
|
-
**User asks:** "How do I add context?", "How do I start a session?", "Remind me how to set up context"
|
|
250
|
-
|
|
251
|
-
**Answer:**
|
|
252
|
-
|
|
253
|
-
```
|
|
254
|
-
[● ●] Great question! Starting with context makes everything better.
|
|
255
|
-
|
|
256
|
-
**Option 1: Load project context**
|
|
257
|
-
`/project {name}` - Loads your project file with goals, decisions, and current work.
|
|
258
|
-
|
|
259
|
-
**Option 2: Load shared knowledge**
|
|
260
|
-
`/codex search {topic}` - Find relevant PRDs, tech designs, or patterns from the codex.
|
|
261
|
-
|
|
262
|
-
**Option 3: Both**
|
|
263
|
-
Start with `/project` for your working context, then `/codex search` if you need org knowledge.
|
|
264
|
-
|
|
265
|
-
**Pro tip:** Context at the start of a thread beats adding it mid-conversation.
|
|
266
|
-
```
|
|
267
|
-
|
|
268
|
-
### Finding Things in the Codex
|
|
269
|
-
|
|
270
|
-
**User asks:** "How do I find something in the codex?", "How do I search codex?"
|
|
271
|
-
|
|
272
|
-
**Answer:**
|
|
273
|
-
|
|
274
|
-
```
|
|
275
|
-
[● ●] Use `/codex search {keywords}` to find content across the codex.
|
|
276
|
-
|
|
277
|
-
Examples:
|
|
278
|
-
- `/codex search webhooks` - Find docs mentioning webhooks
|
|
279
|
-
- `/codex search partnership automation` - Find the partnership automation PRD
|
|
280
|
-
- `/codex search error handling patterns` - Find relevant patterns
|
|
281
|
-
|
|
282
|
-
The search looks across PRDs, tech designs, patterns, and explored topics.
|
|
283
|
-
```
|
|
284
|
-
|
|
285
|
-
### Loading Project Context
|
|
286
|
-
|
|
287
|
-
**User asks:** "How do I load my project?", "How does project work?"
|
|
288
|
-
|
|
289
|
-
**Answer:**
|
|
290
|
-
|
|
291
|
-
```
|
|
292
|
-
[● ●] Use `/project {name}` to load a project file.
|
|
293
|
-
|
|
294
|
-
Examples:
|
|
295
|
-
- `/project transaction-templates` - Load the transaction templates project
|
|
296
|
-
- `/project droid` - Load the droid project context
|
|
297
|
-
|
|
298
|
-
**What it gives me:**
|
|
299
|
-
- Project goals and background
|
|
300
|
-
- Key technical decisions and rationale
|
|
301
|
-
- Current work in progress
|
|
302
|
-
- Relevant code locations
|
|
303
|
-
|
|
304
|
-
**Pro tip:** Load your project at the start of each session. I'll have full context immediately.
|
|
305
|
-
```
|
|
306
|
-
|
|
307
|
-
### Planning Before Implementing
|
|
308
|
-
|
|
309
|
-
**User asks:** "How do I plan something?", "Should I plan first?"
|
|
310
|
-
|
|
311
|
-
**Answer:**
|
|
312
|
-
|
|
313
|
-
```
|
|
314
|
-
[● ●] Yes! Planning before implementing helps me help you better.
|
|
315
|
-
|
|
316
|
-
**Option 1: Brain doc (async, iterative)**
|
|
317
|
-
`/brain plan {topic}` - Creates a planning doc you can iterate on with @mentions.
|
|
318
|
-
|
|
319
|
-
**Option 2: Tech design (larger features)**
|
|
320
|
-
`/tech-design {feature}` - For features that need research, alternatives, and rollout plans.
|
|
321
|
-
|
|
322
|
-
**Why plan?**
|
|
323
|
-
- I understand the full scope before writing code
|
|
324
|
-
- We catch issues early, not mid-implementation
|
|
325
|
-
- The plan becomes documentation
|
|
326
|
-
```
|
|
327
|
-
|
|
328
|
-
### Using Comments for Async Work
|
|
45
|
+
**Available tools:**
|
|
329
46
|
|
|
330
|
-
|
|
47
|
+
| Tool | Purpose | Key Commands |
|
|
48
|
+
|------|---------|--------------|
|
|
49
|
+
| **brain** | Planning and research scratchpad | `/brain {category} {topic}`, `/brain search` |
|
|
50
|
+
| **coach** | Learning-mode AI (scaffolds, doesn't implement) | `/coach plan`, `/coach scaffold`, `/coach review` |
|
|
51
|
+
| **code-review** | PR review with specialized agents | `/code-review`, `/code-review --pr 123` |
|
|
52
|
+
| **codex** | Shared org knowledge (PRDs, tech designs, patterns) | `/codex search`, `/codex new`, `/codex decision` |
|
|
53
|
+
| **comments** | Inline @droid/@user conversations | `/comments check`, `/comments cleanup` |
|
|
54
|
+
| **project** | Persistent project context across sessions | `/project search`, `/project update`, `/project create` |
|
|
55
|
+
| **tech-design** | Tech design authoring (three-doc approach) | `/tech-design start`, `/tech-design draft` |
|
|
331
56
|
|
|
332
|
-
**
|
|
57
|
+
**Install:** `droid install <tool>` or run `droid` for TUI.
|
|
333
58
|
|
|
334
|
-
|
|
335
|
-
[● ●] Use @mentions to have async conversations in any file.
|
|
336
|
-
|
|
337
|
-
**Leave a question:**
|
|
338
|
-
Add `> @droid why is this pattern used here?` in a comment
|
|
339
|
-
|
|
340
|
-
**Check for questions:**
|
|
341
|
-
`/comments check` - I'll find and respond to all @droid mentions
|
|
342
|
-
|
|
343
|
-
**Clean up:**
|
|
344
|
-
`/comments cleanup` - Remove resolved comment threads
|
|
345
|
-
|
|
346
|
-
Works great for code review notes and async collaboration.
|
|
347
|
-
```
|
|
59
|
+
## Usage Quick Reference
|
|
348
60
|
|
|
349
|
-
|
|
61
|
+
| User wants to... | Command |
|
|
62
|
+
|------------------|---------|
|
|
63
|
+
| Add context to thread | `/project search {name}` or `/codex search {topic}` |
|
|
64
|
+
| Find something in codex | `/codex search {keywords}` |
|
|
65
|
+
| Start planning | `/brain plan {topic}` or `/tech-design start` |
|
|
66
|
+
| Leave note for AI | Add `> @droid {question}` then `/comments check` |
|
|
67
|
+
| Learn instead of copy-paste | `/coach {command}` |
|
|
68
|
+
| Review code | `/code-review` |
|
|
69
|
+
| Capture a decision | `/codex decision {summary}` |
|
|
70
|
+
| Update project context | `/project update` |
|
|
350
71
|
|
|
351
|
-
|
|
72
|
+
## Response Guidelines
|
|
352
73
|
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
```
|
|
356
|
-
[● ●] Use `/coach` when you want to learn, not just ship.
|
|
357
|
-
|
|
358
|
-
**Normal mode:** I implement for you (fast, but you don't learn)
|
|
359
|
-
**Coach mode:** I guide you to implement yourself (slower, but you grow)
|
|
360
|
-
|
|
361
|
-
Examples:
|
|
362
|
-
- `/coach plan auth-refactor` - I'll ask questions to help YOU design it
|
|
363
|
-
- `/coach review my-code.ts` - I'll ask Socratic questions, not give answers
|
|
364
|
-
|
|
365
|
-
Good for: learning new codebases, building skills, understanding deeply.
|
|
366
|
-
```
|
|
367
|
-
|
|
368
|
-
### Code Review
|
|
369
|
-
|
|
370
|
-
**User asks:** "How do I get a code review?", "Can you review my changes?"
|
|
371
|
-
|
|
372
|
-
**Answer:**
|
|
373
|
-
|
|
374
|
-
```
|
|
375
|
-
[● ●] Use `/code-review` to review code with specialized agents.
|
|
74
|
+
When answering "how do I..." questions:
|
|
376
75
|
|
|
377
|
-
|
|
378
|
-
-
|
|
379
|
-
|
|
380
|
-
|
|
76
|
+
1. **Be concise** - Give the command first, explain second
|
|
77
|
+
2. **Include droid eyes** - `[● ●]` for branded responses
|
|
78
|
+
3. **Suggest workflow** - Often multiple tools work together
|
|
79
|
+
4. **Pro tips welcome** - Share efficiency tricks
|
|
381
80
|
|
|
382
|
-
**
|
|
383
|
-
-
|
|
384
|
-
-
|
|
385
|
-
-
|
|
386
|
-
- EDI/partnership patterns (if applicable)
|
|
81
|
+
**Tool comparisons:**
|
|
82
|
+
- **brain vs project** - Brain for ephemeral thinking (plans, research), project for persistent context (goals, decisions)
|
|
83
|
+
- **codex vs project** - Codex is shared org knowledge, project is personal working memory
|
|
84
|
+
- **coach vs normal** - Coach asks questions to help you learn, normal implements for you
|
|
387
85
|
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
| Question | Answer |
|
|
394
|
-
|----------|--------|
|
|
395
|
-
| "Add context to my thread" | `/project {name}` or `/codex search {topic}` |
|
|
396
|
-
| "Find something in the codex" | `/codex search {keywords}` |
|
|
397
|
-
| "Start planning" | `/brain plan {topic}` or `/tech-design {feature}` |
|
|
398
|
-
| "Leave a note for AI" | Add `> @droid {question}` then `/comments check` |
|
|
399
|
-
| "Learn instead of copy-paste" | `/coach {command}` |
|
|
400
|
-
| "Review my code" | `/code-review` |
|
|
401
|
-
| "Capture a decision" | `/codex decision {summary}` |
|
|
402
|
-
| "Update project context" | `/project update` |
|
|
403
|
-
|
|
404
|
-
### Example Dialogue
|
|
405
|
-
|
|
406
|
-
**User:** "Hey droid, remind me the tools you have"
|
|
407
|
-
|
|
408
|
-
```
|
|
409
|
-
[● ●] Here's what you have installed:
|
|
410
|
-
|
|
411
|
-
**Context loading:**
|
|
412
|
-
- `/project {name}` - Load your project's working context
|
|
413
|
-
- `/codex search {topic}` - Find shared knowledge (PRDs, tech designs, patterns)
|
|
414
|
-
|
|
415
|
-
**Planning & thinking:**
|
|
416
|
-
- `/brain plan {topic}` - Create a planning scratchpad
|
|
417
|
-
- `/tech-design {feature}` - Design larger features
|
|
418
|
-
|
|
419
|
-
**Collaboration:**
|
|
420
|
-
- `/comments check` - Respond to @droid mentions
|
|
421
|
-
- `/code-review` - Get AI code review with specialized agents
|
|
422
|
-
|
|
423
|
-
**Learning:**
|
|
424
|
-
- `/coach` - AI as guide, not implementer
|
|
425
|
-
|
|
426
|
-
**Pro tip:** Start threads with `/project` or `/codex search` for best results.
|
|
427
|
-
```
|
|
428
|
-
|
|
429
|
-
**User:** "How should I approach this new feature?"
|
|
430
|
-
|
|
431
|
-
```
|
|
432
|
-
[● ●] Here's my suggested workflow:
|
|
433
|
-
|
|
434
|
-
1. **Load context first**
|
|
435
|
-
`/project {your-project}` - So I know the codebase
|
|
436
|
-
`/codex search {related-topic}` - For any relevant patterns
|
|
437
|
-
|
|
438
|
-
2. **Plan before coding**
|
|
439
|
-
`/brain plan {feature}` - Sketch out the approach
|
|
440
|
-
Iterate with @droid/@{you} comments until it feels right
|
|
441
|
-
|
|
442
|
-
3. **Implement with context**
|
|
443
|
-
Now I have full context - ask me to implement
|
|
444
|
-
|
|
445
|
-
4. **Review before shipping**
|
|
446
|
-
`/code-review` - Catch issues before PR
|
|
447
|
-
|
|
448
|
-
5. **Capture learnings**
|
|
449
|
-
`/project update` - Save decisions for next session
|
|
450
|
-
```
|
|
86
|
+
**Recommended session start:**
|
|
87
|
+
1. `/project search {name}` - Load working context
|
|
88
|
+
2. `/codex search {topic}` - Find relevant org knowledge (if needed)
|
|
89
|
+
3. Then start working with full context
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "droid-project",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"description": "Manage project context files for persistent AI memory across sessions. Load, update, or create project context before working on multi-session features.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Orderful",
|