gator

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2025 License: AGPL-3.0 Imports: 17 Imported by: 0

README

Gator

A multi-player command line tool for aggregating RSS feeds and viewing the posts.

Installation

Make sure you have the latest Go toolchain installed as well as a local Postgres database. You can then install gator with:

go install ...

Config

Create a .gatorconfig.json file in your home directory with the following structure:

{
  "db_url": "postgres://username:@localhost:5432/database?sslmode=disable"
}

Replace the values with your database connection string.

Usage

Create a new user:

gator register <name>

Add a feed:

gator addfeed <url>

Start the aggregator:

gator agg 30s

View the posts:

gator browse [limit]

There are a few other commands you'll need as well:

  • gator login <name> - Log in as a user that already exists
  • gator users - List all users
  • gator feeds - List all feeds
  • gator follow <url> - Follow a feed that already exists in the database
  • gator unfollow <url> - Unfollow a feed that already exists in the database

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL