Skip to content

Commit aff1f98

Browse files
authored
Merge pull request #248 from Data-Wise/dev
Release v5.8.0 - Documentation Updates
2 parents 6410544 + 4567e5c commit aff1f98

File tree

7 files changed

+938
-32
lines changed

7 files changed

+938
-32
lines changed

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Flow CLI
22

3-
[![Version](https://img.shields.io/badge/version-v5.6.0-blue)](https://github.com/Data-Wise/flow-cli/releases/tag/v5.6.0)
3+
[![Version](https://img.shields.io/badge/version-v5.8.0-blue)](https://github.com/Data-Wise/flow-cli/releases/tag/v5.8.0)
44
[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
55
[![Tests](https://img.shields.io/github/actions/workflow/status/Data-Wise/flow-cli/test.yml?label=tests&branch=main)](https://github.com/Data-Wise/flow-cli/actions/workflows/test.yml)
66
[![Docs](https://img.shields.io/github/actions/workflow/status/Data-Wise/flow-cli/docs.yml?label=docs&branch=main)](https://github.com/Data-Wise/flow-cli/actions/workflows/docs.yml)
77
[![Pure ZSH](https://img.shields.io/badge/pure-ZSH-1f425f)](https://www.zsh.org/)
8-
[![ADHD-Friendly](https://img.shields.io/badge/ADHD-friendly-purple)](docs/PHILOSOPHY.md)
8+
[![ADHD-Friendly](https://img.shields.io/badge/ADHD-friendly-purple)](PHILOSOPHY.md)
99

1010
> **ZSH workflow tools designed for ADHD brains.**
1111

docs/quick-reference-card.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,23 @@ dot secret add X # Store in Keychain
9595
dot help # Show all commands
9696
```
9797

98+
### Prompt Engines: `prompt` (v5.7.0)
99+
```bash
100+
prompt status # Show current engine
101+
prompt toggle # Switch engines (menu)
102+
prompt starship # Switch to Starship
103+
prompt p10k # Switch to Powerlevel10k
104+
prompt help # Show all commands
105+
```
106+
107+
### Teaching: `teach` (v5.8.0)
108+
```bash
109+
teach status # Show course status
110+
teach exam "Name" # Create exam (Scholar)
111+
teach deploy # Push to production
112+
teach help # Show all commands
113+
```
114+
98115
---
99116

100117
## 🔥 Timers & Focus
@@ -140,4 +157,4 @@ status my-project active P0 "Next task description"
140157

141158
---
142159

143-
<small>Flow CLI v5.5.0 | MIT License | [github.com/data-wise/flow-cli](https://github.com/data-wise/flow-cli)</small>
160+
<small>Flow CLI v5.8.0 | MIT License | [github.com/data-wise/flow-cli](https://github.com/data-wise/flow-cli)</small>

docs/reference/COMMAND-QUICK-REFERENCE.md

Lines changed: 71 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> **Pattern:** `command + keyword + options`
44
> **Philosophy:** One command per domain, discoverable with `help`
5-
> **Version:** v4.7.0 (2025-12-31)
5+
> **Version:** v5.8.0 (2026-01-14)
66
77
---
88

@@ -148,6 +148,56 @@ tm help # Show all commands
148148

149149
**Aliases:** `tmt` (title), `tmp` (profile), `tmg` (ghost), `tms` (switch)
150150

151+
### Prompt Engine Manager: `prompt` (v5.7.0)
152+
153+
```bash
154+
prompt # Show help
155+
prompt status # Show current engine + alternatives
156+
prompt list # Table view of all engines
157+
prompt toggle # Interactive menu to pick engine
158+
prompt starship # Switch to Starship
159+
prompt p10k # Switch to Powerlevel10k
160+
prompt ohmyposh # Switch to Oh My Posh
161+
prompt setup-ohmyposh # Interactive Oh My Posh wizard
162+
prompt help # Show all commands
163+
```
164+
165+
**Options:**
166+
167+
```bash
168+
prompt --dry-run toggle # Preview changes without applying
169+
prompt --dry-run starship # Preview Starship switch
170+
```
171+
172+
**Supported Engines:** Powerlevel10k, Starship, Oh My Posh
173+
174+
### Teaching Workflow: `teach` (v5.4.1+)
175+
176+
```bash
177+
teach init "STAT 545" # Initialize teaching workflow
178+
teach init -y "STAT 440" # Non-interactive mode
179+
teach status # Show project status
180+
teach week # Show current week number
181+
teach config # Edit teach-config.yml
182+
teach deploy # Deploy draft → production
183+
teach archive # Archive semester
184+
teach help # Show all commands
185+
```
186+
187+
**Scholar Wrappers (v5.8.0):**
188+
189+
```bash
190+
teach exam "Midterm" # Create exam via Scholar plugin
191+
teach quiz "Topic" # Create quiz via Scholar plugin
192+
teach slides "Topic" # Generate slides via Scholar plugin
193+
teach syllabus # Generate syllabus via Scholar plugin
194+
teach rubric "Name" # Generate rubric via Scholar plugin
195+
teach feedback "Work" # Generate feedback via Scholar plugin
196+
teach demo # Demo teaching workflow
197+
```
198+
199+
**Universal Flags:** `--dry-run`, `--format`, `--output`, `--verbose`
200+
151201
---
152202

153203
## Sync & Data Management (v4.7.0)
@@ -467,6 +517,8 @@ reload # Reload zshrc
467517
| MCP Servers | `mcp` | `mcp <action> [srv]` |
468518
| Obsidian Notes | `obs` | `obs <action> [arg]` |
469519
| Terminal | `tm` | `tm <action> [arg]` |
520+
| Prompt (v5.7) | `prompt` | `prompt <action> [engine]` |
521+
| Teaching | `teach` | `teach <action> [args]` |
470522
| Sync (v4.7.0) | `flow sync` | `flow sync [target] [opts]` |
471523
| AI Assistant | `flow ai` | `flow ai [--mode] "query"` |
472524
| Natural Lang | `flow do` | `flow do "command in English"` |
@@ -485,24 +537,26 @@ reload # Reload zshrc
485537

486538
## Files
487539

488-
| File | Purpose |
489-
| ------------------------------------------------------------------ | --------------------------- |
490-
| `~/projects/dev-tools/flow-cli/lib/dispatchers/` | All dispatchers |
491-
| `~/projects/dev-tools/flow-cli/lib/dispatchers/r-dispatcher.zsh` | r (R package dev) |
492-
| `~/projects/dev-tools/flow-cli/lib/dispatchers/g-dispatcher.zsh` | g (git workflows) |
493-
| `~/projects/dev-tools/flow-cli/lib/dispatchers/qu-dispatcher.zsh` | qu (Quarto publishing) |
494-
| `~/projects/dev-tools/flow-cli/lib/dispatchers/mcp-dispatcher.zsh` | mcp (MCP servers) |
495-
| `~/projects/dev-tools/flow-cli/lib/dispatchers/obs.zsh` | obs (Obsidian notes) |
496-
| `~/projects/dev-tools/flow-cli/commands/ai.zsh` | flow ai, flow do (v3.2.0) |
497-
| `~/projects/dev-tools/flow-cli/commands/install.zsh` | flow install (v3.2.0) |
498-
| `~/projects/dev-tools/flow-cli/commands/upgrade.zsh` | flow upgrade (v3.2.0) |
499-
| `~/projects/dev-tools/flow-cli/commands/doctor.zsh` | flow doctor (health check) |
500-
| `~/projects/dev-tools/flow-cli/commands/alias.zsh` | flow alias (v5.4.0) |
501-
| `~/projects/dev-tools/flow-cli/setup/Brewfile` | Homebrew bundle |
502-
| `~/.config/zsh/.zshrc` | ccy function, gem\* aliases |
540+
| File | Purpose |
541+
| ------------------------------------------------------------------- | ---------------------------- |
542+
| `~/projects/dev-tools/flow-cli/lib/dispatchers/` | All dispatchers |
543+
| `~/projects/dev-tools/flow-cli/lib/dispatchers/r-dispatcher.zsh` | r (R package dev) |
544+
| `~/projects/dev-tools/flow-cli/lib/dispatchers/g-dispatcher.zsh` | g (git workflows) |
545+
| `~/projects/dev-tools/flow-cli/lib/dispatchers/qu-dispatcher.zsh` | qu (Quarto publishing) |
546+
| `~/projects/dev-tools/flow-cli/lib/dispatchers/mcp-dispatcher.zsh` | mcp (MCP servers) |
547+
| `~/projects/dev-tools/flow-cli/lib/dispatchers/obs.zsh` | obs (Obsidian notes) |
548+
| `~/projects/dev-tools/flow-cli/lib/dispatchers/prompt-dispatcher.zsh` | prompt (engines, v5.7.0) |
549+
| `~/projects/dev-tools/flow-cli/lib/dispatchers/teach-dispatcher.zsh` | teach (teaching, v5.4.1) |
550+
| `~/projects/dev-tools/flow-cli/commands/ai.zsh` | flow ai, flow do (v3.2.0) |
551+
| `~/projects/dev-tools/flow-cli/commands/install.zsh` | flow install (v3.2.0) |
552+
| `~/projects/dev-tools/flow-cli/commands/upgrade.zsh` | flow upgrade (v3.2.0) |
553+
| `~/projects/dev-tools/flow-cli/commands/doctor.zsh` | flow doctor (health check) |
554+
| `~/projects/dev-tools/flow-cli/commands/alias.zsh` | flow alias (v5.4.0) |
555+
| `~/projects/dev-tools/flow-cli/setup/Brewfile` | Homebrew bundle |
556+
| `~/.config/zsh/.zshrc` | ccy function, gem\* aliases |
503557

504558
**Removed:** `v-dispatcher.zsh` (deprecated, use `flow` command instead)
505559

506560
---
507561

508-
_Updated: 2026-01-12 (v5.4.0)_
562+
_Updated: 2026-01-14 (v5.8.0)_

docs/reference/DISPATCHER-REFERENCE.md

Lines changed: 85 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Dispatcher Reference - flow-cli
22

3-
**Last Updated:** January 12, 2026
4-
**Version:** flow-cli v5.4.1
3+
**Last Updated:** January 14, 2026
4+
**Version:** flow-cli v5.8.0
55

66
---
77

@@ -13,7 +13,7 @@ Dispatchers are smart command routers that provide context-aware workflows for s
1313

1414
---
1515

16-
## Active Dispatchers (10)
16+
## Active Dispatchers (11)
1717

1818
### 1. `g` - Git Workflows
1919

@@ -142,7 +142,63 @@ obs analyze # Analyze vault
142142

143143
---
144144

145-
### 4. `qu` - Quarto Publishing
145+
### 4. `prompt` - Prompt Engine Manager
146+
147+
**File:** `prompt-dispatcher.zsh`
148+
**Purpose:** Unified management of prompt themes (Powerlevel10k, Starship, Oh My Posh)
149+
**Added:** January 14, 2026 (v5.7.0)
150+
151+
**Common Commands:**
152+
153+
```bash
154+
# Status & info
155+
prompt # Show help (default)
156+
prompt status # Show current engine + alternatives
157+
prompt list # Table view of all engines
158+
159+
# Engine switching
160+
prompt toggle # Interactive menu to pick engine
161+
prompt starship # Switch to Starship
162+
prompt p10k # Switch to Powerlevel10k
163+
prompt ohmyposh # Switch to Oh My Posh
164+
165+
# Setup & configuration
166+
prompt setup-ohmyposh # Interactive Oh My Posh wizard
167+
prompt help # Show help
168+
169+
# Options
170+
prompt --dry-run toggle # Preview changes without applying
171+
```
172+
173+
**Supported Engines:**
174+
175+
| Engine | Config Path | Description |
176+
|--------|-------------|-------------|
177+
| Powerlevel10k | `~/.config/zsh/.p10k.zsh` | Feature-rich, highly customizable |
178+
| Starship | `~/.config/starship.toml` | Minimal, fast Rust-based |
179+
| Oh My Posh | `~/.config/ohmyposh/config.json` | Modular with extensive themes |
180+
181+
**Environment Variable:**
182+
183+
```bash
184+
# Control which engine is active
185+
export FLOW_PROMPT_ENGINE="starship" # Valid: powerlevel10k, starship, ohmyposh
186+
```
187+
188+
**Features:**
189+
190+
- One-command engine switching with validation
191+
- Interactive toggle menu for quick switching
192+
- Dry-run mode to preview changes
193+
- Automatic shell reload after switch
194+
- Setup wizard for Oh My Posh
195+
- Integration with `flow doctor` for health checks
196+
197+
**See also:** [PROMPT-DISPATCHER-REFERENCE.md](PROMPT-DISPATCHER-REFERENCE.md)
198+
199+
---
200+
201+
### 5. `qu` - Quarto Publishing
146202

147203
**File:** `qu-dispatcher.zsh`
148204
**Purpose:** Quarto document and presentation workflows
@@ -193,7 +249,7 @@ qu commit # Render and commit changes
193249

194250
---
195251

196-
### 5. `r` - R Package Development
252+
### 6. `r` - R Package Development
197253

198254
**File:** `r-dispatcher.zsh`
199255
**Purpose:** R package development workflows
@@ -259,7 +315,7 @@ r tree # Package structure tree
259315

260316
---
261317

262-
### 6. `cc` - Claude Code Workflows
318+
### 7. `cc` - Claude Code Workflows
263319

264320
**File:** `cc-dispatcher.zsh`
265321
**Purpose:** Smart Claude Code project workflows
@@ -323,7 +379,7 @@ cc wt opus <branch> # Worktree + Opus model
323379

324380
---
325381

326-
### 7. `wt` - Git Worktree Management
382+
### 8. `wt` - Git Worktree Management
327383

328384
**File:** `wt-dispatcher.zsh`
329385
**Purpose:** Git worktree management for parallel development
@@ -383,7 +439,7 @@ wt unlock <path> # → git worktree unlock <path>
383439

384440
---
385441

386-
### 8. `tm` - Terminal Manager
442+
### 9. `tm` - Terminal Manager
387443

388444
**File:** `tm-dispatcher.zsh`
389445
**Purpose:** Terminal management via aiterm integration
@@ -445,7 +501,7 @@ Automatically detects: iTerm2, Ghostty, WezTerm, Kitty, Alacritty, VS Code, Term
445501

446502
---
447503

448-
### 9. `dot` - Dotfile Management
504+
### 10. `dot` - Dotfile Management
449505

450506
**File:** `dot-dispatcher.zsh`
451507
**Purpose:** Dotfile sync via chezmoi + secret management via Bitwarden
@@ -548,7 +604,7 @@ Use Bitwarden secrets in chezmoi templates:
548604

549605
---
550606

551-
### 10. `teach` - Teaching Workflow
607+
### 11. `teach` - Teaching Workflow
552608

553609
**File:** `teach-dispatcher.zsh`
554610
**Purpose:** Unified teaching workflow for course websites
@@ -846,10 +902,27 @@ source ~/projects/dev-tools/flow-cli/lib/dispatchers/<name>.zsh
846902

847903
## Summary
848904

849-
**Active Dispatchers:** 8 (g, mcp, obs, qu, r, cc, wt, tm)
905+
**Active Dispatchers:** 11 (g, mcp, obs, prompt, qu, r, cc, wt, tm, dot, teach)
850906
**Removed:** 2 (v, vibe)
851907
**Not Restored:** 3 (gm, note, timer - alternatives available)
852-
**Total Commands:** ~130+ subcommands across all dispatchers
908+
**Total Commands:** ~150+ subcommands across all dispatchers
909+
910+
**New in v5.7.0:**
911+
912+
- `prompt` dispatcher - Prompt engine manager (Powerlevel10k, Starship, Oh My Posh)
913+
- Interactive engine switching with validation
914+
- Dry-run mode for previewing changes
915+
- Setup wizard for Oh My Posh
916+
917+
**New in v5.4.1:**
918+
919+
- `teach` dispatcher - Teaching workflow for course websites
920+
- Non-interactive mode with `-y` flag
921+
922+
**New in v5.0.0:**
923+
924+
- `dot` dispatcher - Dotfile management + secret management
925+
- macOS Keychain integration (v5.5.0)
853926

854927
**New in v4.4.0:**
855928

0 commit comments

Comments
 (0)