sqlew 4.0.4 → 4.1.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/CHANGELOG.md +1805 -1762
- package/LICENSE +177 -39
- package/NOTICE +24 -0
- package/README.md +409 -390
- package/assets/claude-md-snippets/plan-mode-integration.md +17 -6
- package/assets/config.example.toml +282 -284
- package/assets/sample-agents/README.md +36 -40
- package/assets/sample-agents/sqlew-architect.md +321 -322
- package/assets/sample-agents/sqlew-researcher.md +292 -293
- package/assets/sample-agents/sqlew-scrum-master.md +286 -287
- package/assets/sample-commands/README.md +56 -57
- package/assets/sample-skills/sqlew-plan-guidance/SKILL.md +33 -26
- package/dist/cli/hooks/check-completion.d.ts +19 -0
- package/dist/cli/hooks/check-completion.d.ts.map +1 -0
- package/dist/cli/hooks/check-completion.js +104 -0
- package/dist/cli/hooks/check-completion.js.map +1 -0
- package/dist/cli/hooks/init-hooks.d.ts +35 -0
- package/dist/cli/hooks/init-hooks.d.ts.map +1 -0
- package/dist/cli/hooks/init-hooks.js +425 -0
- package/dist/cli/hooks/init-hooks.js.map +1 -0
- package/dist/cli/hooks/mark-done.d.ts +25 -0
- package/dist/cli/hooks/mark-done.d.ts.map +1 -0
- package/dist/cli/hooks/mark-done.js +128 -0
- package/dist/cli/hooks/mark-done.js.map +1 -0
- package/dist/cli/hooks/plan-id-utils.d.ts +83 -0
- package/dist/cli/hooks/plan-id-utils.d.ts.map +1 -0
- package/dist/cli/hooks/plan-id-utils.js +183 -0
- package/dist/cli/hooks/plan-id-utils.js.map +1 -0
- package/dist/cli/hooks/save.d.ts +23 -0
- package/dist/cli/hooks/save.d.ts.map +1 -0
- package/dist/cli/hooks/save.js +90 -0
- package/dist/cli/hooks/save.js.map +1 -0
- package/dist/cli/hooks/stdin-parser.d.ts +139 -0
- package/dist/cli/hooks/stdin-parser.d.ts.map +1 -0
- package/dist/cli/hooks/stdin-parser.js +127 -0
- package/dist/cli/hooks/stdin-parser.js.map +1 -0
- package/dist/cli/hooks/suggest.d.ts +19 -0
- package/dist/cli/hooks/suggest.d.ts.map +1 -0
- package/dist/cli/hooks/suggest.js +157 -0
- package/dist/cli/hooks/suggest.js.map +1 -0
- package/dist/cli/hooks/track-plan.d.ts +36 -0
- package/dist/cli/hooks/track-plan.d.ts.map +1 -0
- package/dist/cli/hooks/track-plan.js +152 -0
- package/dist/cli/hooks/track-plan.js.map +1 -0
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +56 -16
- package/dist/cli.js.map +1 -1
- package/dist/config/global-config.d.ts +187 -0
- package/dist/config/global-config.d.ts.map +1 -0
- package/dist/config/global-config.js +206 -0
- package/dist/config/global-config.js.map +1 -0
- package/dist/config/loader.d.ts +42 -0
- package/dist/config/loader.d.ts.map +1 -1
- package/dist/config/loader.js +96 -0
- package/dist/config/loader.js.map +1 -1
- package/dist/constants.d.ts +4 -0
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +10 -0
- package/dist/constants.js.map +1 -1
- package/dist/database/operations/queries.d.ts.map +1 -1
- package/dist/database/operations/queries.js +11 -2
- package/dist/database/operations/queries.js.map +1 -1
- package/dist/index.js +5 -2
- package/dist/index.js.map +1 -1
- package/dist/init-agents.js +0 -1
- package/dist/init-agents.js.map +1 -1
- package/dist/init-skills.d.ts +4 -3
- package/dist/init-skills.d.ts.map +1 -1
- package/dist/init-skills.js +10 -3
- package/dist/init-skills.js.map +1 -1
- package/dist/server/setup.d.ts +8 -0
- package/dist/server/setup.d.ts.map +1 -1
- package/dist/server/setup.js +141 -21
- package/dist/server/setup.js.map +1 -1
- package/dist/sync-agents.d.ts.map +1 -1
- package/dist/sync-agents.js +48 -3
- package/dist/sync-agents.js.map +1 -1
- package/dist/sync-commands.d.ts.map +1 -1
- package/dist/sync-commands.js +43 -3
- package/dist/sync-commands.js.map +1 -1
- package/dist/tools/constraints/actions/get.d.ts.map +1 -1
- package/dist/tools/constraints/actions/get.js +5 -8
- package/dist/tools/constraints/actions/get.js.map +1 -1
- package/dist/tools/constraints/help/help.d.ts.map +1 -1
- package/dist/tools/constraints/help/help.js +1 -6
- package/dist/tools/constraints/help/help.js.map +1 -1
- package/dist/tools/context/actions/get.d.ts.map +1 -1
- package/dist/tools/context/actions/get.js.map +1 -1
- package/dist/tools/context/actions/search-layer.d.ts.map +1 -1
- package/dist/tools/context/actions/search-layer.js +5 -3
- package/dist/tools/context/actions/search-layer.js.map +1 -1
- package/dist/tools/context/actions/set-from-policy.d.ts +2 -1
- package/dist/tools/context/actions/set-from-policy.d.ts.map +1 -1
- package/dist/tools/context/actions/set-from-policy.js.map +1 -1
- package/dist/tools/context/help/help.d.ts.map +1 -1
- package/dist/tools/context/help/help.js +1 -7
- package/dist/tools/context/help/help.js.map +1 -1
- package/dist/tools/context/internal/queries.d.ts.map +1 -1
- package/dist/tools/context/internal/queries.js +5 -2
- package/dist/tools/context/internal/queries.js.map +1 -1
- package/dist/tools/context/types.d.ts +1 -1
- package/dist/tools/context/types.d.ts.map +1 -1
- package/dist/tools/files/actions/get.d.ts.map +1 -1
- package/dist/tools/files/actions/get.js +4 -6
- package/dist/tools/files/actions/get.js.map +1 -1
- package/dist/tools/files/help/help.d.ts.map +1 -1
- package/dist/tools/files/help/help.js +1 -6
- package/dist/tools/files/help/help.js.map +1 -1
- package/dist/tools/suggest/help/constraint-help.d.ts.map +1 -1
- package/dist/tools/suggest/help/constraint-help.js +0 -2
- package/dist/tools/suggest/help/constraint-help.js.map +1 -1
- package/dist/tools/suggest/internal/constraint-queries.d.ts.map +1 -1
- package/dist/tools/suggest/internal/constraint-queries.js +12 -5
- package/dist/tools/suggest/internal/constraint-queries.js.map +1 -1
- package/dist/tools/suggest/internal/queries.js +2 -2
- package/dist/tools/suggest/internal/queries.js.map +1 -1
- package/dist/tools/tasks/help/help.d.ts.map +1 -1
- package/dist/tools/tasks/help/help.js +0 -6
- package/dist/tools/tasks/help/help.js.map +1 -1
- package/dist/tools/tasks/help/use-case.d.ts.map +1 -1
- package/dist/tools/tasks/help/use-case.js +0 -1
- package/dist/tools/tasks/help/use-case.js.map +1 -1
- package/dist/tools/tasks/watcher/status.d.ts.map +1 -1
- package/dist/tools/tasks/watcher/status.js +5 -1
- package/dist/tools/tasks/watcher/status.js.map +1 -1
- package/dist/types/decision/params.d.ts +7 -6
- package/dist/types/decision/params.d.ts.map +1 -1
- package/dist/types/decision/templates.d.ts +3 -2
- package/dist/types/decision/templates.d.ts.map +1 -1
- package/dist/types/view-entities.d.ts +2 -1
- package/dist/types/view-entities.d.ts.map +1 -1
- package/dist/types.d.ts +19 -11
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +4 -1
- package/dist/types.js.map +1 -1
- package/dist/utils/enum-converter.d.ts +72 -0
- package/dist/utils/enum-converter.d.ts.map +1 -0
- package/dist/utils/enum-converter.js +76 -0
- package/dist/utils/enum-converter.js.map +1 -0
- package/dist/utils/hook-queue.d.ts +81 -0
- package/dist/utils/hook-queue.d.ts.map +1 -0
- package/dist/utils/hook-queue.js +156 -0
- package/dist/utils/hook-queue.js.map +1 -0
- package/dist/utils/project-root.d.ts +9 -2
- package/dist/utils/project-root.d.ts.map +1 -1
- package/dist/utils/project-root.js +16 -2
- package/dist/utils/project-root.js.map +1 -1
- package/dist/utils/tag-parser.d.ts.map +1 -1
- package/dist/utils/tag-parser.js +6 -0
- package/dist/utils/tag-parser.js.map +1 -1
- package/dist/utils/validators.d.ts +1 -1
- package/dist/utils/validators.d.ts.map +1 -1
- package/dist/utils/validators.js +1 -1
- package/dist/utils/validators.js.map +1 -1
- package/dist/utils/vcs-adapter.d.ts +44 -0
- package/dist/utils/vcs-adapter.d.ts.map +1 -1
- package/dist/utils/vcs-adapter.js +88 -0
- package/dist/utils/vcs-adapter.js.map +1 -1
- package/dist/utils/view-queries.d.ts.map +1 -1
- package/dist/utils/view-queries.js +9 -19
- package/dist/utils/view-queries.js.map +1 -1
- package/dist/watcher/base-watcher.d.ts +69 -0
- package/dist/watcher/base-watcher.d.ts.map +1 -0
- package/dist/watcher/base-watcher.js +130 -0
- package/dist/watcher/base-watcher.js.map +1 -0
- package/dist/watcher/index.d.ts +3 -0
- package/dist/watcher/index.d.ts.map +1 -1
- package/dist/watcher/index.js +2 -0
- package/dist/watcher/index.js.map +1 -1
- package/dist/watcher/queue-watcher.d.ts +64 -0
- package/dist/watcher/queue-watcher.d.ts.map +1 -0
- package/dist/watcher/queue-watcher.js +187 -0
- package/dist/watcher/queue-watcher.js.map +1 -0
- package/docs/ADR_CONCEPTS.md +140 -0
- package/docs/CONFIGURATION.md +922 -925
- package/docs/CROSS_DATABASE.md +153 -0
- package/docs/DATABASE_AUTH.md +70 -356
- package/docs/HOOKS_GUIDE.md +159 -0
- package/docs/SLASH_COMMANDS.md +329 -337
- package/docs/TASK_SYSTEM_DEPRECATED.md +88 -0
- package/docs/changelogs/CHANGELOG_ARCHIVE_v3.4_and_older.md +293 -296
- package/docs/cli/DATA_EXPORT_IMPORT.md +699 -700
- package/docs/cli/README.md +276 -277
- package/package.json +123 -119
- package/docs/ACCEPTANCE_CRITERIA.md +0 -625
- package/docs/AI_AGENT_GUIDE.md +0 -198
- package/docs/ARCHITECTURE.md +0 -167
- package/docs/AUTO_FILE_TRACKING.md +0 -841
- package/docs/BATCH_VALIDATION.md +0 -617
- package/docs/BEST_PRACTICES.md +0 -168
- package/docs/CONSTRAINT_INTELLIGENCE.md +0 -339
- package/docs/DECISION_CONTEXT.md +0 -675
- package/docs/DECISION_INTELLIGENCE.md +0 -605
- package/docs/GIT_AWARE_AUTO_COMPLETE.md +0 -646
- package/docs/MIGRATION_GUIDE_V3.9.0.md +0 -371
- package/docs/SHARED_CONCEPTS.md +0 -225
- package/docs/SPECIALIZED_AGENTS.md +0 -126
- package/docs/TASK_ACTIONS.md +0 -1177
- package/docs/TASK_OVERVIEW.md +0 -452
- package/docs/TASK_PRUNING.md +0 -594
- package/docs/TOOL_REFERENCE.md +0 -1077
- package/docs/TOOL_SELECTION.md +0 -83
- package/docs/WORKFLOWS.md +0 -941
package/docs/SLASH_COMMANDS.md
CHANGED
|
@@ -1,337 +1,329 @@
|
|
|
1
|
-
# Unified /sqlew Command Guide
|
|
2
|
-
|
|
3
|
-
**🎯 Recommended Interface**
|
|
4
|
-
|
|
5
|
-
The `/sqlew` command is the PRIMARY way to interact with sqlew. It provides a natural language interface with automatic intent detection that is easier than raw MCP tool calls.
|
|
6
|
-
|
|
7
|
-
## Why Use /sqlew?
|
|
8
|
-
|
|
9
|
-
✅ **Natural language input** - Describe what you want, it figures out the intent
|
|
10
|
-
✅ **Single command** - `/sqlew` handles all operations (search, record, list, execute, plan)
|
|
11
|
-
✅ **Automatic intent detection** - Recognizes search, record, update, execute, task creation
|
|
12
|
-
✅ **Error handling** - Built-in validation and helpful error messages
|
|
13
|
-
✅ **No MCP knowledge needed** - Just describe what you want in plain English
|
|
14
|
-
|
|
15
|
-
## Quick Start
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
# Show current status and suggested next actions
|
|
19
|
-
/sqlew
|
|
20
|
-
|
|
21
|
-
# Search for decisions
|
|
22
|
-
/sqlew search why we chose Knex for migrations
|
|
23
|
-
|
|
24
|
-
# Record a decision
|
|
25
|
-
/sqlew record we use PostgreSQL 15 for production database
|
|
26
|
-
|
|
27
|
-
# List remaining tasks
|
|
28
|
-
/sqlew show remaining tasks
|
|
29
|
-
|
|
30
|
-
# Create tasks from a plan
|
|
31
|
-
/sqlew plan implementing user authentication
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
## Intent Detection System
|
|
37
|
-
|
|
38
|
-
The `/sqlew` command analyzes your input and executes in this priority order:
|
|
39
|
-
|
|
40
|
-
### 1. List/Status Intent (Highest Priority)
|
|
41
|
-
|
|
42
|
-
**Keywords**: list, show, status, remaining, current, pending, what, overview, existing, left, 確認, 見せて, 表示, 一覧
|
|
43
|
-
|
|
44
|
-
**Use when you want to**:
|
|
45
|
-
- See all decisions
|
|
46
|
-
- Check remaining tasks
|
|
47
|
-
- Get current status
|
|
48
|
-
- View what exists in the database
|
|
49
|
-
|
|
50
|
-
**Examples**:
|
|
51
|
-
```bash
|
|
52
|
-
/sqlew
|
|
53
|
-
/sqlew show remaining tasks
|
|
54
|
-
/sqlew what decisions do we have
|
|
55
|
-
/sqlew list all constraints
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
**Actions executed**:
|
|
59
|
-
- Lists recent decisions
|
|
60
|
-
- Shows task status summary
|
|
61
|
-
- Provides suggestions for next steps
|
|
62
|
-
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
### 2. Search Intent
|
|
66
|
-
|
|
67
|
-
**Keywords**: search, find, look for, about, related, explore, 検索, 探して, 調べて
|
|
68
|
-
|
|
69
|
-
**Use when you want to**:
|
|
70
|
-
- Find related decisions
|
|
71
|
-
- Search for past context
|
|
72
|
-
- Understand why something was decided
|
|
73
|
-
- Explore related patterns
|
|
74
|
-
|
|
75
|
-
**Examples**:
|
|
76
|
-
```bash
|
|
77
|
-
/sqlew search why we chose PostgreSQL
|
|
78
|
-
/sqlew find authentication decisions
|
|
79
|
-
/sqlew look for API design decisions
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
**Actions executed**:
|
|
83
|
-
- Queries decision tags and keys
|
|
84
|
-
- Shows related context
|
|
85
|
-
- Displays decision rationale
|
|
86
|
-
|
|
87
|
-
---
|
|
88
|
-
|
|
89
|
-
### 3. Record Intent
|
|
90
|
-
|
|
91
|
-
**Keywords**: record, add, save, register, decide, decided, decision, 記録, 登録, 保存
|
|
92
|
-
|
|
93
|
-
**Use when you want to**:
|
|
94
|
-
- Capture a new decision
|
|
95
|
-
- Record meeting minutes
|
|
96
|
-
- Document a choice made during development
|
|
97
|
-
- Add a new constraint
|
|
98
|
-
|
|
99
|
-
**Examples**:
|
|
100
|
-
```bash
|
|
101
|
-
/sqlew record we decided to use JWT for authentication
|
|
102
|
-
/sqlew add PostgreSQL 15 as our production database
|
|
103
|
-
/sqlew save that we use async/await pattern
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
**Actions executed**:
|
|
107
|
-
- Checks for duplicates
|
|
108
|
-
- Records decision with context
|
|
109
|
-
- Suggests related decisions
|
|
110
|
-
|
|
111
|
-
---
|
|
112
|
-
|
|
113
|
-
### 4. Update Intent
|
|
114
|
-
|
|
115
|
-
**Keywords**: update, change, modify, revise, 更新, 変更, 修正
|
|
116
|
-
|
|
117
|
-
**Use when you want to**:
|
|
118
|
-
- Modify an existing decision
|
|
119
|
-
- Change a constraint
|
|
120
|
-
- Revise previous context
|
|
121
|
-
|
|
122
|
-
**Examples**:
|
|
123
|
-
```bash
|
|
124
|
-
/sqlew update authentication to use OAuth2 instead
|
|
125
|
-
/sqlew modify database choice to PostgreSQL 14
|
|
126
|
-
/sqlew revise API response format
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
**Actions executed**:
|
|
130
|
-
- Retrieves existing decision
|
|
131
|
-
- Updates with new information
|
|
132
|
-
- Shows before/after changes
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
### 5. Execute Intent
|
|
137
|
-
|
|
138
|
-
**Keywords**: execute, run, do, proceed, continue, finish, 実行, 進めて, 続けて, やって
|
|
139
|
-
|
|
140
|
-
**Use when you want to**:
|
|
141
|
-
- Start implementing pending tasks
|
|
142
|
-
- Continue work from previous session
|
|
143
|
-
- Execute next steps
|
|
144
|
-
|
|
145
|
-
**Examples**:
|
|
146
|
-
```bash
|
|
147
|
-
/sqlew execute
|
|
148
|
-
/sqlew run pending tasks
|
|
149
|
-
/sqlew proceed with implementation
|
|
150
|
-
/sqlew continue from where we left off
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
**Actions executed**:
|
|
154
|
-
- Lists pending tasks
|
|
155
|
-
- Coordinates implementation
|
|
156
|
-
- Updates task status
|
|
157
|
-
|
|
158
|
-
---
|
|
159
|
-
|
|
160
|
-
### 6. Task Creation Intent (Lowest Priority - Explicit Only)
|
|
161
|
-
|
|
162
|
-
**Keywords**: create task, make task, breakdown, plan tasks, generate tasks, タスク作成, タスクを作って, 洗い出し
|
|
163
|
-
|
|
164
|
-
**IMPORTANT**: Only triggers for EXPLICIT creation verbs. Does NOT trigger for:
|
|
165
|
-
- "remaining tasks" → List/Status intent instead
|
|
166
|
-
- "task list" → List/Status intent instead
|
|
167
|
-
- "show tasks" → List/Status intent instead
|
|
168
|
-
|
|
169
|
-
**Use when you want to**:
|
|
170
|
-
- Break down a feature into tasks
|
|
171
|
-
- Create an implementation plan
|
|
172
|
-
- Generate task breakdown
|
|
173
|
-
|
|
174
|
-
**Examples**:
|
|
175
|
-
```bash
|
|
176
|
-
/sqlew create tasks for user authentication feature
|
|
177
|
-
/sqlew breakdown OAuth2 implementation into tasks
|
|
178
|
-
/sqlew plan implementing password reset feature
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
**Actions executed**:
|
|
182
|
-
- Parses input into tasks
|
|
183
|
-
- Creates task records with dependencies
|
|
184
|
-
- Provides task summary
|
|
185
|
-
|
|
186
|
-
---
|
|
187
|
-
|
|
188
|
-
## Common Use Cases
|
|
189
|
-
|
|
190
|
-
### Planning a Feature
|
|
191
|
-
|
|
192
|
-
```bash
|
|
193
|
-
# Step 1: Get current status
|
|
194
|
-
/sqlew
|
|
195
|
-
|
|
196
|
-
# Step 2: Record architectural decision
|
|
197
|
-
/sqlew record we will use JWT for authentication with 24h expiry
|
|
198
|
-
|
|
199
|
-
# Step 3: Create implementation tasks
|
|
200
|
-
/sqlew plan implementing JWT authentication
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
### Onboarding to a Project
|
|
204
|
-
|
|
205
|
-
```bash
|
|
206
|
-
# Get overview
|
|
207
|
-
/sqlew
|
|
208
|
-
|
|
209
|
-
# Explore decisions
|
|
210
|
-
/sqlew search authentication decisions
|
|
211
|
-
/sqlew search database architecture
|
|
212
|
-
|
|
213
|
-
# Check current work
|
|
214
|
-
/sqlew show remaining tasks
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
### During Implementation
|
|
218
|
-
|
|
219
|
-
```bash
|
|
220
|
-
# Record decisions made
|
|
221
|
-
/sqlew record we added Redis cache for performance
|
|
222
|
-
|
|
223
|
-
# Check related past decisions
|
|
224
|
-
/sqlew search caching decisions
|
|
225
|
-
|
|
226
|
-
# Update status
|
|
227
|
-
/sqlew continue with next task
|
|
228
|
-
```
|
|
229
|
-
|
|
230
|
-
---
|
|
231
|
-
|
|
232
|
-
## Advanced: Direct MCP Tool Access
|
|
233
|
-
|
|
234
|
-
**Note**: For most use cases, the `/sqlew` command is sufficient and preferred.
|
|
235
|
-
|
|
236
|
-
Power users can still call MCP tools directly via the tool interface:
|
|
237
|
-
|
|
238
|
-
```
|
|
239
|
-
mcp__sqlew__decision action="list"
|
|
240
|
-
mcp__sqlew__task action="list"
|
|
241
|
-
mcp__sqlew__decision action="search_tags" tags=["authentication"]
|
|
242
|
-
```
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
- **
|
|
294
|
-
- **
|
|
295
|
-
- **
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
-
|
|
317
|
-
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
---
|
|
325
|
-
|
|
326
|
-
##
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
- [BEST_PRACTICES.md](BEST_PRACTICES.md) - General usage patterns
|
|
331
|
-
|
|
332
|
-
---
|
|
333
|
-
|
|
334
|
-
## Contributing
|
|
335
|
-
|
|
336
|
-
Found a bug or have a suggestion? Please report at:
|
|
337
|
-
https://github.com/sin5ddd/mcp-sqlew/issues
|
|
1
|
+
# Unified /sqlew Command Guide
|
|
2
|
+
|
|
3
|
+
**🎯 Recommended Interface**
|
|
4
|
+
|
|
5
|
+
The `/sqlew` command is the PRIMARY way to interact with sqlew. It provides a natural language interface with automatic intent detection that is easier than raw MCP tool calls.
|
|
6
|
+
|
|
7
|
+
## Why Use /sqlew?
|
|
8
|
+
|
|
9
|
+
✅ **Natural language input** - Describe what you want, it figures out the intent
|
|
10
|
+
✅ **Single command** - `/sqlew` handles all operations (search, record, list, execute, plan)
|
|
11
|
+
✅ **Automatic intent detection** - Recognizes search, record, update, execute, task creation
|
|
12
|
+
✅ **Error handling** - Built-in validation and helpful error messages
|
|
13
|
+
✅ **No MCP knowledge needed** - Just describe what you want in plain English
|
|
14
|
+
|
|
15
|
+
## Quick Start
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Show current status and suggested next actions
|
|
19
|
+
/sqlew
|
|
20
|
+
|
|
21
|
+
# Search for decisions
|
|
22
|
+
/sqlew search why we chose Knex for migrations
|
|
23
|
+
|
|
24
|
+
# Record a decision
|
|
25
|
+
/sqlew record we use PostgreSQL 15 for production database
|
|
26
|
+
|
|
27
|
+
# List remaining tasks
|
|
28
|
+
/sqlew show remaining tasks
|
|
29
|
+
|
|
30
|
+
# Create tasks from a plan
|
|
31
|
+
/sqlew plan implementing user authentication
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Intent Detection System
|
|
37
|
+
|
|
38
|
+
The `/sqlew` command analyzes your input and executes in this priority order:
|
|
39
|
+
|
|
40
|
+
### 1. List/Status Intent (Highest Priority)
|
|
41
|
+
|
|
42
|
+
**Keywords**: list, show, status, remaining, current, pending, what, overview, existing, left, 確認, 見せて, 表示, 一覧
|
|
43
|
+
|
|
44
|
+
**Use when you want to**:
|
|
45
|
+
- See all decisions
|
|
46
|
+
- Check remaining tasks
|
|
47
|
+
- Get current status
|
|
48
|
+
- View what exists in the database
|
|
49
|
+
|
|
50
|
+
**Examples**:
|
|
51
|
+
```bash
|
|
52
|
+
/sqlew
|
|
53
|
+
/sqlew show remaining tasks
|
|
54
|
+
/sqlew what decisions do we have
|
|
55
|
+
/sqlew list all constraints
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Actions executed**:
|
|
59
|
+
- Lists recent decisions
|
|
60
|
+
- Shows task status summary
|
|
61
|
+
- Provides suggestions for next steps
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
### 2. Search Intent
|
|
66
|
+
|
|
67
|
+
**Keywords**: search, find, look for, about, related, explore, 検索, 探して, 調べて
|
|
68
|
+
|
|
69
|
+
**Use when you want to**:
|
|
70
|
+
- Find related decisions
|
|
71
|
+
- Search for past context
|
|
72
|
+
- Understand why something was decided
|
|
73
|
+
- Explore related patterns
|
|
74
|
+
|
|
75
|
+
**Examples**:
|
|
76
|
+
```bash
|
|
77
|
+
/sqlew search why we chose PostgreSQL
|
|
78
|
+
/sqlew find authentication decisions
|
|
79
|
+
/sqlew look for API design decisions
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
**Actions executed**:
|
|
83
|
+
- Queries decision tags and keys
|
|
84
|
+
- Shows related context
|
|
85
|
+
- Displays decision rationale
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
### 3. Record Intent
|
|
90
|
+
|
|
91
|
+
**Keywords**: record, add, save, register, decide, decided, decision, 記録, 登録, 保存
|
|
92
|
+
|
|
93
|
+
**Use when you want to**:
|
|
94
|
+
- Capture a new decision
|
|
95
|
+
- Record meeting minutes
|
|
96
|
+
- Document a choice made during development
|
|
97
|
+
- Add a new constraint
|
|
98
|
+
|
|
99
|
+
**Examples**:
|
|
100
|
+
```bash
|
|
101
|
+
/sqlew record we decided to use JWT for authentication
|
|
102
|
+
/sqlew add PostgreSQL 15 as our production database
|
|
103
|
+
/sqlew save that we use async/await pattern
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
**Actions executed**:
|
|
107
|
+
- Checks for duplicates
|
|
108
|
+
- Records decision with context
|
|
109
|
+
- Suggests related decisions
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
### 4. Update Intent
|
|
114
|
+
|
|
115
|
+
**Keywords**: update, change, modify, revise, 更新, 変更, 修正
|
|
116
|
+
|
|
117
|
+
**Use when you want to**:
|
|
118
|
+
- Modify an existing decision
|
|
119
|
+
- Change a constraint
|
|
120
|
+
- Revise previous context
|
|
121
|
+
|
|
122
|
+
**Examples**:
|
|
123
|
+
```bash
|
|
124
|
+
/sqlew update authentication to use OAuth2 instead
|
|
125
|
+
/sqlew modify database choice to PostgreSQL 14
|
|
126
|
+
/sqlew revise API response format
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
**Actions executed**:
|
|
130
|
+
- Retrieves existing decision
|
|
131
|
+
- Updates with new information
|
|
132
|
+
- Shows before/after changes
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
### 5. Execute Intent
|
|
137
|
+
|
|
138
|
+
**Keywords**: execute, run, do, proceed, continue, finish, 実行, 進めて, 続けて, やって
|
|
139
|
+
|
|
140
|
+
**Use when you want to**:
|
|
141
|
+
- Start implementing pending tasks
|
|
142
|
+
- Continue work from previous session
|
|
143
|
+
- Execute next steps
|
|
144
|
+
|
|
145
|
+
**Examples**:
|
|
146
|
+
```bash
|
|
147
|
+
/sqlew execute
|
|
148
|
+
/sqlew run pending tasks
|
|
149
|
+
/sqlew proceed with implementation
|
|
150
|
+
/sqlew continue from where we left off
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
**Actions executed**:
|
|
154
|
+
- Lists pending tasks
|
|
155
|
+
- Coordinates implementation
|
|
156
|
+
- Updates task status
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
### 6. Task Creation Intent (Lowest Priority - Explicit Only)
|
|
161
|
+
|
|
162
|
+
**Keywords**: create task, make task, breakdown, plan tasks, generate tasks, タスク作成, タスクを作って, 洗い出し
|
|
163
|
+
|
|
164
|
+
**IMPORTANT**: Only triggers for EXPLICIT creation verbs. Does NOT trigger for:
|
|
165
|
+
- "remaining tasks" → List/Status intent instead
|
|
166
|
+
- "task list" → List/Status intent instead
|
|
167
|
+
- "show tasks" → List/Status intent instead
|
|
168
|
+
|
|
169
|
+
**Use when you want to**:
|
|
170
|
+
- Break down a feature into tasks
|
|
171
|
+
- Create an implementation plan
|
|
172
|
+
- Generate task breakdown
|
|
173
|
+
|
|
174
|
+
**Examples**:
|
|
175
|
+
```bash
|
|
176
|
+
/sqlew create tasks for user authentication feature
|
|
177
|
+
/sqlew breakdown OAuth2 implementation into tasks
|
|
178
|
+
/sqlew plan implementing password reset feature
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
**Actions executed**:
|
|
182
|
+
- Parses input into tasks
|
|
183
|
+
- Creates task records with dependencies
|
|
184
|
+
- Provides task summary
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
## Common Use Cases
|
|
189
|
+
|
|
190
|
+
### Planning a Feature
|
|
191
|
+
|
|
192
|
+
```bash
|
|
193
|
+
# Step 1: Get current status
|
|
194
|
+
/sqlew
|
|
195
|
+
|
|
196
|
+
# Step 2: Record architectural decision
|
|
197
|
+
/sqlew record we will use JWT for authentication with 24h expiry
|
|
198
|
+
|
|
199
|
+
# Step 3: Create implementation tasks
|
|
200
|
+
/sqlew plan implementing JWT authentication
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Onboarding to a Project
|
|
204
|
+
|
|
205
|
+
```bash
|
|
206
|
+
# Get overview
|
|
207
|
+
/sqlew
|
|
208
|
+
|
|
209
|
+
# Explore decisions
|
|
210
|
+
/sqlew search authentication decisions
|
|
211
|
+
/sqlew search database architecture
|
|
212
|
+
|
|
213
|
+
# Check current work
|
|
214
|
+
/sqlew show remaining tasks
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
### During Implementation
|
|
218
|
+
|
|
219
|
+
```bash
|
|
220
|
+
# Record decisions made
|
|
221
|
+
/sqlew record we added Redis cache for performance
|
|
222
|
+
|
|
223
|
+
# Check related past decisions
|
|
224
|
+
/sqlew search caching decisions
|
|
225
|
+
|
|
226
|
+
# Update status
|
|
227
|
+
/sqlew continue with next task
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
|
|
232
|
+
## Advanced: Direct MCP Tool Access
|
|
233
|
+
|
|
234
|
+
**Note**: For most use cases, the `/sqlew` command is sufficient and preferred.
|
|
235
|
+
|
|
236
|
+
Power users can still call MCP tools directly via the tool interface:
|
|
237
|
+
|
|
238
|
+
```
|
|
239
|
+
mcp__sqlew__decision action="list"
|
|
240
|
+
mcp__sqlew__task action="list"
|
|
241
|
+
mcp__sqlew__decision action="search_tags" tags=["authentication"]
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
---
|
|
246
|
+
|
|
247
|
+
## Configuration
|
|
248
|
+
|
|
249
|
+
The `/sqlew` command is configured in `.sqlew/config.toml`:
|
|
250
|
+
|
|
251
|
+
```toml
|
|
252
|
+
[sqlew]
|
|
253
|
+
# Default enabled - no configuration needed
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
---
|
|
257
|
+
|
|
258
|
+
## Troubleshooting
|
|
259
|
+
|
|
260
|
+
### Command not recognized
|
|
261
|
+
|
|
262
|
+
**Symptom**: `/sqlew` appears as unrecognized command
|
|
263
|
+
|
|
264
|
+
**Solution**:
|
|
265
|
+
1. Restart Claude Code after installation
|
|
266
|
+
2. Verify `.claude/commands/sqlew.md` exists
|
|
267
|
+
3. Check MCP server is running (check console for errors)
|
|
268
|
+
|
|
269
|
+
### Wrong intent detected
|
|
270
|
+
|
|
271
|
+
**Symptom**: Command executes wrong action
|
|
272
|
+
|
|
273
|
+
**Solution**:
|
|
274
|
+
- Use more explicit keywords
|
|
275
|
+
- Example: Instead of `/sqlew tasks`, use `/sqlew show remaining tasks`
|
|
276
|
+
|
|
277
|
+
### Need more details
|
|
278
|
+
|
|
279
|
+
**Symptom**: Result seems incomplete
|
|
280
|
+
|
|
281
|
+
**Solution**:
|
|
282
|
+
- Try searching directly: `/sqlew search <topic>`
|
|
283
|
+
- Or list all: `/sqlew show what we have`
|
|
284
|
+
|
|
285
|
+
---
|
|
286
|
+
|
|
287
|
+
## Performance Considerations
|
|
288
|
+
|
|
289
|
+
### Token Usage
|
|
290
|
+
|
|
291
|
+
The `/sqlew` command is designed for token efficiency:
|
|
292
|
+
- **List/Status**: ~2-5KB (minimal queries)
|
|
293
|
+
- **Search**: ~3-8KB (depending on results)
|
|
294
|
+
- **Record**: ~2-6KB (single write operation)
|
|
295
|
+
- **Execute**: ~5-15KB (task coordination)
|
|
296
|
+
|
|
297
|
+
---
|
|
298
|
+
|
|
299
|
+
## Related Documentation
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
---
|
|
303
|
+
|
|
304
|
+
## Version History
|
|
305
|
+
|
|
306
|
+
### v4.1.0 (Current)
|
|
307
|
+
|
|
308
|
+
- **Major Change**: Unified `/sqlew` command replaces multiple slash commands
|
|
309
|
+
- **New**: Automatic intent detection (6 intent types)
|
|
310
|
+
- **New**: Natural language interface
|
|
311
|
+
- **Removed**: Legacy slash commands (`/sqw-plan`, `/sqw-scrum`, `/sqw-secretary`, etc.)
|
|
312
|
+
- **Removed**: Custom agent definitions (replaced with unified command)
|
|
313
|
+
|
|
314
|
+
### v4.0.0
|
|
315
|
+
|
|
316
|
+
- Slash commands released (`/sqw-plan`, `/sqw-secretary`, `/sqw-scrum`, etc.)
|
|
317
|
+
- Agent system refactored (agents completely removed from database in v4.0)
|
|
318
|
+
|
|
319
|
+
---
|
|
320
|
+
|
|
321
|
+
## See Also
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
---
|
|
325
|
+
|
|
326
|
+
## Contributing
|
|
327
|
+
|
|
328
|
+
Found a bug or have a suggestion? Please report at:
|
|
329
|
+
https://github.com/sin5ddd/mcp-sqlew/issues
|