teach_playbook
Records a CLI playbook and free-text notes for a query family so you can reuse repeatable steps and capture gotchas or workarounds.
Instructions
Record a CLI playbook + free-text notes for a query family
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| csv | No | Output as CSV (table and array responses) (default: false) | |
| yes | No | Skip confirmation prompts (explicit confirmation for scripts) (default: false) | |
| json | No | Output as JSON (default: false) | |
| agent | No | Set agent-friendly output defaults (--json --compact --no-input --no-color) (default: false) | |
| notes | No | Free-text notes (gotchas, workarounds) -- mutually exclusive with --notes-file | |
| plain | No | Output as plain tab-separated text (default: false) | |
| query | No | Example query that anchors the family (required) | |
| quiet | No | Bare output, one value per line (default: false) | |
| select | No | Comma-separated fields to include in output (e.g. --select id,notetype_id,deck_id) | |
| compact | No | Return only key fields (id, name, status, timestamps) for minimal token usage (default: false) | |
| dry-run | No | Show request without sending (default: false) | |
| max-age | No | Maximum acceptable age of local-store data before a stderr hint suggests sync; 0 disables (default: 30m0s) | |
| receipt | No | Write an atomic private run receipt (default: false) | |
| timeout | No | Request timeout (default: 1m0s) | |
| no-cache | No | Bypass response cache (default: false) | |
| no-color | No | Disable colored output (default: false) | |
| no-input | No | Disable all interactive prompts (for CI/agents) (default: false) | |
| no-learn | No | Disable the teach/recall learning loop for this invocation (default: false) | |
| idempotent | No | Treat already-existing create results as a successful no-op (default: false) | |
| notes-file | No | Path to a markdown file with the notes | |
| rate-limit | No | Max requests per second (0 to disable; default auto — pace to server rate-limit headers) (default: auto) | |
| data-source | No | Data source for read commands: auto (live with local fallback), live (API only), local (synced data only) (default: auto) | |
| playbook-file | No | Path to a JSON file with the playbook (steps, entity_slots, expected_tool_calls) | |
| playbook-json | No | Inline playbook JSON (steps, entity_slots, expected_tool_calls) -- mutually exclusive with --playbook-file | |
| client-profile | No | Select the tenant-gated client profile (env: ANKIWEB_CLIENT_PROFILE) | |
| human-friendly | No | Enable colored output and rich formatting (default: false) | |
| allow-partial-failure | No | Downgrade response-body partial-failure (e.g. partialFailureError) to a warning instead of a non-zero exit (default: false) |