Readwise CLI

Use the

readwise

command to access the user's Readwise highlights and Reader documents. Readwise has two products:

Readwise — highlights from books, articles, podcasts, and more. Includes daily review and spaced repetition.
Reader — a read-later app for saving and reading articles, PDFs, EPUBs, RSS feeds, emails, tweets, and videos.

使用

readwise

命令访问用户的Readwise高亮内容和Reader文档。Readwise包含两款产品：

Readwise — 来自书籍、文章、播客等内容的高亮标记。包含每日复习和间隔重复功能。
Reader — 一款稍后阅读应用，用于保存和阅读文章、PDF、EPUB、RSS订阅、邮件、推文和视频。

Setup

安装配置

If

readwise

is not installed:

bash

npm install -g @readwise/cli

If not authenticated, ask the user for their Readwise access token (they can get one at https://readwise.io/access_token), then run:

bash

readwise login-with-token <token>

如果未安装

readwise

：

bash

npm install -g @readwise/cli

如果未完成认证，请向用户索要其Readwise访问令牌（可在https://readwise.io/access_token获取），然后运行：

bash

readwise login-with-token <token>

Discovering Commands

命令探索

Every command supports

--help

for full option details:

bash

readwise --help
readwise reader-search-documents --help
readwise readwise-list-highlights --help

Add

--json

to any command for machine-readable output. Use

--refresh

to force-refresh cached data.

所有命令都支持

--help

参数以查看完整选项详情：

bash

readwise --help
readwise reader-search-documents --help
readwise readwise-list-highlights --help

在任意命令后添加

--json

参数可获取机器可读格式的输出。使用

--refresh

参数可强制刷新缓存数据。

Reader Commands

Reader 命令

Searching documents

搜索文档

bash

undefined

bash

undefined

Semantic search across all saved documents

readwise reader-search-documents --query "spaced repetition"

Search only articles saved for later

readwise reader-search-documents --query "machine learning" --category-in article --location-in later,shortlist

Search by author within the inbox

readwise reader-search-documents --query "AI" --author-search "Simon Willison" --location-in new

Search documents published after a date

readwise reader-search-documents --query "transformers" --published-date-gt 2024-01-01

undefined

readwise reader-search-documents --query "transformers" --published-date-gt 2024-01-01

undefined

Browsing documents

浏览文档

bash

undefined

bash

undefined

List 10 most recent inbox items (minimal fields to save tokens)

readwise reader-list-documents --location new --limit 10 --response-fields title,author,summary,word_count,category,saved_at

List archived articles tagged "research"

readwise reader-list-documents --location archive --tag research --category article

List unseen documents in the inbox

readwise reader-list-documents --location new --seen false

List RSS feed items

readwise reader-list-documents --location feed --limit 20 --response-fields title,author,summary,site_name

Get a specific document by ID

readwise reader-list-documents --id <document_id>


Locations: `new` (inbox), `later`, `shortlist`, `archive`, `feed`. When the user says "inbox", use `new`.

readwise reader-list-documents --id <document_id>


位置选项：`new`（收件箱）、`later`、`shortlist`、`archive`、`feed`。当用户提到“收件箱”时，使用`new`参数。

Reading and highlighting

阅读与高亮标记

bash

undefined

bash

undefined

Get full document content as Markdown

readwise reader-get-document-details --document-id <id>

Get all highlights on a document

readwise reader-get-document-highlights --document-id <id>

Highlight a passage (html-content must match the document's HTML exactly)

Get the HTML first via reader-list-documents with --response-fields html_content

readwise reader-create-highlight --document-id <id> --html-content "The exact passage to highlight"

Highlight with a note and tags

readwise reader-create-highlight --document-id <id> --html-content "Key insight" --note "Connects to spaced repetition research" --tags review,concept

undefined

readwise reader-create-highlight --document-id <id> --html-content "Key insight" --note "Connects to spaced repetition research" --tags review,concept

undefined

Saving documents

保存文档

bash

undefined

bash

undefined

Save a URL — Reader scrapes it automatically

readwise reader-create-document --url "https://example.com/article"

Save with metadata

readwise reader-create-document --url "https://example.com" --title "Great Article" --tags research,ai --notes "Recommended by Alice"

Save raw Markdown content (provide a unique URL as identifier)

readwise reader-create-document --title "Meeting Notes" --markdown "# Notes from today..." --url "https://me.com#notes-march-2025"

undefined

readwise reader-create-document --title "Meeting Notes" --markdown "# Notes from today..." --url "https://me.com#notes-march-2025"

undefined

Organizing

文档整理

bash

undefined

bash

undefined

Move documents between locations (max 50 per call)

readwise reader-move-documents --document-ids <id1>,<id2> --location archive readwise reader-move-documents --document-ids <id> --location later

Bulk mark documents as seen

readwise reader-bulk-edit-document-metadata --documents '[{"document_id": "<id>", "seen": true}]'

Bulk update metadata (title, author, tags, summary, etc.)

readwise reader-bulk-edit-document-metadata --documents '[{"document_id": "<id>", "title": "Better Title", "tags": ["ai", "research"]}]'

Highlight tags and notes

readwise reader-add-tags-to-highlight --document-id <id> --highlight-document-id <hid> --tag-names concept readwise reader-remove-tags-from-highlight --document-id <id> --highlight-document-id <hid> --tag-names old-tag readwise reader-set-highlight-notes --document-id <id> --highlight-document-id <hid> --notes "Updated note"

undefined

readwise reader-add-tags-to-highlight --document-id <id> --highlight-document-id <hid> --tag-names concept readwise reader-remove-tags-from-highlight --document-id <id> --highlight-document-id <hid> --tag-names old-tag readwise reader-set-highlight-notes --document-id <id> --highlight-document-id <hid> --notes "Updated note"

undefined

Exporting

导出文档

bash

undefined

bash

undefined

Export all documents as a ZIP of Markdown files (async)

readwise reader-export-documents readwise reader-get-export-documents-status --export-id <id>

Delta export — only docs updated since last export

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

undefined

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

undefined

Readwise Commands

Readwise 命令

Searching highlights

搜索高亮内容

bash

undefined

bash

undefined

Semantic search across all highlights

readwise readwise-search-highlights --vector-search-term "learning techniques"

Search with full-text filter on a specific field

readwise readwise-search-highlights --vector-search-term "memory" --full-text-queries '[{"field_name": "document_title", "search_term": "psychology"}]'


Full-text query fields: `document_author`, `document_title`, `highlight_note`, `highlight_plaintext`, `highlight_tags`.

readwise readwise-search-highlights --vector-search-term "memory" --full-text-queries '[{"field_name": "document_title", "search_term": "psychology"}]'


全文检索支持的字段：`document_author`、`document_title`、`highlight_note`、`highlight_plaintext`、`highlight_tags`。

Browsing highlights

浏览高亮内容

bash

undefined

bash

undefined

List 20 most recent highlights

readwise readwise-list-highlights --page-size 20

Highlights from a specific book

readwise readwise-list-highlights --book-id <id>

Highlights from the last month

readwise readwise-list-highlights --highlighted-at-gt "2025-02-01T00:00:00Z"

undefined

readwise readwise-list-highlights --highlighted-at-gt "2025-02-01T00:00:00Z"

undefined

Creating and editing highlights

创建与编辑高亮内容

bash

undefined

bash

undefined

Create a highlight (matched to a book by title/author, or goes into "Quotes")

readwise readwise-create-highlights --highlights '[{"text": "The key insight here", "title": "Book Title", "author": "Author Name"}]'

Create multiple highlights at once

readwise readwise-create-highlights --highlights '[{"text": "First quote", "title": "Book A"}, {"text": "Second quote", "title": "Book B"}]'

Update a highlight — text, note, color, tags

readwise readwise-update-highlight --highlight-id <id> --note "New note" --add-tags concept,review --color blue

Delete a highlight

readwise readwise-delete-highlight --highlight-id <id>


Colors: `yellow`, `blue`, `pink`, `orange`, `green`, `purple`.

readwise readwise-delete-highlight --highlight-id <id>


颜色选项：`yellow`、`blue`、`pink`、`orange`、`green`、`purple`。

Daily review

每日复习

bash

undefined

bash

undefined

Get today's spaced repetition review

readwise readwise-get-daily-review


Returns highlights selected by the spaced repetition algorithm plus a URL for interactive review.

readwise readwise-get-daily-review


返回由间隔重复算法筛选出的高亮内容，以及一个用于交互式复习的URL。

Example Workflows

示例工作流

Triage the inbox: List recent saves, read each one, decide what's worth the user's time.

bash

readwise reader-list-documents --location new --limit 10 --response-fields title,author,summary,word_count,category,saved_at
readwise reader-get-document-details --document-id <id>
readwise reader-move-documents --document-ids <id> --location later    # worth reading
readwise reader-move-documents --document-ids <id> --location archive  # skip

Search across everything: Find all content on a topic across both highlights and documents.

bash

readwise reader-search-documents --query "spaced repetition"
readwise readwise-search-highlights --vector-search-term "spaced repetition"

Quiz on a recent read: Find a finished document, get its content and highlights, quiz the user.

bash

readwise reader-list-documents --location archive --limit 10 --response-fields title,author,summary,word_count
readwise reader-get-document-details --document-id <id>
readwise reader-get-document-highlights --document-id <id>

Catch up on RSS: Browse feed items, surface the best ones, mark the rest as seen.

bash

readwise reader-list-documents --location feed --limit 20 --response-fields title,author,summary,word_count,site_name
readwise reader-bulk-edit-document-metadata --documents '[{"document_id": "<id>", "seen": true}]'
readwise reader-move-documents --document-ids <id> --location later

Save and annotate: Save a URL, highlight key passages, tag and organize.

bash

readwise reader-create-document --url "https://example.com/article" --tags research
readwise reader-create-highlight --document-id <id> --html-content "<p>Key passage here</p>" --note "This connects to..."
readwise reader-add-tags-to-document --document-id <id> --tag-names important

Build a reading recap: See what you've finished and highlighted recently.

bash

readwise reader-list-documents --location archive --updated-after "2025-03-10T00:00:00Z" --response-fields title,author,word_count,reading_progress
readwise reader-get-document-highlights --document-id <id>
readwise readwise-list-highlights --highlighted-at-gt "2025-03-10T00:00:00Z" --page-size 50

收件箱分类整理：列出最近保存的内容，逐一阅读，判断是否值得花费时间。

bash

readwise reader-list-documents --location new --limit 10 --response-fields title,author,summary,word_count,category,saved_at
readwise reader-get-document-details --document-id <id>
readwise reader-move-documents --document-ids <id> --location later    # 值得阅读
readwise reader-move-documents --document-ids <id> --location archive  # 跳过

全内容搜索：跨高亮内容和文档查找特定主题的所有内容。

bash

readwise reader-search-documents --query "spaced repetition"
readwise readwise-search-highlights --vector-search-term "spaced repetition"

针对已读内容的测验：找到已完成阅读的文档，获取其内容和高亮标记，对用户进行测验。

bash

readwise reader-list-documents --location archive --limit 10 --response-fields title,author,summary,word_count
readwise reader-get-document-details --document-id <id>
readwise reader-get-document-highlights --document-id <id>

RSS订阅跟进：浏览订阅内容，筛选优质内容，标记其余内容为已读。

bash

readwise reader-list-documents --location feed --limit 20 --response-fields title,author,summary,word_count,site_name
readwise reader-bulk-edit-document-metadata --documents '[{"document_id": "<id>", "seen": true}]'
readwise reader-move-documents --document-ids <id> --location later

保存与注释：保存URL，标记关键段落，添加标签并整理。

bash

readwise reader-create-document --url "https://example.com/article" --tags research
readwise reader-create-highlight --document-id <id> --html-content "<p>Key passage here</p>" --note "This connects to..."
readwise reader-add-tags-to-document --document-id <id> --tag-names important

阅读回顾总结：查看近期已完成阅读和标记高亮的内容。

bash

readwise reader-list-documents --location archive --updated-after "2025-03-10T00:00:00Z" --response-fields title,author,word_count,reading_progress
readwise reader-get-document-highlights --document-id <id>
readwise readwise-list-highlights --highlighted-at-gt "2025-03-10T00:00:00Z" --page-size 50

readwise-cli

Original

Translation

Readwise CLI

Readwise CLI

Setup

安装配置

Discovering Commands

命令探索

Reader Commands

Reader 命令

Searching documents

搜索文档

Semantic search across all saved documents

Semantic search across all saved documents

Search only articles saved for later

Search only articles saved for later

Search by author within the inbox

Search by author within the inbox

Search documents published after a date

Search documents published after a date

Browsing documents

浏览文档

List 10 most recent inbox items (minimal fields to save tokens)

List 10 most recent inbox items (minimal fields to save tokens)

List archived articles tagged "research"

List archived articles tagged "research"

List unseen documents in the inbox

List unseen documents in the inbox

List RSS feed items

List RSS feed items

Get a specific document by ID

Get a specific document by ID

Reading and highlighting

阅读与高亮标记

Get full document content as Markdown

Get full document content as Markdown

Get all highlights on a document

Get all highlights on a document

Highlight a passage (html-content must match the document's HTML exactly)

Highlight a passage (html-content must match the document's HTML exactly)

Get the HTML first via reader-list-documents with --response-fields html_content

Get the HTML first via reader-list-documents with --response-fields html_content

Highlight with a note and tags

Highlight with a note and tags

Saving documents

保存文档

Save a URL — Reader scrapes it automatically

Save a URL — Reader scrapes it automatically

Save with metadata

Save with metadata

Save raw Markdown content (provide a unique URL as identifier)

Save raw Markdown content (provide a unique URL as identifier)

Organizing

文档整理

Move documents between locations (max 50 per call)

Move documents between locations (max 50 per call)

Bulk mark documents as seen

Bulk mark documents as seen

Bulk update metadata (title, author, tags, summary, etc.)

Bulk update metadata (title, author, tags, summary, etc.)

Tags

Tags

Highlight tags and notes

Highlight tags and notes

Exporting

导出文档

Export all documents as a ZIP of Markdown files (async)

Export all documents as a ZIP of Markdown files (async)

Delta export — only docs updated since last export

Delta export — only docs updated since last export

Readwise Commands

Readwise 命令

Searching highlights

搜索高亮内容

Semantic search across all highlights

Semantic search across all highlights

Search with full-text filter on a specific field

Search with full-text filter on a specific field

Browsing highlights