Skip to content

Commit 765ac93

Browse files
Data-Wiseclaude
Data-Wise
and
claude
committed
docs: add config and plugin command documentation
- docs/commands/config.md: Complete config command reference - All 11 subcommands documented - Configuration keys by category - Built-in profiles explained - Examples for common workflows - docs/commands/plugin.md: Complete plugin command reference - Plugin creation guide - Hook system documentation - Plugin API reference - Best practices - Updated mkdocs.yml navigation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent bbbee13 commit 765ac93

File tree

3 files changed

+552
-0
lines changed

3 files changed

+552
-0
lines changed

‎docs/commands/config.md‎

Lines changed: 276 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,276 @@
1+
# flow config
2+
3+
> Configuration management with profiles
4+
5+
## Synopsis
6+
7+
```bash
8+
flow config [command] [options]
9+
flow config show [filter]
10+
flow config set <key> <value>
11+
flow config profile load <name>
12+
```
13+
14+
## Description
15+
16+
`flow config` provides a comprehensive configuration system for flow-cli. It supports viewing and modifying settings, saving/loading configuration profiles, and an interactive wizard for first-time setup.
17+
18+
Configuration is stored in `~/.config/flow/config.zsh` and organized into 6 categories with 20+ configurable options.
19+
20+
## Commands
21+
22+
| Command | Description |
23+
| ------------------- | ---------------------------------------------- |
24+
| `show [filter]` | Show all config (optionally filter by keyword) |
25+
| `get <key>` | Get a specific config value |
26+
| `set <key> <value>` | Set a config value |
27+
| `edit` | Open config file in editor |
28+
| `reset <key>` | Reset a key to default |
29+
| `reset --all` | Reset all to defaults |
30+
| `save` | Save current config to file |
31+
| `reload` | Reload config from file |
32+
| `wizard` | Interactive configuration wizard |
33+
| `profile <action>` | Manage configuration profiles |
34+
| `export` | Export config in shell format |
35+
| `path` | Show config file paths |
36+
37+
## Configuration Keys
38+
39+
### Core Settings
40+
41+
| Key | Default | Description |
42+
| ------------------ | ------------ | ------------------------------------- |
43+
| `projects_root` | `~/projects` | Root directory for projects |
44+
| `atlas_enabled` | `auto` | Atlas integration (`auto`/`yes`/`no`) |
45+
| `load_dispatchers` | `yes` | Load g, r, qu, mcp, obs dispatchers |
46+
| `quiet` | `0` | Suppress startup messages |
47+
| `debug` | `0` | Enable debug output |
48+
49+
### UI Settings
50+
51+
| Key | Default | Description |
52+
| -------------------- | --------- | ---------------------- |
53+
| `color_theme` | `default` | Color theme |
54+
| `progress_bar_width` | `10` | Width of progress bars |
55+
| `show_icons` | `yes` | Show icons in output |
56+
57+
### Timer Settings
58+
59+
| Key | Default | Description |
60+
| ------------------ | ------- | -------------------------------- |
61+
| `timer_default` | `25` | Default timer duration (minutes) |
62+
| `timer_break` | `5` | Break timer duration (minutes) |
63+
| `timer_long_break` | `15` | Long break duration (minutes) |
64+
| `timer_sound` | `yes` | Play sound when timer completes |
65+
66+
### ADHD Settings
67+
68+
| Key | Default | Description |
69+
| ----------------- | ------- | ---------------------------------------- |
70+
| `auto_breadcrumb` | `yes` | Auto-create breadcrumbs on session start |
71+
| `session_timeout` | `120` | Session timeout (minutes) |
72+
| `dopamine_mode` | `yes` | Enable dopamine-boosting feedback |
73+
74+
### Git Settings
75+
76+
| Key | Default | Description |
77+
| ------------------- | ------- | ------------------------------------ |
78+
| `auto_commit` | `no` | Auto-commit on finish |
79+
| `commit_emoji` | `yes` | Use emoji in commit messages |
80+
| `push_after_finish` | `ask` | Push after finish (`yes`/`no`/`ask`) |
81+
82+
### AI Settings
83+
84+
| Key | Default | Description |
85+
| ------------- | -------- | ----------------- |
86+
| `ai_provider` | `claude` | AI provider |
87+
| `ai_context` | `auto` | AI context mode |
88+
| `ai_verbose` | `no` | Verbose AI output |
89+
90+
## Profiles
91+
92+
### Built-in Profiles
93+
94+
| Profile | Description | Key Changes |
95+
| ------------ | ---------------------------- | ---------------------------------------- |
96+
| `minimal` | Quiet mode, minimal features | quiet=1, show_icons=no, dopamine_mode=no |
97+
| `developer` | Full developer settings | load_dispatchers=yes, commit_emoji=yes |
98+
| `adhd` | Maximum ADHD support | dopamine_mode=yes, session_timeout=90 |
99+
| `researcher` | Academic workflow optimized | timer_default=45, push_after_finish=no |
100+
101+
### Profile Commands
102+
103+
```bash
104+
# List all profiles
105+
flow config profile list
106+
107+
# Load a built-in profile
108+
flow config profile load adhd
109+
110+
# Save current config as profile
111+
flow config profile save work
112+
113+
# Delete a user profile
114+
flow config profile delete work
115+
```
116+
117+
## Examples
118+
119+
### View Configuration
120+
121+
```bash
122+
# Show all settings
123+
flow config show
124+
125+
# Filter by category
126+
flow config show timer
127+
128+
# Filter by keyword
129+
flow config show adhd
130+
```
131+
132+
Output:
133+
134+
```
135+
FLOW-CLI CONFIGURATION
136+
137+
TIMER
138+
timer_default = 25
139+
timer_break = 5
140+
timer_long_break = 15
141+
timer_sound = yes
142+
143+
* = modified from default
144+
Config file: ~/.config/flow/config.zsh
145+
```
146+
147+
### Get/Set Values
148+
149+
```bash
150+
# Get a value
151+
flow config get timer_default
152+
# Output: 25
153+
154+
# Set a value
155+
flow config set timer_default 30
156+
# Output: ✓ timer_default: 25 → 30
157+
158+
# Shorthand syntax
159+
flow config timer_default=30
160+
```
161+
162+
### Reset to Defaults
163+
164+
```bash
165+
# Reset single key
166+
flow config reset timer_default
167+
168+
# Reset everything
169+
flow config reset --all
170+
```
171+
172+
### Using Profiles
173+
174+
```bash
175+
# Load ADHD-optimized settings
176+
flow config profile load adhd
177+
178+
# Save current settings for later
179+
flow config profile save work
180+
181+
# List available profiles
182+
flow config profile list
183+
```
184+
185+
Output:
186+
187+
```
188+
CONFIGURATION PROFILES
189+
190+
Built-in:
191+
minimal - Minimal settings, quiet mode
192+
developer - Full developer settings
193+
adhd - Maximum ADHD support features
194+
researcher - Academic workflow optimized
195+
196+
User Profiles:
197+
work (saved: 2025-12-26)
198+
```
199+
200+
### Interactive Setup
201+
202+
```bash
203+
flow config wizard
204+
```
205+
206+
Launches an interactive wizard that guides you through:
207+
208+
1. Core settings (projects root, atlas integration)
209+
2. Timer settings (pomodoro durations)
210+
3. ADHD settings (dopamine mode, breadcrumbs)
211+
4. Git settings (push behavior, emoji)
212+
213+
### Export Configuration
214+
215+
```bash
216+
# Export in shell format (for sharing or backup)
217+
flow config export > my-config.zsh
218+
219+
# Show config file locations
220+
flow config path
221+
```
222+
223+
## Configuration File
224+
225+
The configuration file is located at:
226+
227+
```
228+
~/.config/flow/config.zsh
229+
```
230+
231+
Format:
232+
233+
```zsh
234+
# flow-cli configuration
235+
FLOW_CONFIG[timer_default]="25"
236+
FLOW_CONFIG[dopamine_mode]="yes"
237+
# ...
238+
```
239+
240+
### Profile Storage
241+
242+
User profiles are stored in:
243+
244+
```
245+
~/.config/flow/profiles/<name>.zsh
246+
```
247+
248+
## Environment Variables
249+
250+
These can be set in `.zshrc` before sourcing flow-cli:
251+
252+
```zsh
253+
# Override config directory
254+
export FLOW_CONFIG_DIR=~/.config/flow
255+
256+
# Override data directory
257+
export FLOW_DATA_DIR=~/.local/share/flow
258+
259+
# Override projects root
260+
export FLOW_PROJECTS_ROOT=~/projects
261+
```
262+
263+
## Related Commands
264+
265+
- [`flow doctor`](doctor.md) - Check system health
266+
- [`flow install`](install.md) - Install recommended tools
267+
- [`flow upgrade`](upgrade.md) - Update flow-cli
268+
269+
## See Also
270+
271+
- [Getting Started](../getting-started/quick-start.md)
272+
- [ADHD Settings Guide](../guides/adhd-settings.md)
273+
274+
---
275+
276+
_Added in v3.3.0_

0 commit comments

Comments
 (0)