GithubHelp home page GithubHelp logo

mybigman / anime-cli Goto Github PK

View Code? Open in Web Editor NEW

This project forked from genzyy/anime-cli

0.0 0.0 0.0 561 KB

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

License: MIT License

JavaScript 100.00%

anime-cli's Introduction

anime-cli

image

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.

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 if you are using windows:

  npm install -g @genzyy/anime-cli

Change Log

v1.3.1

  • Thanks to @atul-g for creating a much better help section and adding a version check command.
  • Added a config file which is used for setting limit for the results and to show only the matched results.
  • The config file in Linux/MacOS gets stored at ./config/configstore/@genzyy/anime-cli.json and generally gets stored at $CONFIG/package-name/config.json.
  • An example config would be like
  {
	"setLimit": false,
	"limit": 10,
	"onlyMatches": false
}
  • To set a limit on the data fetched run anime-cli setLimit true <number-results-to-show>.
  • To unset the limit run anime-cli setLimit false.
  • You can also fetch only the titles which match to your query, for this run anime-cli onlyMatches true or to unset it run anime-cli onlyMatches false.
  • Also instead of running these commands, you can manually edit the config file and change accordingly.

v1.1.2

  • Fixed a bug where it threw an error when only anime-cli was run.

v1.1.1

With the help from:

Added a feature to search anime even in lowercase when passed in the arguments.

v1.0.2

Thanks to:

For adding 'type' section for a better sorting of movies and TV shows.

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.

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.

anime-cli's People

Contributors

atul-g avatar gamecube762 avatar genzyy avatar michalnemecek avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.