winx

winx

A CLI to generate CLIs
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• 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
• fs-extra
• boxen
• 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

npm install npm@latest -g

Installation

Either through cloning with git or by using npm (the recommended way):

1. Install NPM packages

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 <you-cli> <path>

<your-cli> argument takes the CLI's name and <path> 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 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 while contributing to the project 😄.

License

Distributed under the MIT License. See LICENSE for more information.