Skip to content

Repository files navigation

Vertra Cloud CLI

License: MIT

Official command-line tool for Vertra Cloud: deploy applications, follow logs live and manage databases, snapshots and workspaces from your terminal.

  • Single binary for macOS, Linux and Windows — no Node.js or other dependencies.
  • Human-friendly tables by default, --json on every command for scripts and CI.
  • English, Portuguese and Spanish.

Installation

macOS and Linux

curl -fsSL https://cli.vertracloud.app/install | sh

Windows (PowerShell)

irm https://cli.vertracloud.app/install | iex

The installer downloads the latest release for your system and processor (x64 or ARM), verifies its SHA-256 checksum and adds vertra to your PATH. Run it again to update.

Variable Effect
VERTRA_VERSION Install a specific version, e.g. v0.2.0.
VERTRA_INSTALL_DIR Install somewhere else. Defaults to ~/.vertracloud/bin (%USERPROFILE%\.vertracloud\bin on Windows), next to your config.

Prefer to do it by hand? Download the archive for your platform from Releases, check it against checksums.txt and put vertra on your PATH. The installer scripts are in scripts/.

Getting started

vertra auth login     # paste an API key created in the dashboard
vertra doctor         # check the project before sending it
vertra deploy         # upload the current directory
vertra logs --follow  # follow the output live

Your key is stored in ~/.vertracloud/config.json, readable only by your user. In CI, set VERTRA_API_KEY instead; it takes priority over the saved key.

Commands

Command What it does
vertra auth login|whoami|logout Connect and inspect your account.
vertra app ... List, inspect, start, stop, restart, deploy, configure and delete applications; logs, metrics, environment variables, files and domains.
vertra db ... Create and manage databases, credentials and certificates.
vertra projects Applications and databases in one table, with live status.
vertra snapshot ... List, create, download and restore snapshots.
vertra workspace ... Workspaces, members, invites and roles.
vertra folder ..., vertra favorite ... Organize your resources.
vertra link [<id>], vertra unlink Tie the current directory to an application.
vertra doctor, vertra zip Check and package the project locally.
vertra lang <pt|en|es> Change the CLI language.
vertra status Platform status.

Run vertra --help or vertra <command> --help for every flag. When an ID is omitted, the CLI uses the linked application or lets you pick one. Destructive commands ask for confirmation; pass --yes in automation.

Scripting

VERTRA_API_KEY=*** vertra deploy --json

With --json, output is the API response and errors keep the API's code, so scripts can branch on them. Colors are only used in a real terminal and respect NO_COLOR. VERTRA_LANG sets the language for a single run.

For GitHub Actions, see vertracloud/github-action.

Building from source

Requires Go 1.22+.

make build                   # ./bin/vertra
make test                    # go vet + go test
make dist VERSION=v0.2.0     # release archives for every platform in ./dist

License

MIT

About

Official command-line tool for deploying and managing applications on Vertra Cloud.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages