Command-Line Interface

reddit-topics-aggregator

Reddit Topics Aggregator is a tool used to aggregate hot, new, top, and rising topics from multiple Subreddits.

reddit-topics-aggregator [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

connect

Connect to Reddit and retrieve username, user id, and Karma about the authenticated user.

reddit-topics-aggregator connect [OPTIONS]

Options

--client-id <client_id>

Reddit API client ID

--client-secret <client_secret>

Reddit API client secret

--username <username>

Reddit username

--password <password>

Reddit password

--user-agent <user_agent>

Custom user agent

Environment variables

REDDIT_CLIENT_ID

Provide a default for --client-id

REDDIT_CLIENT_SECRET

Provide a default for --client-secret

REDDIT_USERNAME

Provide a default for --username

REDDIT_PASSWORD

Provide a default for --password

REDDIT_USER_AGENT

Provide a default for --user-agent

topics

Retrieve Subreddit topic submissions (hottest, newest, top, rising).

reddit-topics-aggregator topics [OPTIONS]

Options

--client-id <client_id>

Reddit API client ID

--client-secret <client_secret>

Reddit API client secret

--username <username>

Reddit username

--password <password>

Reddit password

--user-agent <user_agent>

Custom user agent

-s, --subreddit <subreddit>

Required The name of the Subreddits to query. Must be specified without the “r/”. e.g. programming or programminghumor

--top <top>

Number of top submissions to retrieve from the subreddits

Default:

10

--new <new>

Number of newest submissions to retrieve from the subreddits

Default:

10

--hot <hot>

Number of hottest submissions to retrieve from the subreddits

Default:

10

--rising <rising>

Number of submissions rising in popularity to retrieve from the subreddits

Default:

10

Environment variables

REDDIT_CLIENT_ID

Provide a default for --client-id

REDDIT_CLIENT_SECRET

Provide a default for --client-secret

REDDIT_USERNAME

Provide a default for --username

REDDIT_PASSWORD

Provide a default for --password

REDDIT_USER_AGENT

Provide a default for --user-agent