@orderful/droid 0.10.1 → 0.10.3
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/CHANGELOG.md +22 -0
- package/dist/commands/install.d.ts.map +1 -1
- package/dist/commands/install.js +3 -1
- package/dist/commands/install.js.map +1 -1
- package/dist/commands/setup.d.ts.map +1 -1
- package/dist/commands/setup.js +3 -5
- package/dist/commands/setup.js.map +1 -1
- package/dist/commands/skills.d.ts.map +1 -1
- package/dist/commands/skills.js +3 -1
- package/dist/commands/skills.js.map +1 -1
- package/dist/commands/tui.d.ts.map +1 -1
- package/dist/commands/tui.js +38 -41
- package/dist/commands/tui.js.map +1 -1
- package/dist/skills/brain/SKILL.md +41 -17
- package/dist/skills/brain/commands/brain.md +1 -0
- package/dist/skills/brain/commands/scratchpad.md +1 -0
- package/dist/skills/brain/references/metadata.md +14 -13
- package/dist/skills/brain/references/naming.md +12 -10
- package/dist/skills/brain/references/templates.md +5 -5
- package/dist/skills/brain/references/workflows.md +48 -24
- package/dist/skills/comments/SKILL.md +21 -13
- package/dist/skills/comments/SKILL.yaml +1 -1
- package/package.json +1 -1
- package/src/commands/install.ts +5 -1
- package/src/commands/setup.ts +3 -5
- package/src/commands/skills.ts +5 -1
- package/src/commands/tui.tsx +37 -65
- package/src/skills/brain/SKILL.md +41 -17
- package/src/skills/brain/commands/brain.md +1 -0
- package/src/skills/brain/commands/scratchpad.md +1 -0
- package/src/skills/brain/references/metadata.md +14 -13
- package/src/skills/brain/references/naming.md +12 -10
- package/src/skills/brain/references/templates.md +5 -5
- package/src/skills/brain/references/workflows.md +48 -24
- package/src/skills/comments/SKILL.md +21 -13
- package/src/skills/comments/SKILL.yaml +1 -1
|
@@ -10,10 +10,10 @@ Conventions for naming brain docs.
|
|
|
10
10
|
|
|
11
11
|
## Components
|
|
12
12
|
|
|
13
|
-
| Component
|
|
14
|
-
|
|
15
|
-
| `{type}`
|
|
16
|
-
| `{topic-slug}` | Lowercase, hyphen-separated topic
|
|
13
|
+
| Component | Description | Examples |
|
|
14
|
+
| -------------- | ------------------------------------ | ------------------------------------- |
|
|
15
|
+
| `{type}` | Doc type: `plan`, `research`, `note` | `plan`, `research`, `note` |
|
|
16
|
+
| `{topic-slug}` | Lowercase, hyphen-separated topic | `auth-refactor`, `caching-strategies` |
|
|
17
17
|
|
|
18
18
|
## Slug Rules
|
|
19
19
|
|
|
@@ -25,16 +25,17 @@ Conventions for naming brain docs.
|
|
|
25
25
|
|
|
26
26
|
## Examples
|
|
27
27
|
|
|
28
|
-
| Input
|
|
29
|
-
|
|
30
|
-
| `/brain plan Auth Refactor`
|
|
31
|
-
| `/brain research Caching Strategies`
|
|
32
|
-
| `/brain plan Transaction Template Rendering` | `plan-transaction-template-rendering.md`
|
|
33
|
-
| `/brain note Remember to check rate limits`
|
|
28
|
+
| Input | Filename |
|
|
29
|
+
| -------------------------------------------- | ----------------------------------------- |
|
|
30
|
+
| `/brain plan Auth Refactor` | `plan-auth-refactor.md` |
|
|
31
|
+
| `/brain research Caching Strategies` | `research-caching-strategies.md` |
|
|
32
|
+
| `/brain plan Transaction Template Rendering` | `plan-transaction-template-rendering.md` |
|
|
33
|
+
| `/brain note Remember to check rate limits` | `note-20250115-remember-to-check-rate.md` |
|
|
34
34
|
|
|
35
35
|
## Notes
|
|
36
36
|
|
|
37
37
|
For notes, include the date in the filename:
|
|
38
|
+
|
|
38
39
|
```
|
|
39
40
|
note-{YYYYMMDD}-{slug}.md
|
|
40
41
|
```
|
|
@@ -44,5 +45,6 @@ This prevents collisions and allows chronological sorting.
|
|
|
44
45
|
## Uniqueness
|
|
45
46
|
|
|
46
47
|
If a file with the generated name already exists:
|
|
48
|
+
|
|
47
49
|
1. Check if user wants to open existing doc
|
|
48
50
|
2. Or append a numeric suffix: `plan-auth-refactor-2.md`
|
|
@@ -94,9 +94,9 @@ Overall assessment.
|
|
|
94
94
|
|
|
95
95
|
## Template Variables
|
|
96
96
|
|
|
97
|
-
| Variable
|
|
98
|
-
|
|
99
|
-
| `{Topic}`
|
|
100
|
-
| `{date}`
|
|
97
|
+
| Variable | Description | Example |
|
|
98
|
+
| --------------------- | ------------------------- | --------------------------------------- |
|
|
99
|
+
| `{Topic}` | Doc title from user input | "Auth Refactor" |
|
|
100
|
+
| `{date}` | Current date (YYYY-MM-DD) | "2025-01-15" |
|
|
101
101
|
| `{brief description}` | Context from conversation | "refactoring the authentication system" |
|
|
102
|
-
| `{content}`
|
|
102
|
+
| `{content}` | User-provided text | (for notes) |
|
|
@@ -8,14 +8,18 @@ Detailed procedures for each brain operation.
|
|
|
8
8
|
|
|
9
9
|
**Steps:**
|
|
10
10
|
|
|
11
|
-
1. **Read config first**
|
|
12
|
-
- Read `~/.droid/skills/brain/overrides.yaml`
|
|
13
|
-
-
|
|
11
|
+
1. **Read config first (MANDATORY)**
|
|
12
|
+
- Use the Read tool on `~/.droid/skills/brain/overrides.yaml`
|
|
13
|
+
- If file exists and contains `brain_dir:`, use that path
|
|
14
|
+
- Only use defaults if the file doesn't exist or `brain_dir` is not set
|
|
15
|
+
- **Do NOT skip this step or assume defaults**
|
|
14
16
|
|
|
15
17
|
2. **Search for matches**
|
|
18
|
+
|
|
16
19
|
```
|
|
17
20
|
Glob: {brain_dir}/**/*{topic}*.md
|
|
18
21
|
```
|
|
22
|
+
|
|
19
23
|
Fuzzy match the topic against doc filenames
|
|
20
24
|
|
|
21
25
|
3. **Handle results:**
|
|
@@ -37,10 +41,12 @@ Detailed procedures for each brain operation.
|
|
|
37
41
|
|
|
38
42
|
**Steps:**
|
|
39
43
|
|
|
40
|
-
1. **Read config first**
|
|
41
|
-
- Read `~/.droid/skills/brain/overrides.yaml`
|
|
42
|
-
-
|
|
43
|
-
-
|
|
44
|
+
1. **Read config first (MANDATORY)**
|
|
45
|
+
- Use the Read tool on `~/.droid/skills/brain/overrides.yaml`
|
|
46
|
+
- If file exists and contains `brain_dir:`, use that path
|
|
47
|
+
- Only use defaults if the file doesn't exist or `brain_dir` is not set
|
|
48
|
+
- Also check for `inbox_folder` setting
|
|
49
|
+
- **Do NOT skip this step or assume defaults**
|
|
44
50
|
|
|
45
51
|
2. **Generate filename** using naming conventions (see `naming.md`):
|
|
46
52
|
- Format: `{type}-{topic-slug}.md`
|
|
@@ -59,11 +65,16 @@ Detailed procedures for each brain operation.
|
|
|
59
65
|
- Any constraints or requirements mentioned?
|
|
60
66
|
- Related work or prior decisions?
|
|
61
67
|
|
|
62
|
-
7. **
|
|
68
|
+
7. **Add placeholder comments** for sections needing user input:
|
|
69
|
+
- Read user's mention from `~/.droid/config.yaml` → `user_mention`
|
|
70
|
+
- Use `> @{user_mention}` for placeholders (e.g., `> @fry - Please provide requirements`)
|
|
71
|
+
- **CRITICAL:** NEVER use `@droid` - that's for user-to-AI comments, not AI-to-user
|
|
63
72
|
|
|
64
|
-
8. **
|
|
73
|
+
8. **Write the doc** with template structure and initial context
|
|
65
74
|
|
|
66
|
-
9. **
|
|
75
|
+
9. **Set as active doc**
|
|
76
|
+
|
|
77
|
+
10. **Confirm creation** and summarize what was captured
|
|
67
78
|
|
|
68
79
|
## Notes
|
|
69
80
|
|
|
@@ -71,10 +82,12 @@ Detailed procedures for each brain operation.
|
|
|
71
82
|
|
|
72
83
|
**Steps:**
|
|
73
84
|
|
|
74
|
-
1. **Read config first**
|
|
75
|
-
- Read `~/.droid/skills/brain/overrides.yaml`
|
|
76
|
-
-
|
|
77
|
-
-
|
|
85
|
+
1. **Read config first (MANDATORY)**
|
|
86
|
+
- Use the Read tool on `~/.droid/skills/brain/overrides.yaml`
|
|
87
|
+
- If file exists and contains `brain_dir:`, use that path
|
|
88
|
+
- Only use defaults if the file doesn't exist or `brain_dir` is not set
|
|
89
|
+
- Also check for `inbox_folder` setting
|
|
90
|
+
- **Do NOT skip this step or assume defaults**
|
|
78
91
|
|
|
79
92
|
2. **Generate filename:**
|
|
80
93
|
- Format: `note-{date}-{slug}.md` where date is `YYYYMMDD`
|
|
@@ -105,8 +118,8 @@ Detailed procedures for each brain operation.
|
|
|
105
118
|
2. **Read current content** of active doc
|
|
106
119
|
|
|
107
120
|
3. **Append new section:**
|
|
108
|
-
```markdown
|
|
109
121
|
|
|
122
|
+
```markdown
|
|
110
123
|
---
|
|
111
124
|
|
|
112
125
|
## Update ({date})
|
|
@@ -133,18 +146,25 @@ Detailed procedures for each brain operation.
|
|
|
133
146
|
|
|
134
147
|
2. **Read active doc**
|
|
135
148
|
|
|
136
|
-
3. **
|
|
149
|
+
3. **Check preserve_comments setting:**
|
|
150
|
+
- Read `~/.droid/skills/comments/overrides.yaml` if it exists
|
|
151
|
+
- Look for `preserve_comments` (default: `true`)
|
|
152
|
+
|
|
153
|
+
4. **Find all `> @droid` comments**
|
|
137
154
|
- Pattern: Lines starting with `> @droid` (blockquote with mention)
|
|
138
155
|
|
|
139
|
-
|
|
156
|
+
5. **For each comment:**
|
|
140
157
|
- Show the comment and surrounding context
|
|
141
158
|
- Address the question/request
|
|
142
|
-
- Add response as `> @{user_mention}`
|
|
143
|
-
-
|
|
159
|
+
- Add response as blockquote with user's mention: `> @{user_mention} Your response here`
|
|
160
|
+
- Example: `> @fry Yes, the index covers that query pattern.`
|
|
161
|
+
- **CRITICAL:** NEVER use `@droid` in your responses. Use `@{user_mention}` from config (e.g., `@fry`)
|
|
162
|
+
- **CRITICAL:** Always include the `>` prefix to maintain blockquote formatting
|
|
163
|
+
- **CRITICAL:** If `preserve_comments: true`, keep the original `@droid` comment and add your response below it. Do NOT remove the original comment.
|
|
144
164
|
|
|
145
|
-
|
|
165
|
+
6. **Update the doc** with responses
|
|
146
166
|
|
|
147
|
-
|
|
167
|
+
7. **Summarize** what was addressed
|
|
148
168
|
|
|
149
169
|
## Finalizing
|
|
150
170
|
|
|
@@ -177,14 +197,18 @@ Detailed procedures for each brain operation.
|
|
|
177
197
|
|
|
178
198
|
**Steps:**
|
|
179
199
|
|
|
180
|
-
1. **Read config first**
|
|
181
|
-
- Read `~/.droid/skills/brain/overrides.yaml`
|
|
182
|
-
-
|
|
200
|
+
1. **Read config first (MANDATORY)**
|
|
201
|
+
- Use the Read tool on `~/.droid/skills/brain/overrides.yaml`
|
|
202
|
+
- If file exists and contains `brain_dir:`, use that path
|
|
203
|
+
- Only use defaults if the file doesn't exist or `brain_dir` is not set
|
|
204
|
+
- **Do NOT skip this step or assume defaults**
|
|
183
205
|
|
|
184
206
|
2. **Find recent docs:**
|
|
207
|
+
|
|
185
208
|
```
|
|
186
209
|
Glob: {brain_dir}/**/*.md
|
|
187
210
|
```
|
|
211
|
+
|
|
188
212
|
Sort by modification time, limit to 10-15
|
|
189
213
|
|
|
190
214
|
3. **Present list** with:
|
|
@@ -31,21 +31,23 @@ The AI will respond with `> @{user_mention}` (configured in droid setup, e.g., `
|
|
|
31
31
|
**CRITICAL: The `@mention` is who you're talking TO, not who is speaking.**
|
|
32
32
|
|
|
33
33
|
Think of it like addressing someone in conversation:
|
|
34
|
+
|
|
34
35
|
- "Hey @droid, what do you think?" → User talking TO the AI
|
|
35
36
|
- "Good point @fry, here's my take..." → AI talking TO the user
|
|
36
37
|
|
|
37
38
|
| When you see... | Who wrote it | Who it's addressed to |
|
|
38
|
-
|
|
39
|
-
| `> @droid ...` | User | AI (droid)
|
|
40
|
-
| `> @fry ...` | AI | User (fry)
|
|
39
|
+
| --------------- | ------------ | --------------------- |
|
|
40
|
+
| `> @droid ...` | User | AI (droid) |
|
|
41
|
+
| `> @fry ...` | AI | User (fry) |
|
|
41
42
|
|
|
42
43
|
**Examples:**
|
|
44
|
+
|
|
43
45
|
```markdown
|
|
44
|
-
> @droid Can you explain this function?
|
|
46
|
+
> @droid Can you explain this function? ← User asking AI
|
|
45
47
|
> @fry This function calculates the hash... ← AI responding to user
|
|
46
48
|
|
|
47
|
-
> @droid Should we refactor this?
|
|
48
|
-
> @fry Yes, I'd suggest extracting...
|
|
49
|
+
> @droid Should we refactor this? ← User asking AI
|
|
50
|
+
> @fry Yes, I'd suggest extracting... ← AI responding to user
|
|
49
51
|
```
|
|
50
52
|
|
|
51
53
|
**Never flip this.** When responding to a `@droid` comment, always use `@{user}` (e.g., `@fry`) because you're addressing the user, not yourself.
|
|
@@ -76,13 +78,19 @@ When you find a `@droid` marker:
|
|
|
76
78
|
## Behavior
|
|
77
79
|
|
|
78
80
|
### On `/comments check`:
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
81
|
+
|
|
82
|
+
1. **Read config first:** Check `~/.droid/skills/comments/overrides.yaml` for `preserve_comments` setting (default: `true`)
|
|
83
|
+
2. Search for `> @droid` (and any configured `ai_mentions`) in the specified scope
|
|
84
|
+
3. If there's a `git diff`, check those files first for relevant context
|
|
85
|
+
4. For each comment, determine intent:
|
|
86
|
+
- **Action request** ("do X", "add Y", "fix Z") → Execute the action
|
|
87
|
+
- **Question** ("what do you think", "should we") → Respond with `> @{user_mention}`
|
|
88
|
+
5. **Handle original comment based on `preserve_comments`:**
|
|
89
|
+
- If `preserve_comments: true` → Keep the original `@droid` comment (add response below it)
|
|
90
|
+
- If `preserve_comments: false` → Remove the original comment after addressing
|
|
84
91
|
|
|
85
92
|
### On `/comments cleanup`:
|
|
93
|
+
|
|
86
94
|
1. Find AI tag and `> @{user_mention}` pairs where conversation appears resolved
|
|
87
95
|
2. Remove both markers
|
|
88
96
|
3. Output a summary of what was discussed/decided
|
|
@@ -98,8 +106,8 @@ user_mention: "@fry"
|
|
|
98
106
|
# Additional AI mentions to recognize (e.g., if you're used to @claude)
|
|
99
107
|
ai_mentions: "@claude"
|
|
100
108
|
|
|
101
|
-
# Keep comments after addressing them (default:
|
|
102
|
-
preserve_comments:
|
|
109
|
+
# Keep comments after addressing them (default: true)
|
|
110
|
+
preserve_comments: true
|
|
103
111
|
```
|
|
104
112
|
|
|
105
113
|
## File Type Support
|