https://github.com/kauefraga/anime-archive

🦋 A command line interface to create, find and list all my viewed animes.
https://github.com/kauefraga/anime-archive

anime anime-list animedatabase archive cli golang localstorage sqlite watchlist

Last synced: 9 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/kauefraga/anime-archive
• Owner: kauefraga
• License: gpl-3.0
• Created: 2023-08-10T20:45:40.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-13T17:11:56.000Z (10 months ago)
• Last Synced: 2024-06-21T17:04:03.985Z (6 months ago)
• Topics: anime, anime-list, animedatabase, archive, cli, golang, localstorage, sqlite, watchlist
• Language: Go
• Homepage:
• Size: 205 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
Anime Archive


  


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

  


  


    

    

    

      

    

    

  



### Features

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

- [x] A simple interface, you will easily figure out how to use it.

- [x] It's blazingly fast because it doesn't have any server calls. It registers stuff in a file-based database (SQLite).

- [x] 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](https://github.com/kauefraga/anime-archive/releases)

2. Add the Anime Archive binary to the PATH

```bash

# 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](ONBOARDING.md).

## 📜 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](https://github.com/kauefraga/anime-list-python).

## 📝 License

This project is licensed under the GPL-3.0 License - See the [LICENSE](https://github.com/kauefraga/anime-archive/blob/main/LICENSE) for more information.