readwise-reader-cli
v0.1.0
Published
CLI tool for Readwise Reader API
Maintainers
Readme
Readwise Reader CLI
A command-line interface for the Readwise Reader API.
Based on the official Readwise Reader API.
Installation
npm install -g readwise-reader-cliOr run directly with npx:
npx readwise-reader-cli list
npx readwise-reader-cli save https://example.comSetup
Get your Readwise access token from readwise.io/access_token
Set the token as an environment variable:
export READWISE_TOKEN=your_token_hereOr create a .env file in your project:
READWISE_TOKEN=your_token_hereUsage
List documents
# List all documents
reader list
# Filter by location
reader list --location later
# Filter by category
reader list --category article
# Limit results
reader list --limit 10
# Output as JSON
reader list --jsonSave a document
# Save a URL
reader save https://example.com/article
# With metadata
reader save https://example.com/article \
--title "My Article" \
--author "John Doe" \
--tags "tech,programming" \
--location later
# Output as JSON
reader save https://example.com/article --jsonUpdate a document
# Update title
reader update <document-id> --title "New Title"
# Update multiple fields
reader update <document-id> \
--title "New Title" \
--author "Jane Doe" \
--location archive
# Update tags
reader update <document-id> --tags "new,tags"Delete a document
reader delete <document-id>List tags
reader tags
reader tags --jsonVerify authentication
reader authOptions
Global options
| Option | Description |
|--------|-------------|
| --json | Output results as JSON |
| --help | Show help |
| --version | Show version |
Location values
new- Inboxlater- Read Laterarchive- Archivefeed- Feed
Category values
articleemailrsshighlightnotepdfepubtweetvideo
Development
# Clone the repository
git clone https://github.com/lis186/readwise-reader-cli.git
cd readwise-reader-cli
# Install dependencies
npm install
# Run in development mode
npm run dev -- list
# Run tests
npm test
# Build
npm run buildLicense
MIT
