@aventum/cli NPM

Aventum CLI

CLI app to help you in your journey with Aventum!

Documentation

Requirements

Node.js.
Git.

Installation

Run:

npm install @aventum/cli -g

Usage

Go to an empty folder that you have permissions to write into it and run:

aventum create -r

How it works

Aventum CLI download, configure, build, and run the Aventum app for you.

Commands

`create/c`

Create Aventum app.

Options

Option	Description	Default
`-dp`, `--dashboard-port`	Set dashboard port.	`3333`
`-d`, `--docker`	Create Aventum app using Docker Compose template.
`-r`, `--run`	Run Aventum app, only work if it is not a docker compose app.

Examples

Create and run Aventum app and use port 3500 for the dashboard.

aventum c -r -dp 3500

same as

aventum create -r -dp 3500

`server-configurations/sc`

Reset/regenerate Aventum server configurations.

Options

Option	Description	Default
`-b`, `--build`	Build Aventum dashboard, because if you changed the server port you may want to update REACT_APP_BASE_URL in .env.production of the dashboard and rebuild it, this option do this for you.

Examples

Generate server configurations and rebuild the dashboard.

aventum sc --build

same as

aventum server-configurations --build

`run/r`

Run Aventum app that doesn't created using Docker Compose template and created previously using Aventum CLI.

Options

Option	Description	Default
`-dp`, `--dashboard-port`	Set dashboard port.	`3333`

Examples

Run Aventum app and set the dashboard port to 3500

aventum r -dp 3500

same as

aventum run -dp 3500

To get help run:

aventum -h

aventum --help

Support

You are welcome to contribute code and provide pull requests for Aventum CLI, also please feel free to suggest or request any features or enhancements.