Skip to content

mxr reading

Generated from mxr reading --help. After editing crates/daemon/src/cli/, update and review the snapshots with scripts/cargo-test -p mxr --test integration cli_help::, then rebuild site/.

Reading: newsletters you chose, as an edition. Read when you like. Newest since your last visit first, the sources you read most on top, and nothing owed: items fade unless you keep them on Later

mxr reading [OPTIONS] [COMMAND]
Subcommand Purpose
edition The edition (the default): since your last visit, earlier this week and fading, with the Later shelf’s count
later The Later shelf, or put items on it and take them off. Later never fades
open Read one item: the issue as reader text, or with –article the article it links to. –article contacts the article’s site (named first) unless a copy is saved
let-go Let go of items in Reading, or of everything in the edition with –all. Preview with –dry-run; mxr undo reverses it
highlight Save a passage from an item as a highlight
note Change the note on a highlight you made, by its id (shown by reading open and in reading export --format json). A blank TEXT clears the note. Preview with –dry-run; mxr undo restores the old note. Highlights made in Marginalia are changed there
unhighlight Remove a highlight you made, by its id. Preview with –dry-run; mxr undo puts it back. Highlights made in Marginalia are removed there
export Every highlight as Markdown (the default) or JSON
sources Every source in Reading, best read first, with its fade window and the evidence for unsubscribing
marginalia Marginalia, a reading app: send an item there to read it with Marginalia’s tools, and read the highlights made there back
senders Reading’s inbox mail grouped by sender, as before the edition
help Print this message or the help of the given subcommand(s)
Flag Description
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Newsletters as an edition: since your last visit, earlier this week and fading, ranked by what you read, with a Later shelf. See Read newsletters as an edition. Items can also be read in Marginalia, which sends each item the first time and reads its highlights back.

Terminal window
mxr reading
mxr reading edition --peek --format json
mxr reading open ITEM --article
mxr reading later --add ITEM
mxr reading let-go --all --dry-run
mxr reading export --markdown
mxr reading marginalia connect --url https://reader.example.com # asks for the token, or reads it from stdin
mxr reading marginalia send ITEM --dry-run
mxr reading marginalia sync

The edition (the default): since your last visit, earlier this week and fading, with the Later shelf’s count

mxr reading edition [OPTIONS]
Flag Description
--peek Look without counting it as a visit, so “since you were last here” doesn’t move on
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Every highlight as Markdown (the default) or JSON

mxr reading export [OPTIONS]
Flag Description
--markdown Markdown, ready for a notes app (the default)
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Save a passage from an item as a highlight

mxr reading highlight [OPTIONS] <ITEM> <QUOTE>
Flag Description
<ITEM>
<QUOTE>
Flag Description
--note <NOTE>
--article Taken from the fetched article rather than the issue
--paragraph <PARAGRAPH> The paragraph (counting from 0) the passage is in, so the highlight marks that one and not the first match
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

The Later shelf, or put items on it and take them off. Later never fades

mxr reading later [OPTIONS]
Flag Description
--add <ITEM> Items to put on Later
--remove <ITEM> Items to take off Later
--dry-run
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Let go of items in Reading, or of everything in the edition with –all. Preview with –dry-run; mxr undo reverses it

mxr reading let-go [OPTIONS] [ITEM]...
Flag Description
[ITEM] …
Flag Description
--all
--dry-run
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Marginalia, a reading app: send an item there to read it with Marginalia’s tools, and read the highlights made there back

mxr reading marginalia [OPTIONS] <COMMAND>
Subcommand Purpose
status Whether Marginalia is connected, where, and how many items were sent
connect Connect Marginalia: its address, and a personal token from its Account page, Connected apps. The token is read from standard input (or asked for), checked with Marginalia, then kept in the secrets file
disconnect Forget Marginalia and remove its token. What was sent stays there
send Send an item to Marginalia, or find it there if it was sent before. A digest link’s article is fetched first when it isn’t saved. –dry-run names what would be sent and where, and contacts nothing
sync Read back the highlights made in Marginalia, on one item or on every item sent there. Highlights made in mxr are never changed
help Print this message or the help of the given subcommand(s)
Flag Description
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Connect Marginalia: its address, and a personal token from its Account page, Connected apps. The token is read from standard input (or asked for), checked with Marginalia, then kept in the secrets file

mxr reading marginalia connect [OPTIONS] --url <URL>
Flag Description
--url <URL> Marginalia’s address, such as https://reader.example.com
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Forget Marginalia and remove its token. What was sent stays there

mxr reading marginalia disconnect [OPTIONS]
Flag Description
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Send an item to Marginalia, or find it there if it was sent before. A digest link’s article is fetched first when it isn’t saved. –dry-run names what would be sent and where, and contacts nothing

mxr reading marginalia send [OPTIONS] <ITEM>
Flag Description
<ITEM>
Flag Description
--dry-run
--open Open it in Marginalia afterwards
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Whether Marginalia is connected, where, and how many items were sent

mxr reading marginalia status [OPTIONS]
Flag Description
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Read back the highlights made in Marginalia, on one item or on every item sent there. Highlights made in mxr are never changed

mxr reading marginalia sync [OPTIONS] [ITEM]
Flag Description
[ITEM]
Flag Description
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Change the note on a highlight you made, by its id (shown by reading open and in reading export --format json). A blank TEXT clears the note. Preview with –dry-run; mxr undo restores the old note. Highlights made in Marginalia are changed there

mxr reading note [OPTIONS] <HIGHLIGHT> <TEXT>
Flag Description
<HIGHLIGHT>
<TEXT>
Flag Description
--dry-run
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Read one item: the issue as reader text, or with –article the article it links to. –article contacts the article’s site (named first) unless a copy is saved

mxr reading open [OPTIONS] <ITEM>
Flag Description
<ITEM>
Flag Description
--article
--refresh Fetch the article again even when a copy is saved
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Reading’s inbox mail grouped by sender, as before the edition

mxr reading senders [OPTIONS]
Flag Description
--sender <SENDER> Only this sender’s bundle
--limit <LIMIT> Bundles to show [default: 50]
--offset <OFFSET> Bundles to skip, for paging [default: 0]
--messages <MESSAGES> Messages listed per bundle; counts always cover the whole bundle [default: 3]
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Every source in Reading, best read first, with its fade window and the evidence for unsubscribing

mxr reading sources [OPTIONS]
Flag Description
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Remove a highlight you made, by its id. Preview with –dry-run; mxr undo puts it back. Highlights made in Marginalia are removed there

mxr reading unhighlight [OPTIONS] <HIGHLIGHT>
Flag Description
<HIGHLIGHT>
Flag Description
--dry-run
--account <ACCOUNT> Limit to one account; the default covers every account
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help