@orderful/droid 0.35.3 → 0.36.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 (40) hide show
  1. package/.claude-plugin/marketplace.json +3 -3
  2. package/CHANGELOG.md +32 -0
  3. package/README.md +80 -18
  4. package/dist/tools/codex/.claude-plugin/plugin.json +2 -2
  5. package/dist/tools/codex/TOOL.yaml +2 -2
  6. package/dist/tools/codex/commands/codex.md +1 -1
  7. package/dist/tools/codex/skills/codex/SKILL.md +120 -329
  8. package/dist/tools/codex/skills/codex/references/reading-workflows.md +56 -0
  9. package/dist/tools/codex/skills/codex/references/review/prd.md +49 -0
  10. package/dist/tools/codex/skills/codex/references/review/workflow.md +40 -230
  11. package/dist/tools/codex/skills/codex/scripts/git-finish-write.d.ts +1 -0
  12. package/dist/tools/codex/skills/codex/scripts/git-finish-write.d.ts.map +1 -1
  13. package/dist/tools/codex/skills/codex/scripts/git-finish-write.ts +19 -4
  14. package/dist/tools/plan/.claude-plugin/plugin.json +1 -1
  15. package/dist/tools/plan/TOOL.yaml +1 -1
  16. package/dist/tools/plan/skills/plan/SKILL.md +1 -0
  17. package/dist/tools/tech-design/skills/tech-design/SKILL.md +14 -10
  18. package/dist/tools/tech-design/skills/tech-design/references/publish.md +3 -2
  19. package/package.json +1 -1
  20. package/src/tools/codex/.claude-plugin/plugin.json +2 -2
  21. package/src/tools/codex/TOOL.yaml +2 -2
  22. package/src/tools/codex/commands/codex.md +1 -1
  23. package/src/tools/codex/skills/codex/SKILL.md +120 -329
  24. package/src/tools/codex/skills/codex/references/reading-workflows.md +56 -0
  25. package/src/tools/codex/skills/codex/references/review/prd.md +49 -0
  26. package/src/tools/codex/skills/codex/references/review/workflow.md +40 -230
  27. package/src/tools/codex/skills/codex/scripts/git-finish-write.ts +19 -4
  28. package/src/tools/plan/.claude-plugin/plugin.json +1 -1
  29. package/src/tools/plan/TOOL.yaml +1 -1
  30. package/src/tools/plan/skills/plan/SKILL.md +1 -0
  31. package/src/tools/tech-design/skills/tech-design/SKILL.md +14 -10
  32. package/src/tools/tech-design/skills/tech-design/references/publish.md +3 -2
  33. package/dist/tools/codex/skills/codex/references/creating.md +0 -112
  34. package/dist/tools/codex/skills/codex/references/decisions.md +0 -124
  35. package/dist/tools/codex/skills/codex/references/loading.md +0 -292
  36. package/dist/tools/codex/skills/codex/references/topics.md +0 -215
  37. package/src/tools/codex/skills/codex/references/creating.md +0 -112
  38. package/src/tools/codex/skills/codex/references/decisions.md +0 -124
  39. package/src/tools/codex/skills/codex/references/loading.md +0 -292
  40. package/src/tools/codex/skills/codex/references/topics.md +0 -215
@@ -60,8 +60,8 @@
60
60
  },
