Skip to content

Commit 484b911

Browse files
Data-Wiseclaude
andcommitted
docs: comprehensive v3.4.0 documentation for AI and dashboard features
- ai.md: Added recipe, chat, usage, model subcommands with examples - dash.md: Added Quick Wins section and Urgency Indicators documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 4539e0d commit 484b911

File tree

2 files changed

+171
-7
lines changed

2 files changed

+171
-7
lines changed

docs/commands/ai.md

Lines changed: 118 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,114 @@
66

77
```bash
88
flow ai [options] <query>
9+
flow ai recipe <name> [input]
10+
flow ai chat [options]
11+
flow ai usage [action]
12+
flow ai model [action]
913
```
1014

1115
## Description
1216

1317
`flow ai` sends queries to Claude with automatic project context. The AI receives information about your current directory, project type, git status, and active flow session.
1418

19+
## Subcommands
20+
21+
### recipe
22+
23+
Run reusable AI prompts with variable substitution.
24+
25+
```bash
26+
flow ai recipe list # List all recipes
27+
flow ai recipe show <name> # View recipe content
28+
flow ai recipe <name> <input> # Run a recipe
29+
flow ai recipe create <name> # Create custom recipe
30+
flow ai recipe edit <name> # Edit user recipe
31+
flow ai recipe delete <name> # Delete user recipe
32+
```
33+
34+
**Built-in Recipes:**
35+
36+
| Recipe | Description |
37+
| -------------- | ------------------------------------ |
38+
| `review` | Code review with actionable feedback |
39+
| `commit` | Generate conventional commit message |
40+
| `explain-code` | Step-by-step code explanation |
41+
| `debug` | Help diagnose issues |
42+
| `refactor` | Suggest code improvements |
43+
| `test` | Generate tests for code |
44+
| `document` | Generate documentation |
45+
| `eli5` | Explain like I'm 5 |
46+
| `shell` | Generate shell commands |
47+
| `fix` | Fix a problem |
48+
49+
**Variables Available:**
50+
51+
- `{{input}}` - User-provided input
52+
- `{{project_type}}` - Detected project type
53+
- `{{pwd}}` - Current directory
54+
- `{{date}}` - Today's date
55+
- `{{branch}}` - Current git branch
56+
- `{{project}}` - Project name
57+
58+
### chat
59+
60+
Interactive conversation mode with persistent history.
61+
62+
```bash
63+
flow ai chat # Start chat session
64+
flow ai chat --context # Enable project context
65+
flow ai chat --clear # Clear conversation history
66+
flow ai chat --history # Show conversation history
67+
```
68+
69+
**In-Chat Commands:**
70+
71+
| Command | Description |
72+
| ---------- | -------------------------- |
73+
| `/clear` | Clear conversation history |
74+
| `/history` | Show conversation history |
75+
| `/context` | Toggle project context |
76+
| `/help` | Show help |
77+
| `/exit` | Exit chat (or Ctrl+D) |
78+
79+
### usage
80+
81+
Track AI command usage and get personalized suggestions.
82+
83+
```bash
84+
flow ai usage # Show statistics (default)
85+
flow ai usage stats # Show usage statistics
86+
flow ai usage suggest # Get personalized suggestions
87+
flow ai usage recent [n] # Show last n commands
88+
flow ai usage clear # Clear usage history
89+
```
90+
91+
**Statistics Tracked:**
92+
93+
- Total calls and success rate
94+
- Usage by command and mode
95+
- Recipe usage frequency
96+
- Current streak (daily usage)
97+
- Project-type patterns
98+
99+
### model
100+
101+
Manage AI model selection.
102+
103+
```bash
104+
flow ai model # Show current model
105+
flow ai model list # List available models
106+
flow ai model set <name> # Set default model
107+
```
108+
109+
**Available Models:**
110+
111+
| Model | Description |
112+
| -------- | --------------------------------------- |
113+
| `opus` | Most capable, deep reasoning |
114+
| `sonnet` | Balanced speed and capability (default) |
115+
| `haiku` | Fast, lightweight responses |
116+
15117
## Options
16118

