Save anything to your Slax Reader library from the command line — or let your AI Agent do it.
| I'm a human user | I'm an AI Agent |
|---|---|
| Install & Usage → | Agent Setup → |
- 📌 Save bookmarks by URL — with optional title, description, tags, and archive mode
- 📚 Browse your library — list bookmarks and get individual bookmark details
- 👤 Account management — login, logout, and get current user info
- 🔄 Auto update notifications — notified of new versions after each command; upgrade in one step
- 🤖 AI Agent skill — install a skill so your agent always knows how to use the CLI, with automatic sync hints when the CLI is upgraded
- Node.js ≥ 18
One-line setup (installs CLI + AI Agent skill):
npx @slax-lab/reader-cli@latest installVerify:
reader-cli --version- Sign in at Slax Reader
- Go to Settings → API Keys
- Click Create Key — your key starts with
sr-
# Log in
reader-cli login
# Save a bookmark
reader-cli add https://example.com
# Save with metadata
reader-cli add https://example.com \
--title "My Article" \
--description "Worth reading later" \
--tags "tech,ai" \
--archive
# List bookmarks
reader-cli list
# Get bookmark detail
reader-cli get <bookmark-id>Authenticate with your API Key.
| Option | Description |
|---|---|
--api-key <key> |
API Key (starts with sr-). Prompted interactively if omitted. |
--api-base <url> |
Custom API base URL (for self-hosted instances). |
Clear stored credentials from local config.
Display current user information.
Current User:
Username : john
Email : john@example.com
API Base : https://api-reader.slax.com
API Key : sr-xxxxxxx...
Save a URL as a bookmark.
| Option | Description |
|---|---|
-t, --title <title> |
Custom bookmark title |
-d, --description <desc> |
Short description |
--tags <tags> |
Comma-separated tags, e.g. "tech,news" |
--archive |
Enable archive mode |
Examples:
reader-cli add https://example.com
reader-cli add https://example.com --title "Example" --tags "reading,ai"
reader-cli add https://example.com --archiveList your bookmarks. Alias: reader-cli ls.
| Option | Description |
|---|---|
-p, --page <number> |
Page number (default: 1) |
-s, --size <number> |
Items per page (default: 20) |
-f, --filter <type> |
Filter: all, inbox, archive, or starred (default: all) |
--json |
Output JSON |
Examples:
reader-cli list
reader-cli list --filter inbox --page 2
reader-cli ls --size 10Get bookmark detail, including metadata and extracted content.
| Option | Description |
|---|---|
--markdown |
Fetch content as Markdown instead of plain text |
--json |
Output JSON |
Examples:
reader-cli get fe32cc83-0766-45ad-bbb9-957bd3e78f38
reader-cli get fe32cc83-0766-45ad-bbb9-957bd3e78f38 --markdownUpgrade the CLI to the latest version.
| Option | Description |
|---|---|
--check |
Check for a newer version only; do not install |
Manage the AI Agent skill. The skill teaches your agent how to use the CLI and is installed automatically by npx @slax-lab/reader-cli@latest install.
| Option | Description |
|---|---|
--check |
Show whether the installed skill is in sync with the current CLI version |
--sync |
Install or update the skill to match the current CLI version |
--force |
Force reinstall even if already in sync |
After upgrading the CLI, reader-cli upgrade also keeps the skill in sync. When your agent sees _hints.upgrade or _hints.skill in command output, it should offer the same repair command: reader-cli upgrade.
Show full usage and all available commands.
Let your AI Agent install and configure everything for you. Copy the prompt below and send it to your AI Agent (Claude Code, Codex, Gemini CLI, Cursor, OpenClaw, etc.):
Help me install and set up Slax Reader CLI: https://github.com/slax-lab/slax-reader-cli/blob/main/docs/ai-agent-installation-guide.md
Your agent will read the guide, install the CLI and the AI Agent skill, walk you through authentication — all automatically.
Supports: Claude Code · Claude Desktop · OpenAI Codex · Gemini CLI · OpenClaw · Cursor · Windsurf
The skill (skills/slax-reader/SKILL.md) teaches your agent how to use the CLI. Once installed, your agent will:
- Know all available commands and options
- Automatically notify you when a new CLI version is available (
_hints.upgrade) - Automatically notify you when the skill is out of sync with the CLI (
_hints.skill) and offer to runreader-cli upgrade
Install or update the skill manually if needed:
reader-cli skill --syncCheck sync status:
reader-cli skill --checkAlready installed? Add this to your agent's system prompt
You have access to the `reader-cli` CLI for saving bookmarks to Slax Reader.
Available commands:
reader-cli add <url> [options] Save a URL as a bookmark
-t, --title <title> Custom title
-d, --description <desc> Short description
--tags <tags> Comma-separated tags, e.g. "tech,news"
--archive Enable archive mode
reader-cli list [options] List bookmarks
-p, --page <number> Page number, default 1
-s, --size <number> Items per page, default 20
-f, --filter <type> all, inbox, archive, or starred
reader-cli get <bookmark-id> Get bookmark detail
--markdown Fetch content as Markdown
reader-cli whoami Show current user
reader-cli logout Clear credentials
reader-cli upgrade Update to latest version
reader-cli --help Full usage
Notes:
- All commands support --json for machine-readable output.
- URLs without http(s):// are auto-prefixed with https://
- If you get an auth error, ask the user to run: reader-cli login
By installing or using this CLI you agree to the Slax Reader Terms of Service. Key points:
- Personal or authorized use only — do not use this tool on behalf of others without their explicit consent.
- Keep your API Key private — do not commit it to version control or share it publicly.
- No bulk scraping or abuse — automated mass-saving without genuine user intent violates our fair-use policy.
- Data & privacy — bookmark data is handled per the Slax Reader Privacy Policy.
- Terms may change — the official website is always authoritative; this README is a summary only.
MIT © slax-lab