/anime-archive

🦋 A command line interface to create, find and list all my viewed animes.

Primary LanguageGoGNU General Public License v3.0GPL-3.0

Anime Archive

🦋 A command line interface to create, find and list all my viewed animes. 🦋

GitHub top language GitHub all releases GitHub last commit GitHub LICENSE

Features

Why would you use Anime Archive instead of a notepad? Here's why:

  • A simple interface, you will easily figure out how to use it.
  • It's blazingly fast because it doesn't have any server calls. It registers stuff in a file-based database (SQLite).
  • It's also lightweight because of the database choice.

And the most important one, if you are a command line enjoyer, then I probably gotcha :).

Need some help? See the usage section or run anime-archive or anime-archive --help

⬇️ How to install and use it

  1. Install the executable at releases
  2. Add the Anime Archive binary to the PATH
# Inside the folder where you have installed Anime Archive...

# Windows (powershell)
$pwd=pwd
$env:PATH="$env:PATH;$pwd" # One line: $pwd=pwd;$env:PATH="$env:PATH;$pwd"

# Linux
export PATH="$PATH:$(pwd)"

🤹‍♂️ Usage

  • To register an anime, use register "ANIME TITLE" "ANIME URL".
    • --description (-d) string assign an description about the anime.
  • To search for an anime, use search "ANIME TITLE".
  • To update an anime detail, use update "ANIME TITLE".
    • --description (-d) string update the anime's description.
  • To list all the stored animes, use list [--tail uint or --head uint].
    • --head (-H) uint query some of the newest records.
    • --tail (-T) uint query some of the oldest records.
  • To list alternative sites to watch anime (:brazil:), use status.
  • To export the database to a human readable format, use export [--json or --csv].
    • --json (-j) export the database in JSON format.
    • --csv (-c) export the database in CSV format.

🦄 Technical Stuff

If you want to learn more about the project and maybe help me to improve it, see the ONBOARDING.

📜 History

I used to write the animes that i watch right in a plain text file. Therefore, i created Anime Archive to facilitate the process of opening file explorer, searching for the file where i used to write those animes that i watched, write a anime with its url and maybe upload it to Google Drive, just for backup. I decided to use Golang because it's a fast, compiled and a reliable programming language with garbage collector, concurrency and a robust built-in library, also because i am learning it. See my Python attempt of it, anime-list.

📝 License

This project is licensed under the GPL-3.0 License - See the LICENSE for more information.