@pecometer/peco-cli
Version:
Pecometer Command Line Interface Application
54 lines (35 loc) • 1.39 kB
Markdown
# PecoCLI
A command line app that is primarily used to setup a Node.js project with [PecoTS](https://www.pecots.co.uk) (backend) and Angular (frontend) as the main frameworks.
[PecoTS](https://www.pecots.co.uk) is a closed source framework, and this tool has very little use outside of working with the framework.
## Create A New App
Use this command to quickly prepare an application directory with a backend, frontend, or both basic applications.
The process will ask for various details depending on the options selected.
```
peco-cli create-app
```
## Generate DOTENV
Generate a .env file for your PecoTS application using the `generate-env` command. The file will be created in the current directory.
```
peco-cli generate-env
```
## Check Update
Checks if an update to the CLI package is available.
```
peco-cli check-update
```
## Version
Outputs the current package version to the console.
```
peco-cli version
```
## Executing your CLI
You may execute your CLI application built in PecoTS by calling this utility from the root folder of your application followed by the commands you have created or those provided by the framework.
```
peco-cli my-app-command.a-function-to-execute
peco-cli migration.make users
peco-cli rbac.make
peco-cli migration.up
peco-cli migration.down
```
## Copyright
Copyright [Pecometer Software Limited](https://www.pecometer.co.uk)