Skip to content

IOINITID/cyclone-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

24c2848 Β· Apr 1, 2023

History

60 Commits
Apr 1, 2023
Mar 13, 2023
Mar 18, 2023
Apr 1, 2023
Mar 13, 2023
Apr 1, 2023
Mar 19, 2023
Mar 19, 2023
Mar 19, 2023
Apr 1, 2023
Apr 1, 2023
Apr 1, 2023
Apr 1, 2023
Apr 1, 2023
Mar 18, 2023

Repository files navigation

logo

npm version npm license minzip

!last-commit !PRs-welcome !code style-prettier

CLI for getting weather forecast.

πŸ“„ About:

The API token from the open weather map service is used, for the weather forecast to work, you need to register on the service and get the API token https://openweathermap.com.

To get the weather forecast, you need to run the command: cyclone

On the first run, the token and city API setup process will be started to complete the request.

✨ Features:

  • Show weather with CLI
  • One of the popular weather APIs is used - OpenWeatherMap
  • Interactive CLI with the ability to select actions, show loading states and text animations when displaying information
  • Emoji as weather icon display
  • Written in TypeScript
  • Small application size, only 5 kb
  • Can be installed globally

πŸš€ Install:

Can be used both globally and locally.

Global install

To install via npm: npm install --global cyclone-cli

To install via yarn: yarn add --global cyclone-cli

Local install

To install via npm: npm install --save-dev cyclone-cli

To install via yarn: yarn add cyclone-cli

πŸ’» Usage:

You can see the available commands with the command: cyclone β€”help or cyclone -h.

To refresh the API token, you can enter the command: cyclone β€”token [API_KEY] or cyclone -t [API_KEY].

To update the city, you can enter the command: cyclone β€”city [CITY] or cyclone -c [CITY].

You can find out the version of the application using the command: cyclone β€”version or cyclone -v.

βš™οΈ Configuration:

The application settings file is located in the user folder, in the hidden directory .cyclone/config.json. It contains a set of settings for different versions of the application.

πŸ”— Dependencies:

πŸ“„ Changelog:

A list of all versions and their changes can be found in the CHANGELOG.md file. The releases of each version are located on the releases page on Github.

πŸ“„ Contributing:

If you want to improve the project, you can submit your PR with corrections or improvements. The file CONTRIBUTING.md describes the details of how to start and configure the project.

πŸ‘¨β€πŸš€ Code of conduct:

The rules for the community when sending pull requests are in the file CODE_OF_CONDUCT.md.

πŸ“„ License:

The MIT license is located in the file LICENSE.md.