# @caporl/cli

> Command line utility for Caporl

Latest version **0.1.1** (published 2019-02-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @caporl/cli
pnpm add @caporl/cli
yarn add @caporl/cli
bun add @caporl/cli
```

Provides the command `fcs`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2019-02-07 |
| First published | 2018-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 18 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | caporl |

## Links

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

## Dependencies (18)

- [uniqid](https://npm.io/package/uniqid.md) latest
- [vorpal](https://npm.io/package/vorpal.md) latest
- [request](https://npm.io/package/request.md) latest
- [shelljs](https://npm.io/package/shelljs.md) latest
- [fs-extra](https://npm.io/package/fs-extra.md) latest
- [jsonfile](https://npm.io/package/jsonfile.md) latest
- [node-dir](https://npm.io/package/node-dir.md) latest
- [omelette](https://npm.io/package/omelette.md) latest
- [node-wget](https://npm.io/package/node-wget.md) latest
- [appversion](https://npm.io/package/appversion.md) ^1.7.1
- [selfupdate](https://npm.io/package/selfupdate.md) latest
- [concurrently](https://npm.io/package/concurrently.md) latest
- [node-stream-zip](https://npm.io/package/node-stream-zip.md) latest
- [@caporl/schematics](https://npm.io/package/@caporl/schematics.md) ~0.1.0
- [@schematics/schematics](https://npm.io/package/@schematics/schematics.md) latest
- [request-promise-native](https://npm.io/package/request-promise-native.md) latest
- [@angular-devkit/schematics](https://npm.io/package/@angular-devkit/schematics.md) latest
- [@angular-devkit/schematics-cli](https://npm.io/package/@angular-devkit/schematics-cli.md) latest

## Recent versions

- 0.1.1 (latest) — 2019-02-07
- 0.1.0 — 2019-02-06
- 0.0.1-6-1 — 2018-02-04
- 0.0.1-6 — 2018-02-04
- 0.0.1-5 — 2018-02-04
- 0.0.1-4 — 2018-01-27
- 0.0.1-3 — 2018-01-27
- 0.0.1-2 — 2018-01-26
- 0.0.1-1 — 2018-01-23
- 0.0.1 — 2018-01-22

## README

<p align="center">
  <img src="http://file.blueanchor.io/index.php/apps/files_sharing/ajax/publicpreview.php?x=3360&y=1134&a=true&file=Caporl%2520Logo.png&t=GN2P3t5MmFShh14&scalingup=0" width="650"/>
</p>

## Caporl CLI (aka fcs / First Class Soldier)
### CLI for Caporl applications based on the [Vorpal](http://http://vorpal.js.org/) immersive command-line.

<!-- Badges section here. -->
[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
[![Caretaker](https://img.shields.io/badge/caretaker-materasu-blue.svg)](https://github.com/materasu)

## Table of Contents

* [Installation](#installation)
* [Usage](#usage)
* [Autocomplete and direct call](#autocomplete-and-direct-call)
* [Generating and serving a Caporl project](#generating-and-serving-a-caporl-project)
* [Availabled commandes](#availabled-commands)
* [Updating](#updating)
* [Contributing](#contributing)
* [License](#license)

## Installation

```bash
npm install -g @caporl/cli
```

## Usage

You can access `fcs` wherever you want, with the command

```bash
fcs
```

You will enter in the FCS mode, on the folder of your native cli, and you can get help with

```bash
caporl [your-actual-path] help
```

Beware, if you are not in a caporl project folder, you will only be able to use the project create command.

## Autocomplete and direct call

You want to use command directly, without enter the fcs mode? yes you can!

It's just simple as typing a command, try to test

```bash
fcs help
```

To facilitate your work with Caporl over fcs, we given you the abaility to install the autocomplete of commands, just do :

```bash
fcs --install-autocomplete
```

Don't forget to reload your terminal or just `source ~/.zshrc` (`.bashrc` for bash)

## Generating and serving a Caporl project

```bash
caporl [your-actual-path] create:project MyApp
caporl [your-actual-path/MyApp] start:dev
```

Navigate to [http://localhost:4200/](http://localhost:4200/) for the `front`.

Navigate to [http://localhost:3333/](http://localhost:3333/) for the `api`.

Both apps will automatically reload if you change any of the source files.

## Availabled commands

You can find all possible commands in the table below

Command | Usage
--- | ---
[Create new project](https://github.com/caporl/cli/wiki/create-project) | `create:project [name]`
[Add a project part](https://github.com/caporl/cli/wiki/add-part) | `add:part (model, page, service) [name]`
[Start dev server](https://github.com/caporl/cli/wiki/start-dev) | `start:dev --front --back`

## Updating

To update Caporl CLI to a new version, you must update both the global package and your project's local package.

## Contributing

First of all, we recommand you to generate the doc with `node_modules/documentation/bin/documentation.js build bin/fcs -f html -o docs`.
You can check our issues, and contribute to our Schematics.
We follow a git flow workflow, and trying to make cross reviews.

## License

MIT

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