Skip to content
/ spazm Public

Comand-line media list supervised and API client 🖥

Notifications You must be signed in to change notification settings

athy125/spazm

Repository files navigation

Spazm

Spazm is a handy console-based media organiser that keeps track of what you're currently viewing, reading, and playing. It began as a project for my own use, but I've now decided to publish it on GitHub for everyone to enjoy.

Screenshot

ScreenShot

Features

  • Create lists for movies, TV series, video games, and books.
  • Sort the lists by year released, status, or ranking.
  • Rank each entry on a scale of 1 to 6.
  • Create collections of entries.
  • Set each entry as being active, passive, or inactive.
  • Print any list to a plain text file.

Commands

  • /help displays the help file.
  • /quit quits the application.
  • /open <tab> opens a specific tab.
  • /close closes the current tab.
  • /set <config> <value> sets an option to a specified value.
  • /config displays the current configuration.

Key-bindings

  • Ctrl c quits the application.
  • Alt [num] switches to the num-th tab.
  • Enter sends the current command, or toggles the input.
  • 1 switches to the 'passive' view.
  • 2 switches to the 'active' view.
  • 3 switches to the 'inactive' view.
  • 4 switches to the 'all' view.
  • s sorts the entries.
  • D deletes the current entry.
  • e edits the current entry.
  • r toggles ranking.
  • a toggles the current entry's state.
  • [/] changes the rating of the current entry.
  • Left/Right changes the episodes of the current entry.
  • p prints the current view to a file.

Installation

This whole project was done using Golang.

Once Go is installed properly, fetch this repository.

go get github.com/athy125/spazm

Next, move to the repository source of the project and compile the application.

cd $GOPATH/src/github/athy125/spazm
go install

Lastly, you can run Apollo through its binary file.

cd $GOPATH/bin
./spazm

At the first launch, configuration.json and database.json will be created and stored in ~/.config/spazm/.

Development State

Spazm now perfectly meets my requirements. That being said, if anyone desires to contribute to this project, please feel free to contact me for more information or submit a pull request directly.

About

Comand-line media list supervised and API client 🖥

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages