Lenra Docs
Register on Lenra
  • Home
  • Getting started
    Open/Close
  • Guides
    Open/Close
  • Features
    Open/Close
  • References
    Open/Close
  • Contribute

    Commands

    This CLI contains many subcommands to help you doing what you need.

    Use the help options or help subcommand to understand how to use them:

    $ lenra --help
    lenra_cli 1.0.0
    The Lenra command line interface
    
    USAGE:
        lenra [OPTIONS] [SUBCOMMAND]
    
    OPTIONS:
            --config <CONFIG>    The app configuration file [default: lenra.yml]
            --expose <EXPOSE>    Exposes services ports [possible values: app, devtool, postgres, mongo]
        -h, --help               Print help information
        -v, --verbose            Run the commands as verbose
        -V, --version            Print version information
    
    SUBCOMMANDS:
        build      Build your app in release mode
        dev        Start the app in an interactive mode
        help       Print this message or the help of the given subcommand(s)
        logs       View output from the containers
        new        Create a new Lenra app project from a template
        reload     Reload the app by rebuilding and restarting it
        start      Start your app previously built with the build command
        stop       Stop your app previously started with the start command
        update     Update the tools Docker images
        upgrade    Upgrade the app with the last template updates
    

    Some global options are available for all subcommands:

    OPTIONS:
            --config <CONFIG>    The app configuration file [default: lenra.yml]
            --expose <EXPOSE>    Exposes services ports [possible values: app, devtool, postgres, mongo]
        -v, --verbose            Run the commands as verbose
    

    They won't have effect on all subcommands but can be used for most of them. Also, you will be able to set them in the terminal context since they are defined for the whole terminal lifetime (except the --expose option that can be redefined by the expose command).