shelf_set
Mark a Goodreads book as to-read, currently-reading, or read to update its shelf status and track reading progress.
Instructions
Mark a book as to-read, currently-reading, or read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| csv | No | Output as CSV (table and array responses) (default: false) | |
| yes | No | Skip confirmation prompts (for agents and scripts) (default: false) | |
| args | No | Additional positional arguments or raw CLI flags to append to the command. | |
| json | No | Output as JSON (default: false) | |
| tags | No | Optional comma-separated tags to apply | |
| agent | No | Set all agent-friendly defaults (--json --compact --no-input --no-color --yes) (default: false) | |
| plain | No | Output as plain tab-separated text (default: false) | |
| quiet | No | Bare output, one value per line (default: false) | |
| shelf | Yes | Shelf: to-read, currently-reading, or read | |
| config | No | Config file path | |
| rating | No | Optional rating from 1 to 5 (default: 0) | |
| select | No | Comma-separated fields to include in output (e.g. --select id,name,status) | |
| book-id | No | Goodreads book id/slug or GraphQL kca://book id | |
| compact | No | Return only key fields (id, name, status, timestamps) for minimal token usage (default: false) | |
| deliver | No | Route output to a sink: stdout (default), file:<path>, webhook:<url> | |
| dry-run | No | Show request without sending (default: false) | |
| profile | No | Apply values from a saved profile (see 'goodreads profile list') | |
| timeout | No | Request timeout (default: 30s) | |
| 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) | |
| idempotent | No | Treat already-existing create results as a successful no-op (default: false) | |
| rate-limit | No | Max requests per second (0 to disable) (default: 0) | |
| started-at | No | Reserved for Goodreads started date writes; currently unsupported | |
| data-source | No | Data source for read commands: auto (live with local fallback), live (API only), local (synced data only) (default: auto) | |
| finished-at | No | Reserved for Goodreads finished date writes; currently unsupported | |
| human-friendly | No | Enable colored output and rich formatting (default: false) |