Skip to content

CLI ​

Overview ​

The CLI can be used to create, start and manage your Quinimbus projects. The binary can be downloaded here

General options ​

The base command supports the following options:

shortlongdescription
-h--helpShow this help message and exit
-v--verboseShow verbose log output
-V--versionPrint version information and exit

project ​

Commands to create and manage projects. It contains the following subcommands:

create ​

This command creates a new project. A project name has to be provided.

bash
quinimbus project create [<options>] <projectName>

Options ​

shortlongdefaultdescription
-a--artifactId=<projectname>The artifactId used for the new project
-d--directory=<projectname>The directory to create the project into
-g--groupId=io.company.cloudThe groupId used for the new project
-o--mvn-outputdisabledShow the output of the invoked mvn commands, only visible in verbose mode
--quinimbusVersion=dependend on CLI versionThe version of quinimbus to use to create the project
--skip-archetype-installationdisabledSkip installation of archetype, for example to use a locally installed one
-v--verbosedisabledShow verbose log output
-V--projectVersion0.1-SNAPSHOTThe version used for the new project

build-images ​

This command builds the docker images for this project

bash
quinimbus project build-images [<options>]

Options ​

shortlongdefaultdescription
-c--cleandisabledDo not use cache and repull all images
-o--docker-outputdisabledShow the output of the invoked docker commands, only visible in verbose mode
-v--verbosedisabledShow verbose log output

run-containers ​

This command runs the built docker images locally

bash
quinimbus project run-containers [<options>]

Options ​

shortlongdefaultdescription
-o--docker-outputdisabledShow the output of the invoked docker commands, only visible in verbose mode
-v--verbosedisabledShow verbose log output

stop-containers ​

This command stops the locally started docker containers

bash
quinimbus project run-containers [<options>]

Options ​

shortlongdefaultdescription
-c--cleardisabled
-o--docker-outputdisabledShow the output of the invoked docker commands, only visible in verbose mode
-v--verbosedisabledShow verbose log output