# muxu-cli

> A CLI command to manage muxu projects

Latest version **1.0.0** (published 2019-11-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install muxu-cli
pnpm add muxu-cli
yarn add muxu-cli
bun add muxu-cli
```

Provides the command `muxu`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-11-02 |
| First published | 2019-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 195.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Melvine Nargeot |
| Maintainers | mozaaa |

## Links

- npm: https://www.npmjs.com/package/muxu-cli
- Repository: https://github.com/Melvin-klein/muxu-cli
- Homepage: https://github.com/Melvin-klein/muxu-cli#readme
- Issues: https://github.com/Melvin-klein/muxu-cli/issues
- npm.io page: https://npm.io/package/muxu-cli

## Dependencies (5)

- [colors](https://npm.io/package/colors.md) ^1.4.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.0
- [commander](https://npm.io/package/commander.md) ^3.0.2
- [loading-cli](https://npm.io/package/loading-cli.md) ^1.0.8

## Recent versions

- 1.0.0 (latest) — 2019-11-02
- 0.1.0 — 2019-10-27

## README

[![CircleCI](https://circleci.com/gh/Melvin-klein/muxu-cli.svg?style=svg)](https://circleci.com/gh/Melvin-klein/muxu-cli)

# Muxu CLI

Muxu CLI is command line tool that help to perform actions for [Muxu SSR framework](https://github.com/Melvin-klein/muxu).

## Get Started

First, install Muxu CLI globally :

**Using Yarn :**
```
yarn global add muxu-cli
```

**Using NPM :**
```
npm install muxu-cli --global
```

Now you can check the installation by running the command :
```
muxu --version 

# You should get an output like "vX.X.X"
```

## Commands

### New Project

To create a new Muxu project, you can run the following command :
```
muxu new [project-name]
```

### Version

Check your CLI version with :
```
muxu -v, --version
```

## Contributing

Everyone can contribute to Muxu project. To add a feature or to fix a bug, please follow contributing behavior.

### Code of conduct
Muxu has adopted a Code of Conduct that we expect project participants to adhere to. Please read the [full text](https://www.contributor-covenant.org/version/1/4/code-of-conduct) so that you can understand what actions will and will not be tolerated.

### Add a new feature
1. Fork the repository
2. Create a new branch from develop with the following semantic `feature/[feature-name]`
3. Work on your helpful idea and implement test if needed
4. Check if there no regression by running `yarn test`
5. Make a pull request that target the develop branch

### Fix a bug on `develop` (Not in production yet)
1. Fork the repository
2. Create a new branch from develop with the following semantic `feature/bugfix-[bugfix-name]`
3. Work on your helpful bug fix and improve test if needed
4. Check if there is no regression by running tests with `yarn test`
5. Make a pull request that target the `master` branch

### Fix a bug on `master`
1. Fork the repository
2. Create a new branch from master with the following semantic `bugfix/[bugfix-name]`
3. Work on your helpful bug fix and improve test if needed
4. Check if there is no regression by running tests with `yarn test`
5. Make a pull request that target the `master` branch

## License
Muxu is [MIT licensed](https://github.com/Melvin-klein/muxu-cli/blob/develop/LICENSE).

---
_Source: https://npm.io/package/muxu-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
