Your library,
from the command line.
The Bredbox CLI puts your saves, tags, and collections in your terminal. Use it by hand, in shell scripts, or from AI agents.
npm i -g @bredbox/cli
Requires Node.js 22.18 or later. To try it without installing, run npx @bredbox/cli saves list.
Getting Started
Up and running in three steps
The token is saved to ~/.config/bredbox/config.json, or %APPDATA%\bredbox\config.json on Windows. In a script, pipe the token in with bredbox auth login < token.txt, or set BREDBOX_TOKEN instead. Run bredbox auth logout to delete a saved token.
-
Install the CLI
Install it globally from npm. It needs Node.js 22.18 or later and has no dependencies of its own.
npm i -g @bredbox/cli -
Create an API token
Open the API tokens page in your Bredbox settings and create a token for the CLI.
Go to API tokens -
Sign in
Paste the token when asked. It isn't shown as you type, and the CLI checks it against the API before saving it.
bredbox auth login
Usage
Commands that follow the API
Each command is a group, sometimes a subgroup, and then an operation. If you know the REST API, you already know the CLI.
From API to flags
- Path parameters
- become positionals, in URL order.
saves get <save-id> - Query and body fields
- become kebab-case flags.
per_page → --per-page - Arrays
- repeat the flag once for each value.
--tags one --tags two - Booleans
- take a --no- prefix to pass false.
--no-is-favorite - Nested objects
- are passed as JSON.
--location '{"kind":"pdf","page":3}' - Files
- are read with @, or uploaded from a path.
--html @page.html
Run bredbox --help to see every group. Add --help to any command to see its options and the HTTP request it sends.
Built for people and scripts alike
-
Every API operation
Each REST API v2 operation is a command, generated from the API's OpenAPI document, so the CLI stays in step with the API.
-
Readable, or scriptable
On a terminal, lists print as tables and objects as aligned fields. When piped, you get JSON, ready for jq, scripts, and AI agents.
-
Safe by default
Deletes ask for confirmation, and scripts must pass --force on purpose. Add --dry-run to see the request without sending it.
-
Your token, your way
Sign in once, or set BREDBOX_TOKEN in your environment, which takes precedence. The token never goes on the command line, where it would land in your shell history. auth status shows which is in use.
The CLI is part of Bredbox Pro
The CLI uses the Bredbox REST API, which comes with a Pro subscription along with webhooks, the MCP server, and the n8n integration.