---
The CLI requires NodeJS >= 6.9.0 and NPM 3 or higher.
# Usage
## Installation
```bash
npm install clea -g
```
## Options
```bash
clea help
# or
clea help [command]
```
# How to start ?
```bash
clea new
cd
clea serve
```
Go to http://localhost:8080/. Hot reload is active by default.
To see the `clea serve` options & details, go check the [documentation](https://github.com/groupe-sii/clea-cli/blob/master/docs/serve.md).
## Progressive Web App
You can generate basic Progressive Web App support with the following `clea new --make-it-progressive`.
[Learn more](docs/more/make-it-progressive.md)
# Generate some entities
The `clea generate` command allows you to easily generate entities in your application.
```bash
clea generate [entity] my-new-entity
# Support relative path
# If you are under the src/app/feature/ folder, and launch:
clea generate [entity] my-new-entity
# Your new entity will be generated under the src/app/feature/my-new-entity folder
# But, if you are still in the src/app/feature/ folder, and launch:
clea generate [entity] ../my-newer-entity
# Your entity will be generated in the src/app/my-newer-entity folder
```
Available entities:
Entity | Usage
--- | ---
Component | `clea generate component my-new-component`
Directive | `clea generate directive my-new-directive`
Filter | `clea generate filter my-new-filter`
Service | `clea generate service my-new-service`
Module | `clea generate module my-new-module`
[Learn more](https://github.com/groupe-sii/clea-cli/blob/master/docs/generate.md)
# Upgrade Clea
To upgrade Clea to it's latest version, you must upgrade the global and local package.
For the global package:
```bash
npm uninstall -g clea
npm cache clea
npm install -g clea
```
For a local project:
```bash
rm node_modules -rf
npm install --save-dev clea
npm install
```
# Documentation
The documentation can be found under the [docs](https://github.com/groupe-sii/clea-cli/tree/master/docs) folder.
# License
MIT License
