CLI

Qovery provides a very easy to use CLI (Command Line Interface) designed to perfectly fit the developer workflow.

When you type a command, the CLI is aware of your current project, application and environment. Which is very convenient!

First usage

Install Qovery CLI

• Linux
• MacOS
• Windows

# Download and install Qovery CLI on every Linux distribution
$ curl -s https://get.qovery.com | sudo bash

Sign up

# Sign up and sign in command
$ qovery auth

If you are using an environment without access to GUI or a browser, you can use headless authentication instead:

# Sign up and sign in command
$ qovery auth --headless

Your browser window with sign-in options will open.

Note: Qovery needs access to your account to be able to clone your repository for future application builds.

Click here to authorize Qovery to clone and build your applications.

Congratulations, you are logged-in.

Are you hosting your projects on Gitlab? We got you covered! Simply sign in to Qovery using your Gitlab account and enable Qovery in your project using:

# enables Qovery for the project in current working directory
$ qovery git enable

That's it! It's a one time process that needs to be performed in each of your Gitlab projects that makes Gitlab send notifications about events happening in your repository.

In the future, Qovery will allow you to manage your projects directly in Gitlab and Qovery UI.

Help

You can see all the commands available by executing:

$ qovery help

Help output

The qovery command line interface lets you manage your Qovery environment.

Usage:
  qovery [command]

Available Commands:
  application Perform application actions
  auth        Do authentication
  database    Perform database actions
  deploy      Perform deploy actions
  domain      Perform domain actions
  environment Perform environment actions
  help        Help about any command
  init        Do project initialization to use Qovery
  log         Show application logs
  project     Perform project actions
  redeploy    Redeploys your application
  run         Equivalent to 'docker build' and 'docker run' but with Qovery magic sauce
  status      Show status from current project and environment
  template    Perform templating actions
  upgrade     Upgrade Qovery CLI to latest version
  validate    Validate the current config is valid
  version     Print version information for the Qovery CLI

Flags:
      --debug   Enable debugging when true.
  -h, --help    help for qovery

Use "qovery [command] --help" for more information about a command.

Limitations

Windows

ANSI Color codes: Powershell does not natively support ANSI color codes. Some tricks exist to make it work. The more accessible it is to use qovery <command> | Out-Host when you need to show colors.

Support

Do you have any issue with Qovery CLI? Open an issue.

Next steps

Now that you have installed the CLI, check out how to deploy your first application