This repository provides a command-line interface (CLI) for interacting with Readwise's Reader API. This tool allows you to interact with the API directly from your command line, making it easy to add and list documents from your Reader library.
Also, you can upload documents from your browser reading list, such as Chrome ReadingList.
Please note that future updates will include support for additional browsers.
The easiest way to get started is with uv:
uv tool install git+https://github.com/Scarvy/readwise-reader-cli Then run:
rw-cli --help Alternatively, can run:
uvx --from 'git+https://github.com/Scarvy/readwise-reader-cli' rw-cli --help This will invoke the tool without installing it.
Before using the CLI, make sure to set the READER_API_TOKEN environment variable. You can obtain your API token here.
export READER_API_TOKEN={your_api_token} The CLI provides the following commands:
Usage: uv run rw-cli [OPTIONS] COMMAND [ARGS]... Interact with your Reader Library Options: --help Show this message and exit. Commands: add Add Document lib Library breakdown list List Documents upload Upload Reading List File validate Validate tokenUsage: uv run rw-cli list [OPTIONS] List Documents Options: -l, --location [new|archive|later|feed] Document(s) location -c, --category [article|tweet|pdf|epub|email|note|video|highlight|rss] Document(s) category -a, --update-after [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S] Updated after date in ISO format. Default: last 24hrs. -d, --date-range TEXT View documents updated after choosen time: today, week, month. -L, --layout [table|list] Display documents either as a list or table. Default: table. -n, --num-results INTEGER The number of documents to show. -P, --pager Use to page output. --help Show this message and exit.Examples:
See all documents located in archive:
rw-cli list --location archive See all articles located in archive:
rw-cli list --location archive --category article See all articles located in archive after Jan 1st, 2023
rw-cli list --location archive --category article --update-after 2023-01-01 Same as above, but in a list format
rw-cli list --location archive --category article --update-after 2023-01-01 --layout list Can provide a date range like 'week' or 'month'
rw-cli list --location archive --category article --date-range week 
THINGS TO NOTE:
RATE LIMIT - Due to Reader's API rate limit of 20 requests per minute, a larger list will take a few minutes to upload.
LACK OF READING LIST APIs - There is no API to pull your ReadingList from Google, but it is being looked at here.
To upload your Chrome Reading List, you first need to download your data from your account, then follow these steps:
- Navigate to the Data & Privacy section.
- Find the "Download your data" option and click on it.
- A list of data to export will appear. Click "Deselect all" and then locate the Chrome section.
- Click "All Chrome data Included" and select ONLY "ReadingList".
- Save the downloaded
.htmlfile to your preferred directory and take note of the file path. - Run the
importcommand.
Usage: python -m readercli upload [OPTIONS] INPUT_FILE Upload Reading List File Options: --file-type [html|csv] --help Show this message and exit.Examples:
rw-cli upload /path/to/ReadingList.htmlrw-cli upload --file-type csv /path/to/ReadingList.csvUsage: rw-cli add [OPTIONS] URL Add Document Options: --help Show this message and exit.Example:
rw-cli add http://www.example.comUsage: rw-cli lib [OPTIONS] Library breakdown Options: -V, --view [category|location|tags] --help Show this message and exit.Check library counts:
rw-cli lib Category Breakdown โโโโโโโโโโโโโโโณโโโโโโโโ โ Name โ Count โ โกโโโโโโโโโโโโโโโโโโโโโโฉ โ ๐๏ธ highlightโ 724 โ โ ๐ก๏ธ rss โ 391 โ โ โ๏ธ email โ 363 โ โ ๐ฐ๏ธ article โ 264 โ โ ๐๏ธ note โ 140 โ โ ๐๏ธ pdf โ 83 โ โ ๐ฆ๏ธ tweet โ 25 โ โ ๐น๏ธ video โ 10 โ โ ๐๏ธ epub โ 0 โ โโโโโโโโโโโโโโโดโโโโโโโโ python -m readercli lib --view [location | tags] Location Breakdown โโโโโโโโโโโโโณโโโโโโโโ โ Name โ Count โ โกโโโโโโโโโโโโโโโโโโโโฉ โ ๐๏ธ archiveโ 1124 โ โ ๐๏ธ later โ 241 โ โ โญ๏ธ new โ 10 โ โ ๐ฅ๏ธ feed โ 2 โ โโโโโโโโโโโโโดโโโโโโโโ rw-cli lib --view tags Tags Breakdown โโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโ โ Name โ Count โ โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ โ python โ 32 โ โ documentation โ 9 โ โ programming โ 7 โ โ github โ 7 โ โ git โ 6 โ โ packages โ 6 โ โ design-patterns โ 6 โ โ mac โ 1 โ โโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโUsage: rw-cli validate [OPTIONS] TOKEN Validate token Options: --help Show this message and exit.This project is licensed under the MIT License - see the LICENSE file for details.