61
61
  {
62
62
  "name": "droid-codex",
63
- "description": "Shared organizational knowledge - PRDs, tech designs, domains, proposals, patterns, and explored topics. Use when loading project context, searching codex, capturing decisions, or creating new entries.",
64
- "version": "0.2.2",
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
65
  "source": {
66
66
  "source": "github",
67
67
  "repo": "orderful/droid",
@@ -87,7 +87,7 @@
87
87
  {
88
88
  "name": "droid-plan",
89
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.1",
90
+ "version": "0.1.2",
91
91
  "source": {
92
92
  "source": "github",
93
93
  "repo": "orderful/droid",
package/CHANGELOG.md CHANGED
@@ -1,5 +1,37 @@
1
1
  # @orderful/droid
2
2
 
3
+ ## 0.36.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#225](https://github.com/Orderful/droid/pull/225) [`d6e3fea`](https://github.com/Orderful/droid/commit/d6e3fea047a45d66d46301c7fba253aa0ab3680e) Thanks [@frytyler](https://github.com/frytyler)! - **codex tool: self-describing integration**
8
+
9
+ The codex skill now reads structure and workflows from the codex repo's .codex/ folder instead of hardcoded assumptions. This makes the skill stable and rarely needing updates when the codex structure evolves.
10
+
11
+ **Changes:**
12
+ - Skill reads .codex/manifest.yaml for structure definitions
13
+ - Skill reads .codex/workflows/\*.md for operation instructions
14
+ - Removed duplicated workflow content from references/
15
+ - Added references/reading-workflows.md guide
16
+ - Simplified SKILL.md from 421 to 214 lines (49% reduction)
17
+ - Kept references/review/ with type-specific facilitation (tech-design, prd)
18
+ - Added PRD review support
19
+ - Codex structural changes no longer require droid updates
20
+
21
+ **Breaking:** Requires codex repo with .codex/ folder (PR #181)
22
+
23
+ ## 0.35.4
24
+
25
+ ### Patch Changes
26
+
27
+ - [#220](https://github.com/Orderful/droid/pull/220) [`cbe48f7`](https://github.com/Orderful/droid/commit/cbe48f71f177465886f65f27b914edf990612203) Thanks [@frytyler](https://github.com/frytyler)! - Add argument-hint to plan skill for better CLI discoverability
28
+
29
+ - [#218](https://github.com/Orderful/droid/pull/218) [`47ba4ac`](https://github.com/Orderful/droid/commit/47ba4acf690595ed5c0f20645b5b5c20dcc9610a) Thanks [@frytyler](https://github.com/frytyler)! - Improve tech-design skill documentation and add needs-review label support
30
+ - Add comment convention table clarifying @droid/@user mention semantics
31
+ - Add --labels parameter to git-finish-write script for PR label support
32
+ - Configure tech-design publish to add needs-review label (prevents auto-merge)
33
+ - Remove unimplemented v2 commands from main Commands table
34
+
3
35
  ## 0.35.3
4
36
 
5
37
  ### Patch Changes
package/README.md CHANGED
@@ -12,23 +12,60 @@ AI workflow toolkit for sharing tools, commands, and agents across the engineeri
12
12
  - **Share what works** - Power users discover great workflows, everyone benefits
13
13
  - **Consistent experience** - Common patterns like `@droid`/`@user` comments work the same across the team
14
14
 
15
- ## Quick Start
15
+ ## Prerequisites
16
16
 
17
- ### Option A: Claude Code Plugin (Recommended for Claude Code users)
17
+ Before installing droid:
18
18
 
19
- Install individual tools directly through Claude Code's plugin system:
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
+
26
+ ## Setup Gotchas
27
+
28
+ Things that trip people up:
29
+
30
+ ### Claude Code not found after install
31
+
32
+ If `claude` command isn't found in new terminal windows, add to your shell rc file (`.bashrc`, `.zshrc`):
20
33
 
21
34
  ```bash
22
- # Add the Droid marketplace
23
- /plugin marketplace add orderful/droid
35
+ export PATH="$HOME/.local/bin:$PATH"
36
+ ```
24
37
 
25
- # Install the tools you want
26
- /plugin install droid-brain@droid
27
- /plugin install droid-comments@droid
28
- /plugin install droid-code-review@droid
38
+ Then restart your terminal or `source` the file.
39
+
40
+ ### Check your settings before diving in
41
+
42
+ After install, review your configuration before starting a session:
43
+
44
+ ```bash
45
+ droid config # View global settings
46
+ droid # TUI → Settings tab for tool-specific config
29
47
  ```
30
48
 
31
- ### Option B: TUI Dashboard (For OpenCode or if you prefer a visual interface)
49
+ Make sure username, paths, and tool settings match what you want.
50
+
51
+ ### Updates require restart
52
+
53
+ When droid auto-updates (or you run `droid update`), the package updates but you need to:
54
+
55
+ 1. Restart droid to pick up the new version
56
+ 2. Run tool updates separately if needed (`droid update` in TUI)
57
+
58
+ ### Cursor support
59
+
60
+ Cursor integration currently requires the **nightly build** of Cursor.
61
+
62
+ ### nodenv/nvm/asdf users
63
+
64
+ After global npm install, run `nodenv rehash` (or equivalent for your version manager) to update shims.
65
+
66
+ ## Quick Start
67
+
68
+ ### Option A: TUI Dashboard (Recommended)
32
69
 
33
70
  ```bash
34
71
  npm install -g @orderful/droid
@@ -37,7 +74,21 @@ droid
37
74
 
38
75
  The TUI guides you through setup and tool installation. Works with both Claude Code and OpenCode.
39
76
 
40
- > **Note for nodenv/nvm/asdf users:** After global install, run `nodenv rehash` (or equivalent) to update your shims.
77
+ ### Option B: Claude Code Plugin (Alpha)
78
+
79
+ > **Note:** Plugin support is experimental. The TUI is more stable and feature-complete.
80
+
81
+ Install individual tools directly through Claude Code's plugin system:
82
+
83
+ ```bash
84
+ # Add the Droid marketplace
85
+ /plugin marketplace add orderful/droid
86
+
87
+ # Install the tools you want
88
+ /plugin install droid-brain@droid
89
+ /plugin install droid-comments@droid
90
+ /plugin install droid-code-review@droid
91
+ ```
41
92
 
42
93
  ## The TUI
43
94
 
@@ -62,6 +113,7 @@ Browse available tools, see what's installed, and manage everything from one pla
62
113
  | **comments** | Inline `@droid`/`@user` conversations in any file | beta |
63
114
  | **project** | Persistent project context across sessions | beta |
64
115
  | **brain** | Collaborative scratch pad for planning & research | beta |
116
+ | **plan** | Task-scoped planning with portable, structured plans | alpha |
65
117
  | **coach** | Learning-mode AI - scaffolds don't implement, questions don't fix | beta |
66
118
  | **codex** | Shared organizational knowledge - PRDs, tech designs, patterns | beta |
67
119
  | **code-review** | Multi-agent code review with specialized checkers | alpha |
@@ -136,15 +188,25 @@ Config lives in `~/.droid/`:
136
188
 
137
189
  ```
138
190
  ~/.droid/
139
- ├── config.yaml # Global config
140
- └── skills/
141
- └── {skill}/
142
- └── overrides.yaml # Per-skill overrides
191
+ └── config.yaml # Global config (platform, user settings, tool config)
143
192
  ```
144
193
 
145
- Tools install to your AI platform's location:
146
- - **Claude Code**: `~/.claude/skills/`, `~/.claude/commands/`, `~/.claude/agents/`
147
- - **OpenCode**: `~/.config/opencode/skills/`, `~/.config/opencode/commands/`
194
+ Key sections in `config.yaml`:
195
+ - `platform` - Primary platform (claude-code, opencode, cursor)
196
+ - `user_mention` - Your @mention for comments (e.g., `@fry`)
197
+ - `tools` - Per-tool configuration (brain paths, codex repo, etc.)
198
+ - `auto_update` - Auto-update settings for app and tools
199
+ - `repos` - Known repositories for context
200
+
201
+ **Where tools install:**
202
+
203
+ Skills are unified across all platforms to `~/.claude/skills/`. Commands and agents are platform-specific:
204
+
205
+ | Platform | Skills | Commands | Agents |
206
+ |----------|--------|----------|--------|
207
+ | Claude Code | `~/.claude/skills/` | `~/.claude/commands/` | `~/.claude/agents/` |
208
+ | OpenCode | `~/.claude/skills/` | `~/.config/opencode/command/` | `~/.config/opencode/agent/` |
209
+ | Cursor | `~/.claude/skills/` | `~/.cursor/commands/` | `~/.cursor/agents/` |
148
210
 
149
211
  ## CLI Reference
150
212
 
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "droid-codex",
3
- "version": "0.2.2",
4
- "description": "Shared organizational knowledge - PRDs, tech designs, domains, proposals, patterns, and explored topics. Use when loading project context, searching codex, capturing decisions, or creating new entries.",
3
+ "version": "0.3.0",
4
+ "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.",
5
5
  "author": {
6
6
  "name": "Orderful",
7
7
  "url": "https://github.com/orderful"
@@ -1,6 +1,6 @@
1
1
  name: codex
2
- description: "Shared organizational knowledge - PRDs, tech designs, domains, proposals, patterns, and explored topics. Use when loading project context, searching codex, capturing decisions, or creating new entries."
3
- version: 0.2.2
2
+ 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."
3
+ version: 0.3.0
4
4
  status: beta
5
5
 
6
6
  includes:
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: codex
3
- description: "Shared organizational knowledge - PRDs, tech designs, patterns, domains, proposals, and explored topics"
3
+ description: "Shared organizational knowledge - PRDs, tech designs, patterns, domains, proposals, and explored topics. Self-describing: structure and workflows defined in codex repo."
4
4
  argument-hint: "[projects | search {query} | {category} search {query} | new {category} {name} | decision {text}]"
5
5
  ---
6
6