Skip to content

readwiseio/readwise-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

readwise

A command-line interface for Readwise and Reader. Search your highlights, manage your reading list, tag and organize documents — all from the terminal.

Commands are auto-discovered from the Readwise API, so the CLI stays up to date as new features are added.

Install

npm install -g @readwise/cli

Setup

Interactive login (opens browser)

readwise login

Access token login (for scripts/CI)

Get your token from readwise.io/access_token, then:

readwise login-with-token
# prompts for token (hidden input, not stored in shell history)

You can also pipe the token in:

echo "$READWISE_TOKEN" | readwise login-with-token

Credentials are stored in ~/.readwise-cli.json. OAuth tokens refresh automatically.

Commands

Run readwise --help to see all available commands, or readwise <command> --help for details on a specific command.

Search documents

readwise reader-search-documents --query "machine learning"
readwise reader-search-documents --query "react" --category-in article
readwise reader-search-documents --query "notes" --location-in shortlist --limit 5
readwise reader-search-documents --query "physics" --published-date-gt 2024-01-01

Search highlights

readwise readwise-search-highlights --vector-search-term "spaced repetition"

List and inspect documents

readwise reader-list-documents --limit 5
readwise reader-list-documents --category article --location later
readwise reader-list-documents --tag "to-review"
readwise reader-get-document-details --document-id <document-id>
readwise reader-get-document-highlights --document-id <document-id>

Save a document

readwise reader-create-document --url "https://example.com/article"
readwise reader-create-document \
  --url "https://example.com" \
  --title "My Article" \
  --tags "reading-list,research" \
  --notes "Found via HN"

Organize

# Tags
readwise reader-list-tags
readwise reader-add-tags-to-document --document-id <id> --tag-names "important,review"
readwise reader-remove-tags-from-document --document-id <id> --tag-names "old-tag"

# Move between locations (new/later/shortlist/archive)
readwise reader-move-document --document-id <id> --location archive

# Edit metadata
readwise reader-edit-document-metadata --document-id <id> --title "Better Title"
readwise reader-set-document-notes --document-id <id> --notes "Updated notes"

Highlight management

readwise reader-add-tags-to-highlight --document-id <id> --highlight-document-id <id> --tag-names "key-insight"
readwise reader-remove-tags-from-highlight --document-id <id> --highlight-document-id <id> --tag-names "old-tag"
readwise reader-set-highlight-notes --document-id <id> --highlight-document-id <id> --notes "This connects to..."

Export

readwise reader-export-documents
readwise reader-export-documents --since-updated "2024-06-01T00:00:00Z"

Options

Flag Description
--json Output raw JSON (for piping to jq, scripts, etc.)
--refresh Force-refresh the command list from the server
--help Show all commands or command-specific options

Examples

Pipe results to jq:

readwise reader-list-documents --limit 3 --json | jq '.results[].title'

How it works

The CLI connects to the Readwise MCP server internally, auto-discovers available tools, and exposes each one as a CLI command. The tool list is cached locally for 24 hours.

Development

git clone https://github.com/readwise/readwise-cli && cd readwise-cli
npm install
npm run build

# Run without building
npx tsx src/index.ts --help

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •