Documentation

The vtx CLI

Deploy, follow logs and promote from your terminal. The CLI is a single binary with no dependencies.

Install

Builds are published at releases.vantrex.cloud for macOS (Intel and Apple silicon), Linux and Windows. Download the archive for your system, extract the vtx program and put it somewhere on your PATH.

macOS or Linux
$ tar -xzf vtx_<version>_<os>_<arch>.tar.gz
$ sudo mv vtx /usr/local/bin/
$ vtx version
Windows (PowerShell)
> Expand-Archive vtx_<version>_windows_amd64.zip -DestinationPath $env:USERPROFILE\bin
> $env:Path += ";$env:USERPROFILE\bin"
> vtx version

To keep it on your path permanently on Windows, add that folder to the Path variable in System Settings.

Check the download

Each release includes a SHA256SUMS file. Compare it with the archive you downloaded before running it:

$ sha256sum -c SHA256SUMS --ignore-missing

vtx version prints the version, the commit it was built from and the build time.

Sign in

  1. Start

    $ vtx login

  2. Approve in the browser

    The CLI prints an address and a code. Open the address, check that the code matches what the terminal shows, and approve. You need to be signed in to the dashboard in that browser.

  3. Done

    The terminal prints Logged in. and stores an access token for this computer. You will not be asked again.

Run vtx link in your project folder once. See the command reference.

Updating

Download a newer archive and replace the old binary. Versions are semantic (1.2.0), published versions never change, and the latest is always listed on the releases page.

Signing out

Delete the token file (see Configuration) and revoke the token in the dashboard. Revoking it is what stops it working; deleting the file only forgets it on this computer.