Qovery provides a very easy to use CLI (Command Line Interface) designed to fit the developer workflow perfectly.
The purpose of the CLI is to integrate seamlessly with your development workflow:
- Write code
- Qovery - deploy a new version of your application
- Qovery CLI - check the status of your application
- Qovery CLI - debug your application
# Download and install Qovery CLI on every Linux distribution$ curl -s https://get.qovery.com | sudo bash
# Sign up and sign in command$ qovery auth
Your browser window with sign-in options will open.
Click here to authorize Qovery to clone and build your applications.
Congratulations, you are logged-in.
You can see all the commands available by executing:
$ qovery help
$ qovery helpA Command-line interface of Qovery platformUsage:qovery [command]Available Commands:auth Log in to Qoverycompletion Generate the autocompletion script for the specified shellconsole A brief description of your commandcontext Setup the CLI contexthelp Help about any commandlog Displays application logsstatus A brief description of your commandversion Print version information for the Qovery CLIFlags:-h, --help help for qovery
Context command lets you configure the CLI to work with your chosen application. Before executing other commands, you need first to set up the context.
The context is then remembered and used by the CLI. You can configure a new context anytime by running the
qovery context set command.
Set New Context
To set a new context, type
qovery context set:
$ qovery context setQovery: Current context:Organization | QoveryProject | testEnvironment | developmentApplication | websiteQovery: Select new contextOrganization:✔ QoveryProject:✔ adminEnvironment:✔ mainApplication:✔ appQovery: New context:Organization | QoveryProject | adminEnvironment | mainApplication | app
Print Current Context
$ qovery contextQovery: Current context:Organization | QoveryProject | adminEnvironment | mainApplication | appQovery: You can set a new context using 'qovery context set'.
Log command allows you to display the application logs.
$ qovery logTIME MESSAGEJul 15 08:46:13.019717 at /usr/src/app/autoFunctions/levels.js:17:16Jul 15 08:46:13.019721 at Array.forEach (<anonymous>)Jul 15 08:46:13.019724 at Timeout._onTimeout (/usr/src/app/autoFunctions/levels.js:15:14)Jul 15 08:46:13.019728 at listOnTimeout (internal/timers.js:557:17)# ... the rest of logs
By default, the last 1000 logs is displayed.
To make the CLI follow your logs, use
$ qovery log -fTIME MESSAGEJul 15 08:46:13.019717 at /usr/src/app/autoFunctions/levels.js:17:16Jul 15 08:46:13.019721 at Array.forEach (<anonymous>)Jul 15 08:46:13.019724 at Timeout._onTimeout (/usr/src/app/autoFunctions/levels.js:15:14)Jul 15 08:46:13.019728 at listOnTimeout (internal/timers.js:557:17)# ... the rest of logs
This will make the CLI follow your application logs and append any new logs till you use
Status command lets you print the basic status of your application.
$ qovery status15 Jul 21 10:55 CESTApplication | BackendStatus | RUNNING
Console command quickly opens the Qovery Console in your browser to let you display more information about your application.
$ qovery consoleQovery: Opening https://console.qovery.com/platform/organization/your-org/projects/your-proj/environments/your-env/applications/your-app/summary
Shell command allows you to open an ssh connection with the container where your application is running (application selected via the cli context).
$ qovery shell/ # lsbin media srvdev mnt sysdocker-entrypoint.d opt tmpdocker-entrypoint.sh proc usretc root varhome run wwwlib sbin
Generate API token
To use the Qovery API you will need to generate an authentication token. To generate an API token you can install the CLI and type
$ qovery tokenQovery: Select organizationOrganization:✔ My OrganizationChoose a token nameToken name: RomaricChoose a token descriptionToken description: used for Github ActionsQovery: ---- Never share this authentication token and keep it secure ----Qovery: qov_4LnEg2wFxxxxxHObGSQ22rjBZZyyyySgyR6Y_2500882691Qovery: ---- Never share this authentication token and keep it secure ----
To use your token and list your organizations.
curl -X GET -H 'Authorization: Token qov_4LnEg2wFxxxxxHObGSQ22rjBZZyyyySgyR6Y_2500882691' https://api.qovery.com/organization
Check out our API documentation
Do you have any issues with Qovery CLI? Open an issue.