1.0.2 • Published 9 months ago
@ibaraki-douji/api-cli v1.0.2
API CLI
A CLI for generating Ibaraki API.
⚠️ The CLI work only from version 2.0.0 of the API.
Getting started
npm i -g @ibaraki-douji/api-cli
Usage
ibaraki-api install [options]ibaraki-api update [--version <version>]ibaraki-api helpibaraki-api demo
Options
| Option | Description | Default | Values |
|---|---|---|---|
| --interactive | Enable interactive mode (question for options) | true | boolean |
| --version | Set the version of the API | latest | tag or x.x.x |
| --port | Set the port of the API | 5055 | number |
| --defaultFolders | Use default folders for the API | true | boolean |
| --swagger | Use swagger UI in the API | true | boolean |
| --dotenv | Use dotenv library to manage your env variables | false | boolean |
| --websocket | Enable websocket in the API | false | boolean |
| --destFolder | Set the destination folder for the compiled API | lib | string |
| --debug | Enable debug mode for the API | true | boolean |
| --newFolder | Create the API in a sub folder | false | boolean |
Examples
Fully interactive installation:ibaraki-api install --interactive
Install the default API:ibaraki-api install --interactive false
Install the demo API: (will wipe the content of your current folder)ibaraki-api demo
Update the API to the latest version: (not implemented yet)ibaraki-api update