Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashikka/winx
A CLI to generate CLIs
https://github.com/ashikka/winx
cli development-tools devtool generator nodejs npm-package
Last synced: about 3 hours ago
JSON representation
A CLI to generate CLIs
- Host: GitHub
- URL: https://github.com/ashikka/winx
- Owner: ashikka
- License: mit
- Created: 2021-05-19T19:52:18.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-06-06T05:49:39.000Z (over 3 years ago)
- Last Synced: 2024-11-08T00:09:09.028Z (12 days ago)
- Topics: cli, development-tools, devtool, generator, nodejs, npm-package
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/winx
- Size: 184 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![csivit][csivitu-shield]][csivitu-url]
[](#contributors-)
[![Issues][issues-shield]][issues-url]
winx
A CLI to generate CLIs
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
## Table of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contributors](#contributors-)
## About The Project
**winx** is a development tool created to speed up your CLI development,so that you don't need to setup up your CLI project. It comes with well-defined directories and files, with all the packages needed installed, and pre-made config files to, so that you don't need to go through the painstaking process of setting up everything.
### Built With
* [yargs](https://www.npmjs.com/package/yargs)
* [fs-extra](https://www.npmjs.com/package/fs-extra)
* [boxen](https://www.npmjs.com/package/boxen)
* [chalk](https://www.npmjs.com/package/chalk)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* npm
```sh
npm install npm@latest -g
```
### Installation
Either through cloning with git or by using npm (the recommended way):
1. Install NPM packages
```sh
npm install -g winx
```
And winx will be installed globally to your system path.
## Usage
To check if installation was successful, use the command:
```
winx --version
```
This will display the latest version.
After installation, run the command below in your terminal:
```
winx --help
```
The help menu with all the options will be listed.
To create your own cli, use the command:
```
winx
```
`` argument takes the CLI's name and `` take the preferred path you want the CLI directory to be generated at on your local system. If no path is specified then the CLI will be generated in your current directory.
## Roadmap
See the [open issues](https://github.com/csivitu/Template/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'feat: Add some AmazingFeature'`)
4. Push to the Branch (`git push -u origin feature/AmazingFeature`)
5. Open a Pull Request
You are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) while contributing to the project :smile:.
## License
Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.
[csivitu-shield]: https://img.shields.io/badge/csivitu-csivitu-blue
[csivitu-url]: https://csivit.com
[issues-shield]: https://img.shields.io/github/issues/csivitu/Template.svg?style=flat-square
[issues-url]: https://github.com/csivitu/Template/issues
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
