Skip to content

Commit 409410d

Browse files
kschraderclaude
andauthored
fix(skill): Update field names to match current CLI (#86)
The skill documentation was using old field names that don't match the actual CLI, causing agents to execute invalid commands. Changes: - `description` → `name` (one-line summary, positional or -n flag) - `context` → `description` (full details, -d flag) - Update all command examples to use correct syntax - Fix task file format example in cli-reference.md Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent f49da18 commit 409410d

File tree

5 files changed

+59
-53
lines changed

5 files changed

+59
-53
lines changed

plugins/dex/skills/dex/SKILL.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ command -v dex &>/dev/null && echo "use: dex" || echo "use: npx @zeeg/dex"
1717

1818
Dex tasks are **tickets** - structured artifacts with comprehensive context:
1919

20-
- **Description**: One-line summary (issue title)
21-
- **Context**: Full background, requirements, approach (issue body)
20+
- **Name**: One-line summary (issue title)
21+
- **Description**: Full background, requirements, approach (issue body)
2222
- **Result**: Implementation details, decisions, outcomes (PR description)
2323

2424
Think: "Would someone understand the what, why, and how from this task alone?"
@@ -59,10 +59,10 @@ Use **dex** for persistent work. Use built-in task tools for ephemeral in-sessio
5959
### Create a Task
6060

6161
```bash
62-
dex create -d "Short description" --context "Full implementation context"
62+
dex create "Short name" --description "Full implementation context"
6363
```
6464

65-
Context should include: what needs to be done, why, implementation approach, and acceptance criteria. See [examples.md](examples.md) for good/bad examples.
65+
Description should include: what needs to be done, why, implementation approach, and acceptance criteria. See [examples.md](examples.md) for good/bad examples.
6666

6767
### List and View Tasks
6868

@@ -83,20 +83,20 @@ dex complete <id> --result "What was accomplished" --commit <sha>
8383
### Edit and Delete
8484

8585
```bash
86-
dex edit <id> --context "Updated context"
86+
dex edit <id> --description "Updated description"
8787
dex delete <id>
8888
```
8989

9090
For full CLI reference including blockers, see [cli-reference.md](cli-reference.md).
9191

92-
## Understanding Task Context
92+
## Understanding Task Fields
9393

9494
Tasks have two text fields:
9595

96-
- **Description**: Brief one-line summary (shown in `dex list`)
97-
- **Context**: Full details - requirements, approach, acceptance criteria (shown with `--full`)
96+
- **Name**: Brief one-line summary (shown in `dex list`)
97+
- **Description**: Full details - requirements, approach, acceptance criteria (shown with `--full`)
9898

99-
When you run `dex show <id>`, the context may be truncated. The CLI will hint at `--full` if there's more content.
99+
When you run `dex show <id>`, the description may be truncated. The CLI will hint at `--full` if there's more content.
100100

101101
### Gathering Context
102102

@@ -138,7 +138,7 @@ Three levels: **Epic** (large initiative) → **Task** (significant work) → **
138138

139139
```bash
140140
# Create subtask under parent
141-
dex create --parent <id> -d "Description" --context "..."
141+
dex create --parent <id> "Subtask name" --description "..."
142142
```
143143

144144
For detailed hierarchy guidance, see [hierarchies.md](hierarchies.md).
@@ -168,7 +168,7 @@ Check `dex show <id>` for GitHub issue info before committing. The "(via parent)
168168
## Best Practices
169169

170170
1. **Right-size tasks**: Completable in one focused session
171-
2. **Clear completion criteria**: Context should define "done"
171+
2. **Clear completion criteria**: Description should define "done"
172172
3. **Don't over-decompose**: 3-7 children per parent
173173
4. **Action-oriented descriptions**: Start with verbs ("Add", "Fix", "Update")
174174
5. **Verify before completing**: Tests passing, manual testing done

plugins/dex/skills/dex/cli-reference.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Full command reference for dex. For basic usage, see SKILL.md.
55
## Create a Task
66

77
```bash
8-
dex create -d "Short description" --context "Full implementation context"
8+
dex create "Task name" --description "Full implementation details"
99
```
1010

1111
Options:
1212

13-
- `-d, --description` (required): One-line summary
14-
- `--context` (required): Full implementation details
13+
- `<name>` or `-n, --name`: One-line summary (required)
14+
- `-d, --description`: Full implementation details (optional but recommended)
1515
- `-p, --priority <n>`: Lower = higher priority (default: 1)
1616
- `-b, --blocked-by <ids>`: Comma-separated task IDs that must complete first
1717
- `--parent <id>`: Parent task ID (creates subtask)
@@ -24,7 +24,7 @@ dex list --all # Include completed
2424
dex list --completed # Only completed
2525
dex list --ready # Only tasks ready to work on (no blockers)
2626
dex list --blocked # Only blocked tasks
27-
dex list --query "login" # Search in description/context
27+
dex list --query "login" # Search in name/description
2828
```
2929

3030
Blocked tasks show an indicator: `[B: xyz123]` (blocked by task xyz123) or `[B: 2]` (blocked by 2 tasks).
@@ -56,7 +56,7 @@ This captures commit SHA, message, and branch automatically.
5656
## Edit a Task
5757

5858
```bash
59-
dex edit <id> -d "Updated description" --context "Updated context"
59+
dex edit <id> -n "Updated name" --description "Updated description"
6060
dex edit <id> --add-blocker xyz123 # Add blocking dependency
6161
dex edit <id> --remove-blocker xyz123 # Remove blocking dependency
6262
```
@@ -75,7 +75,7 @@ Use blocking dependencies to enforce task ordering:
7575

7676
```bash
7777
# Create a task that depends on another
78-
dex create -d "Deploy to production" --context "..." --blocked-by abc123
78+
dex create "Deploy to production" --description "..." --blocked-by abc123
7979

8080
# Add a blocker to an existing task
8181
dex edit xyz789 --add-blocker abc123
@@ -121,14 +121,12 @@ Override with `--storage-path` or `DEX_STORAGE_PATH` env var.
121121
{
122122
"id": "abc123",
123123
"parent_id": null,
124-
"description": "One-line summary",
125-
"context": "Full implementation details...",
124+
"name": "One-line summary",
125+
"description": "Full implementation details...",
126126
"priority": 1,
127127
"completed": false,
128128
"result": null,
129-
"blockedBy": ["xyz789"],
130-
"blocks": ["def456"],
131-
"children": [],
129+
"blocked_by": ["xyz789"],
132130
"created_at": "2026-01-01T00:00:00.000Z",
133131
"updated_at": "2026-01-01T00:00:00.000Z",
134132
"completed_at": null

plugins/dex/skills/dex/examples.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
# Examples
22

3-
Good and bad examples for writing task context and results.
3+
Good and bad examples for writing task descriptions and results.
44

5-
## Writing Context
5+
## Writing Descriptions
6+
7+
Descriptions should include everything needed to do the work without asking questions:
68

7-
Context should include everything needed to do the work without asking questions:
89
- **What** needs to be done and why
910
- **Implementation approach** (steps, files to modify, technical choices)
1011
- **Done when** (acceptance criteria)
1112

12-
### Good Context Example
13+
### Good Description Example
1314

1415
```bash
15-
dex create -d "Migrate storage to one file per task" \
16-
--context "Change storage format for git-friendliness:
16+
dex create "Migrate storage to one file per task" \
17+
--description "Change storage format for git-friendliness:
1718
1819
Structure:
1920
.dex/
@@ -46,17 +47,18 @@ Benefits:
4647

4748
Notice: States the goal, shows the structure, lists specific implementation steps, and explains benefits. Someone could pick this up without asking questions.
4849

49-
### Bad Context Example
50+
### Bad Description Example
5051

5152
```bash
52-
dex create -d "Add auth" --context "Need to add authentication"
53+
dex create "Add auth" --description "Need to add authentication"
5354
```
5455

5556
❌ Missing: How to implement it, what files, what's done when, technical approach
5657

5758
## Writing Results
5859

5960
Results should capture what was actually done:
61+
6062
- **What changed** (implementation summary)
6163
- **Key decisions** (and why)
6264
- **Verification** (tests passing, manual testing done)
@@ -95,7 +97,7 @@ dex complete abc123 --result "Fixed the storage issue"
9597

9698
❌ Missing: What was actually implemented, how, what decisions were made
9799

98-
## Subtask Context Example
100+
## Subtask Description Example
99101

100102
Link subtasks to their parent and explain what this piece does specifically:
101103

plugins/dex/skills/dex/hierarchies.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,29 @@ Guidance for organizing work into epics, tasks, and subtasks.
44

55
## Three Levels
66

7-
| Level | Name | Purpose | Example |
8-
|-------|------|---------|---------|
9-
| L0 | **Epic** | Large initiative (5+ tasks) | "Add user authentication system" |
10-
| L1 | **Task** | Significant work item | "Implement JWT middleware" |
11-
| L2 | **Subtask** | Atomic implementation step | "Add token verification function" |
7+
| Level | Name | Purpose | Example |
8+
| ----- | ----------- | --------------------------- | --------------------------------- |
9+
| L0 | **Epic** | Large initiative (5+ tasks) | "Add user authentication system" |
10+
| L1 | **Task** | Significant work item | "Implement JWT middleware" |
11+
| L2 | **Subtask** | Atomic implementation step | "Add token verification function" |
1212

1313
**Maximum depth is 3 levels.** Attempting to create a child of a subtask will fail.
1414

1515
## When to Use Each Level
1616

1717
### Single Task (No Hierarchy)
18+
1819
- Small feature (1-2 files, ~1 session)
1920
- Work is atomic, no natural breakdown
2021

2122
### Task with Subtasks
23+
2224
- Medium feature (3-5 files, 3-7 steps)
2325
- Work naturally decomposes into discrete steps
2426
- Subtasks could be worked on independently
2527

2628
### Epic with Tasks
29+
2730
- Large initiative (multiple areas, many sessions)
2831
- Work spans 5+ distinct tasks
2932
- You want high-level progress tracking
@@ -32,24 +35,25 @@ Guidance for organizing work into epics, tasks, and subtasks.
3235

3336
```bash
3437
# Create the epic
35-
dex create -d "Add user authentication system" \
36-
--context "Full auth system with JWT tokens, password reset..."
38+
dex create "Add user authentication system" \
39+
--description "Full auth system with JWT tokens, password reset..."
3740

3841
# Create tasks under it (note the epic ID, e.g., abc123)
39-
dex create --parent abc123 -d "Implement JWT token generation" \
40-
--context "Create token service with signing and verification..."
42+
dex create --parent abc123 "Implement JWT token generation" \
43+
--description "Create token service with signing and verification..."
4144

42-
dex create --parent abc123 -d "Add password reset flow" \
43-
--context "Email-based password reset with secure tokens..."
45+
dex create --parent abc123 "Add password reset flow" \
46+
--description "Email-based password reset with secure tokens..."
4447

4548
# For complex tasks, add subtasks
46-
dex create --parent def456 -d "Add token verification function" \
47-
--context "Verify JWT signature and expiration..."
49+
dex create --parent def456 "Add token verification function" \
50+
--description "Verify JWT signature and expiration..."
4851
```
4952

5053
## Subtask Best Practices
5154

5255
Each subtask should be:
56+
5357
- **Independently understandable**: Clear on its own
5458
- **Linked to parent**: Reference parent, explain how this piece fits
5559
- **Specific scope**: What this subtask does vs what parent/siblings do

plugins/dex/skills/dex/verification.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Before marking any task complete, you MUST verify your work. Verification separa
44

55
## The Verification Process
66

7-
1. **Re-read the task context**: What did you originally commit to do?
7+
1. **Re-read the task description**: What did you originally commit to do?
88
2. **Check acceptance criteria**: Does your implementation satisfy the "Done when" conditions?
99
3. **Run relevant tests**: Execute the test suite and document results
1010
4. **Test manually**: Actually try the feature/change yourself
@@ -13,32 +13,34 @@ Before marking any task complete, you MUST verify your work. Verification separa
1313
## Strong vs Weak Verification
1414

1515
### Strong Verification Examples
16+
1617
- ✅ "All 60 tests passing, build successful"
1718
- ✅ "All 69 tests passing (4 new tests for middleware edge cases)"
1819
- ✅ "Manually tested with valid/invalid/expired tokens - all cases work"
1920

2021
### Weak Verification (Avoid)
22+
2123
- ❌ "Should work now" — "should" means not verified
2224
- ❌ "Made the changes" — no evidence it works
2325
- ❌ "Added tests" — did the tests pass? What's the count?
2426
- ❌ "Fixed the bug" — what bug? Did you verify the fix?
2527

2628
## Verification by Task Type
2729

28-
| Task Type | How to Verify |
29-
|-----------|---------------|
30-
| Code changes | Run full test suite, document passing count |
31-
| New features | Run tests + manual testing of functionality |
32-
| Configuration | Test the config works (run commands, check workflows) |
30+
| Task Type | How to Verify |
31+
| ------------- | ------------------------------------------------------- |
32+
| Code changes | Run full test suite, document passing count |
33+
| New features | Run tests + manual testing of functionality |
34+
| Configuration | Test the config works (run commands, check workflows) |
3335
| Documentation | Verify examples work, links resolve, formatting renders |
34-
| Refactoring | Confirm tests still pass, no behavior changes |
36+
| Refactoring | Confirm tests still pass, no behavior changes |
3537

3638
## Cross-Reference Checklist
3739

3840
Before marking complete, verify all applicable items:
3941

40-
- [ ] Task description requirements met
41-
- [ ] Context "Done when" criteria satisfied
42+
- [ ] Task name requirements met
43+
- [ ] Description "Done when" criteria satisfied
4244
- [ ] Tests passing (document count: "All X tests passing")
4345
- [ ] Build succeeds (if applicable)
4446
- [ ] Manual testing done (describe what you tested)

0 commit comments

Comments
 (0)