github.com/rssaurus/rssaurus-cli

rssaurus-cli

A command-line client for RSSaurus.

Install

Homebrew (recommended)

brew tap RSSaurus/tap
brew install rssaurus

# later
brew upgrade rssaurus

Quick install (macOS / Linux)

curl -fsSL https://raw.githubusercontent.com/RSSaurus/rssaurus-cli/main/install.sh | bash

Installs rssaurus into /usr/local/bin (uses sudo if needed).

Manual install

Download a binary from GitHub Releases: https://github.com/RSSaurus/rssaurus-cli/releases

Quick start

• Create an API token: https://rssaurus.com/api_tokens/new
• Login:

rssaurus auth login

• Verify:

rssaurus auth whoami

Configuration

For v1 we keep a single host/token.

• Default host: https://rssaurus.com
• Override host via RSSAURUS_HOST or --host
• Provide token via RSSAURUS_TOKEN or store it locally via rssaurus auth login

Config file location:

• $XDG_CONFIG_HOME/rssaurus/config.json (if set)
• otherwise ~/.config/rssaurus/config.json

Commands

• rssaurus auth login
• rssaurus auth whoami
• rssaurus feeds (default output does not include DB IDs)
• rssaurus items (unread by default; supports --feed-id, --status, --limit, --cursor, --urls)
• rssaurus open <url>
• rssaurus read <item-id> / rssaurus unread <item-id>
• rssaurus mark-read --all (or --ids 1,2,3, --url <url>, --urls <u1,u2>, optional --feed-id)
• rssaurus save <url> / rssaurus unsave <saved-item-id>

Notes:

• Use --json output when you need IDs for scripting.
• When using the --urls flag, items prints only URLs (one per line) for easy piping.

Install locally (dev)

# Installs a `rssaurus` binary into ~/go/bin

go install ./cmd/rssaurus

# Ensure ~/go/bin is in PATH
export PATH="$PATH:$HOME/go/bin"

rssaurus --help

Development

go test ./...