Documentation Index
Fetch the complete documentation index at: https://docs.getmatter.com/llms.txt
Use this file to discover all available pages before exploring further.
All commands output JSON by default. Add --plain for human-readable output.
Account
matter account # JSON
matter account --plain # Human-readable
Items
List items
matter items list [options]
| Option | Description |
|---|
--status | Filter by status: inbox, queue, archive, all |
--content-type | Filter by type: article, podcast, video, pdf, tweet, email |
--favorite | Only favorited items |
--tag | Filter by tag ID |
--order | Sort order: updated, library_position, inbox_position (position orderings use app ordering, nulls last) |
--updated-since | Filter by updated date (ISO 8601) |
--limit | Results per page (default 25, max 100) |
--cursor | Pagination cursor from previous response |
--all | Fetch all pages |
--plain | Human-readable output |
matter items list --status queue --plain
matter items list --content-type article --favorite --limit 10
matter items list --status archive --all
Get an item
matter items get <id>
matter items get itm_r9f3a --plain
Save a URL
matter items save --url <url> [--status queue|archive]
matter items save --url "https://example.com/article"
matter items save --url "https://example.com/article" --status queue
Update an item
matter items update <id> [options]
| Option | Description |
|---|
--status | Move to queue or archive |
--favorite | Set favorite (true or false) |
--progress | Reading progress (0.0 to 1.0) |
matter items update itm_r9f3a --status archive
matter items update itm_r9f3a --favorite true
Delete an item
Search
matter search <query> --type <type> [options]
| Option | Description |
|---|
--type | (required) Result types, comma-separated (e.g. items) |
--status | Filter items by status: queue, archive. Omit to search all content |
--limit | Results per page (default 25, max 100) |
--cursor | Pagination cursor from previous response |
--all | Fetch all pages |
--plain | Human-readable output |
matter search "machine learning" --type items --plain
matter search "by:graham" --type items --status queue
matter search "\"deep work\"" --type items --all
matter search "site:nytimes climate" --type items --limit 10
Search operators
| Operator | Description | Example |
|---|
"phrase" | Exact phrase match | "deep learning" |
-term | Exclude term | -podcast |
by:name | Filter by author/publisher | by:graham |
site:domain | Filter by domain | site:nytimes.com |
title:word | Match in title only | title:review |
Annotations
List annotations
matter annotations list --item <item_id> [options]
| Option | Description |
|---|
--item | (required) Item ID |
--limit | Results per page (default 25, max 100) |
--cursor | Pagination cursor from previous response |
--all | Fetch all pages |
--plain | Human-readable output |
matter annotations list --item itm_r9f3a --plain
matter annotations list --item itm_r9f3a --all
Get an annotation
matter annotations get <id>
matter annotations get ann_k3m9p
Update an annotation
matter annotations update <id> --note "Updated note"
Delete an annotation
matter annotations delete <id>
matter tags list
matter tags list --plain
Rename a tag
matter tags rename <id> --name "new name"
Delete a tag
Add a tag to an item
matter tags add --item <item_id> --name "tag name"
Remove a tag from an item
matter tags remove --item <item_id> --tag <tag_id>
Auth
Log in
matter login # Opens browser to get token
matter login <token> # Pass token directly
Interactive TUI
matter tui # Launch the interactive terminal UI
matter with no arguments. See Interactive TUI for keyboard shortcuts.
Self-update
The CLI auto-updates in the background. New releases are downloaded while your command runs and applied on the next invocation. To update immediately instead:
matter update # Update now (instead of waiting for next run)
matter version # Show current version
Readonly mode
Enable readonly mode to prevent write operations (save, update, delete):
# Toggle in TUI settings, or edit ~/.config/matter/config.json
