← Back to CLI Utilities
CLI Utilities by @justinburdett

rssaurus

Use the RSSaurus command-line client (Go binary `rssaurus`)

0
Source Code

RSSaurus CLI

Use the installed rssaurus binary on this machine to interact with RSSaurus.

Quick checks (when something fails)

  1. Confirm binary exists:
which rssaurus
rssaurus --version || true
  1. Confirm auth works:
rssaurus auth whoami

Privacy note

  • Do not print (e.g. cat) the RSSaurus CLI config file contents; it can contain API tokens.
  • If auth fails, prefer re-authenticating (rssaurus auth login) or asking the user to paste only non-sensitive details (error output, host, etc.).

Common tasks

List feeds

rssaurus feeds
rssaurus feeds --json

List items

Unread by default:

rssaurus items --limit 20

Filter by feed:

rssaurus items --feed-id 3 --limit 20

Machine-friendly URL output (one per line):

rssaurus items --limit 20 --urls

Cursor paging:

rssaurus items --limit 50 --cursor <cursor>

Open a URL

rssaurus open https://example.com

Mark read/unread

These require item IDs (get them via --json).

rssaurus items --limit 5 --json
rssaurus read <item-id>
rssaurus unread <item-id>

Bulk mark read:

rssaurus mark-read --all
# or
rssaurus mark-read --ids 1,2,3
# optional
rssaurus mark-read --all --feed-id 3

Save / unsave

rssaurus save https://example.com --title "Optional title"

# unsave requires an id (obtain via --json output from the API response or future saved-items listing)
rssaurus unsave <saved-item-id>

Output conventions (privacy)

  • Default human output avoids printing internal DB IDs.
  • Use --json output when IDs are required for scripting or write actions.

References