17119
| Option | Description |
@@ -20,6 +122,7 @@ flow ai [options] <query>
20122
| `-f, --fix` | Fix mode - get suggestions to fix problems |
21123
| `-s, --suggest` | Suggest mode - get improvement suggestions |
22124
| `--create` | Create mode - generate code from descriptions |
125+
| `-m, --model` | Select model for this query (opus, sonnet, haiku) |
23126
| `-c, --context` | Force include project context |
24127
| `-v, --verbose` | Show context being sent to AI |
25128
| `-h, --help` | Show help message |
@@ -97,14 +200,22 @@ flow ai "should I use associative arrays here?"
97200
# Explain existing code
98201
flow ai --explain "the _flow_detect_type function"
99202

100-
# Get fix suggestions
101-
flow ai --fix "zsh: command not found: r"
203+
# Get fix suggestions with specific model
204+
flow ai --model opus --fix "complex architectural issue"
205+
206+
# Use recipes
207+
flow ai recipe review "function parse_status() { ... }"
208+
flow ai recipe commit "$(git diff --staged)"
209+
210+
# Interactive chat
211+
flow ai chat --context
102212

103-
# Request improvements
104-
flow ai --suggest "better progress bar implementation"
213+
# Check usage patterns
214+
flow ai usage suggest
105215

106-
# Generate new code
107-
flow ai --create "a health check for brew packages"
216+
# Switch to faster model for quick queries
217+
flow ai model set haiku
218+
flow ai "quick question"
108219
```
109220

110221
## Requirements
@@ -119,4 +230,4 @@ flow ai --create "a health check for brew packages"
119230

120231
---
121232

122-
_Added in v3.2.0_
233+
_Added in v3.2.0, enhanced in v3.4.0 (recipes, chat, usage, model)_

docs/commands/dash.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,59 @@ When displaying projects, priorities are color-coded:
323323

324324
---
325325

326+
## ⚡ Quick Wins Section (v3.4.0+)
327+
328+
The dashboard now includes a **Quick Wins** section showing tasks that can be completed in under 30 minutes. This is designed for ADHD-friendly productivity - easy wins to build momentum.
329+
330+
### Triggering Quick Wins
331+
332+
Projects appear in Quick Wins when their `.STATUS` file contains:
333+
334+
```yaml
335+
# Option 1: Mark as quick win directly
336+
quick_win: yes
337+
338+
# Option 2: Set estimate under 30 minutes
339+
estimate: 15m
340+
estimate: 20min
341+
```
342+
343+
### Display
344+
345+
```
346+
⚡ QUICK WINS (< 30 min)
347+
├─ ⚡ flow-cli Fix typo in docs ~15m
348+
├─ 🔥 medfit Update version number ~10m
349+
└─ ⏰ stat-440 Post grades ~20m
350+
```
351+
352+
---
353+
354+
## 🔥 Urgency Indicators (v3.4.0+)
355+
356+
Projects can show urgency indicators in the Quick Access and Quick Wins sections:
357+
358+
| Icon | Urgency | Trigger |
359+
| ---- | ------- | ---------------------------------------------- |
360+
| 🔥 | High | `urgency: high`, `deadline: today`, or overdue |
361+
|| Medium | `urgency: medium` or deadline within 3 days |
362+
|| Low | Quick win or `priority: low` |
363+
364+
### Setting Urgency in .STATUS
365+
366+
```yaml
367+
# Direct urgency setting
368+
urgency: high
369+
370+
# Or via deadline (YYYY-MM-DD format)
371+
deadline: 2025-12-27
372+
373+
# Or via priority
374+
priority: 1 # Maps to high urgency
375+
```
376+
377+
---
378+
326379
## 📂 File Dependencies
327380
328381
### Required Files

0 commit comments

Comments
 (0)