|
1 | | -# chibi-cli |
2 | | -Chibi for AniList - A lightweight anime & manga tracker CLI app powered by AniList. |
| 1 | +<div align="center"> |
| 2 | +<h1>Chibi for AniList</h1> |
| 3 | +<h2>A lightweight anime & manga tracker CLI app powered by AniList</h2> |
| 4 | + |
| 5 | +[](https://www.gnu.org/licenses/gpl-3.0) |
| 6 | + |
| 7 | +[](https://github.com/CosmicPredator/chibi-cli/actions/workflows/build.yml) |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +</div> |
| 12 | + |
| 13 | +## Features |
| 14 | +- 😊 Easily manage your anime and manga lists without even opening your browser. |
| 15 | +- 🪶 Lightweight and easy on your keyboard. |
| 16 | +- 🌈 Colorful and structured outputs. |
| 17 | +- 🗔 Supports most terminals and shells. |
| 18 | +- 🔄 Changes are synced directly with AniList. No local saving BS. |
| 19 | +- 🚀 Faster by design. |
| 20 | + |
| 21 | +## Getting Started |
| 22 | +This section provides the quickest way to get started with chibi-cli. For detailed tutorial, refer to [Documentation](#documentation) |
| 23 | + |
| 24 | +### Optional Pre-Requisites |
| 25 | +- Make sure you use any one of the [Nerd Fonts](https://www.nerdfonts.com/) for a proper output. |
| 26 | +- Make sure your terminal supports 24 bit ANSI color profile. |
| 27 | +- Most modern terminals like **Windows Terminal**, **Gnome Terminal**, **Kitty** or **Alacritty** etc., should work. |
| 28 | + |
| 29 | +### Quick Installation |
| 30 | +- Download the binary for your OS from the [releases](https://github.com/CosmicPredator/chibi-cli/releases) page. |
| 31 | + |
| 32 | +- Open your favourite terminal in the directory where you downloaded chibi. |
| 33 | + |
| 34 | +- Type in `./chibi` and you are in! |
| 35 | + |
| 36 | + > [!NOTE] |
| 37 | + > For windows, you may type `./chibi.exe` (in powershell). |
| 38 | +
|
| 39 | + > [!NOTE] |
| 40 | + > For linux, make the binary executable by the following command, |
| 41 | + > ```sh |
| 42 | + > $ chmod +x ./chibi |
| 43 | + > ``` |
| 44 | +
|
| 45 | +## Documentation |
| 46 | +WIP 😁 |
| 47 | +
|
| 48 | +## Special Thanks |
| 49 | +This project is not possible without the following libraries, |
| 50 | +
|
| 51 | +- AniList - [Website](https://anilist.co) |
| 52 | +- spf13/cobra - [GitHub](https://github.com/spf13/cobra) |
| 53 | +- charmbracelet/huh - [GitHub](https://github.com/charmbracelet/huh) |
| 54 | +- charmbracelet/lipgloss - [GitHub](https://github.com/charmbracelet/lipgloss) |
0 commit comments