# cyclone-cli > Cyclone - CLI for getting weather forecast. Latest version **1.0.1** (published 2023-04-01) · MIT license · 0 weekly downloads ## Install ```sh npm install cyclone-cli pnpm add cyclone-cli yarn add cyclone-cli bun add cyclone-cli ``` Provides the command `cyclone`. ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2023-04-01 | | First published | 2023-04-01 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 9 | | Unpacked size | 12.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | Igor Orishchenko | | Maintainers | ioinitid | | Keywords | weather, forecast, cli, open-weather-map | ## Links - npm: https://www.npmjs.com/package/cyclone-cli - Repository: https://github.com/IOINITID/cyclone-cli - Homepage: https://github.com/IOINITID/cyclone-cli#readme - Issues: https://github.com/IOINITID/cyclone-cli/issues - npm.io page: https://npm.io/package/cyclone-cli ## Dependencies (9) - [axios](https://npm.io/package/axios.md) ^1.3.4 - [chalk](https://npm.io/package/chalk.md) ^5.2.0 - [dayjs](https://npm.io/package/dayjs.md) ^1.11.7 - [yargs](https://npm.io/package/yargs.md) ^17.7.1 - [dedent](https://npm.io/package/dedent.md) ^0.7.0 - [figlet](https://npm.io/package/figlet.md) ^1.5.2 - [inquirer](https://npm.io/package/inquirer.md) ^9.1.4 - [nanospinner](https://npm.io/package/nanospinner.md) ^1.1.0 - [gradient-string](https://npm.io/package/gradient-string.md) ^2.0.2 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 1.0.1 (latest) — 2023-04-01 - 1.0.0 — 2023-04-01 ## README ![logo](logo.svg) [![npm version](https://badge.fury.io/js/cyclone-cli.svg)](https://badge.fury.io/js/cyclone-cli) ![npm](https://img.shields.io/npm/dw/cyclone-cli) ![license](https://badgen.net/github/license/IOINITID/cyclone-cli) ![minzip](https://img.shields.io/bundlephobia/minzip/cyclone-cli) ![!last-commit](https://img.shields.io/github/last-commit/ioinitid/cyclone-cli) ![!PRs-welcome](https://img.shields.io/badge/PRs-welcome-brightgreen) ![!code style-prettier](https://img.shields.io/badge/code%20style-prettier-ff69b4) ## 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: - Axios - Chalk - Dedent - Inquirer - Nanospinner - Yargs - Gradient-String - Figlet - DayJS ### 📄 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. --- _Source: https://npm.io/package/cyclone-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._