Skip to content

A commandline app for searching about animes, its seasons, number of seasons and airing status.

License

Notifications You must be signed in to change notification settings

genzyy/anime-cli

Repository files navigation

anime-cli

image

npm GitHub npm maintained?

What its about

The anime-cli is a commandline app created using javascript modules and an external api which can be found here. The anime-cli app gives you information about the number of episodes of the anime, if its completed or not and tells you all its movies. You can also visit the npm site for this cli app here.

PS: You can check out my other similar project written in rust here: https://github.com/genzyy/anime_rs

How to install the commandline app

As the app is a npm package you first need to install NodeJS and NPM as these are the requirements for this app. Now since to make this an app or to be more clear, to be able to run this app from any directory iin the terminal/cmd, you need to install this npm package globally. To install a npm package globally you need to have root priviledges and include global flag during the installation of any npm package. To install this commandline app:
If you are using mac or linux:

  sudo npm install -g @genzyy/anime-cli

Or

  sudo yarn global add @genzyy/anime-cli

Or if you are using windows:

  npm install -g @genzyy/anime-cli

Usage

Now that you have installed the app, you can run anime-cli in your terminal or cmd and it will show you recent animes and their episodes and airing status. To get data about a specific anime or about its seasons and movies, run:

  anime-cli <anime-name>

For example:

  anime-cli Naruto

The keyword that you have used to search about the anime, if that keyword matches to any title in the result array them that anime will be highlighted in green color so that it shows that this anime is probably connected to the anime keyword that you have used to search about.

Configuration and contributing

Check out the official wiki.

Docker Commands to build

  • Build:
      docker build -t animecli .
  • Run:
      docker run --rm animecli
  • Run (with command):
      docker run --rm animecli node index.js

Some Useful Notes

The cli app is currently in development and is only mantained by me and so the development will be a little slow as I have to do my college work also. Sorry for that! But dont worry, I will keep adding new features and argument passing features for a more accurate data fetching. Also, I request you while using the cli app try to pass the exact name of the anime for example pass Boku No Hero instead of boku no hero so as to get the highlighting of the animes which contain the exact names that you have passed in the arguments.