Skip to content

Latest commit

 

History

History
54 lines (44 loc) · 2.6 KB

README.md

File metadata and controls

54 lines (44 loc) · 2.6 KB
Raw

Kurapika GIF

Ani-CLI

This is a command-line interface (CLI) application for anime enthusiasts that allows users to explore anime suggestions, information, episodes, and streaming options. The application interacts with the AniWatch API to fetch the necessary data.

Prerequisites

Before using this application, ensure that you have the AniWatch API running locally. This API is required for the application to function correctly.

Installation

  1. Clone the repository:
git clone https://github.com/KonyD/ani-cli.git
cd anime-cli
  1. Install the required dependencies:
npm install

Commands

  1. Get anime suggestions:
node index.js suggest <query>

This command retrieves a list of suggested anime based on the provided search query. The application will display a numbered list of suggestions, including the name and ID of each anime.

  1. Get anime information:
node index.js info <id>

This command fetches detailed information about a specific anime using its ID. It provides details such as the name, MyAnimeList ID, AniList ID, rating, quality, and description of the anime.

  1. Search by genre:
node index.js search-by-genre <genre> [page]

This command allows you to search for anime based on a specified genre. You can also specify a page number for pagination. If no page number is provided, the default is page 1. The application will return a list of anime titles belonging to the specified genre.

  1. Search and watch anime:
node index.js search <query> [page]

This command performs a search for anime using the provided query. Similar to the genre search, you can specify a page number for pagination. The application will display a list of anime that match the search criteria. Once you have selected an anime and its corresponding episode, the application will prompt you to choose between dubbed or subbed versions. You will also select a streaming server from the available options. The application will then generate an HTML video player to watch the selected episode.

How to use

  1. Start the AniWatch API.
  2. Run the desired command in your terminal.
  3. Follow the prompts to interact with the application.

Contributing

Contributions are welcome! If you have suggestions or improvements, please feel free to submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.