Wondering what’s next for npm?Check out our public roadmap! »

    @aventum/cli

    1.0.1 • Public • Published

    Aventum CLI

    CLI app to help you in your journey with Aventum!

    Table of Contents

    1. Documentation
      1. Requirements
      2. Installation
      3. Usage
      4. How it works?
      5. Commands
    2. Support
    3. License

    Documentation

    Requirements

    1. Node.js.
    2. 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

    1. create/c
    2. server-configurations/sc
    3. run/r

    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
    

    or

    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.

    License

    Copyright (c) 2020 Mohammed Al-Mahdawi Licensed under the MIT license.

    Keywords

    Install

    npm i @aventum/cli

    DownloadsWeekly Downloads

    2

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    22.9 kB

    Total Files

    10

    Last publish

    Collaborators

    • avatar