Synopsis
Arguments
| Argument | Required | Description |
|---|
name | Yes | The name of the flow to read the note for |
What it does
progflow note reads the note field from ~/.config/flow/<name>.json and prints it to stdout.
Notes are saved when you stop a flow with progflow off and answer y at the context note prompt. They capture where you left off so you can pick up quickly next time you activate the flow.
Output
When a note has been saved:
Refactoring auth middleware, tests pass but need cleanup
How notes are saved
Notes are written by progflow off during the interactive shutdown prompt:
Save a context note? [y/N]: y
Enter note: Refactoring auth middleware, tests pass but need cleanup
✓ flow 'myproject' stopped
The note prompt only appears when stdin is a terminal. In non-interactive mode (scripted or piped), progflow off skips the prompt and leaves the existing note unchanged.
Error cases
| Condition | Exit code | Message |
|---|
Flow <name> does not exist | 1 | Flow '<name>' does not exist |
| Config file cannot be read or parsed | 2 | IO or JSON error |
Exit codes
| Code | Meaning |
|---|
0 | Success (including the “no note saved” case) |
1 | User error — flow not found |
2 | IO or JSON parse error |
See also