Gator

A simple cli tool that aggregates rss feeds and displays the title and description.

You'll need to have go and postgres installed.

With postgres installed you'll now need to create a database. To do this, you can use something like PGadmin or use the psql client. I used the psql client because it's easy to interact with from the command line.

psql postgres

You should see a new prompt that looks like this:

postgres=#

From here create a new database with whatever name you want - I chose gator.

CREATE DATABASE <database_name>

If successful you should be able to connect to the database:

\c <database_name>

If your prompt now looks like this <database_name>=# you should be good to go. You can quit psql with \q to bring you back to your terminal prompt.

To set up the config file for database and current user, create a json file named .gatorconfig.json to your root directory touch ~/.gatorconfig.json. Open the new file with your text editor. I used nvim:

nvim ~/.gatorconfig.json

Below is the json needed for the config file. Replace <username> with your local username and <database_name> with the name you chose for your database. If you're not sure what your username is, whoami in the terminal will give you your logged in username. Leave current_user_name as an empty string. This will be replaced once you register and login a new user.

{ "db_url": "postgres://<username>:@localhost:5432/<database_name>?sslmode=disable", "current_user_name": "" }

Save the file and now all that's left to do is install gator:

go install github.com/KarlHavoc/gator@latest

You'll use the command gator followed by any of the gator commands and arguments.

Gator Commands

Command list

command <arguments> - Description

register <username> - Registers a new user with the username

login <username> - Logs in with the username

users - Prints all users to the console

addfeed <feedname> <feedURL> - Adds a new feed with a feed name and url

feeds - Prints all feeds and the user that created them to the console

follow <url_to_follow> - Follows a feed for the current user

unfollow <url_to_unfollow> - Unfollows a feed for the current user

following - Displays the feeds the current user is following

browse <number_of_feeds_to_display> - Prints the title and description of the latest feeds to the console. If left blank, the number of feeds to display argument defaults to 2.

agg <time.Duration> - Aggregates the feeds the current user is following every time.Duration, i.e. the command - agg 1m - would result in fetching the latest feeds once every minute. %s - seconds, %m - minutes, %h - hours