Install the CLI and sign in
xvii is a single binary for macOS and Linux. Every service brings its commands into it: xvii pages,
xvii apps, xvii env and so on.
Install
curl -fsSL https://xvii.network/install.sh | sh
curl -fsSL https://xvii.network/install.sh | XVII_INSTALL_DIR="$HOME/.local/bin" sh
The script downloads the build for your system from the instance's release store, checks its SHA-256 and
prints where it installed it. Make sure that folder is on your PATH:
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
fish_add_path ~/.local/bin
Sign in
xvii login xvii.network
The CLI shows a short code and opens id in your browser. Check that the code matches, confirm with your
passkey, and the terminal continues on its own. The sign-in is kept as a context named after the
domain.
On a server over SSH, there is no browser to open:
xvii login xvii.network --no-browser
It prints a link and a QR code; open it on any device where you have your passkey.
xvii whoami
shows who you are, your teams and how you signed in. Signed-in machines are listed (and can be signed
out) in id under Account → CLI sign-ins.
Shell completion
xvii completion --install
completes commands, flags and also names: aliases, apps, projects, teams.
Several instances
Each instance is a context. login creates one; context lists and switches them:
xvii context # ● marks the current one
xvii login work.example.com --name work
xvii context use work
xvii --context work apps ls # one command against another instance
Updates
The CLI checks once a day whether the instance offers a newer version and mentions it after a command.
xvii update # install the version the instance offers
xvii update --check # only say whether there is one
XVII_NO_UPDATE_CHECK=1 turns the daily check off.
Without a saved sign-in (CI)
XVII_DOMAIN and XVII_TOKEN stand in for a context, so a CI job needs no xvii login:
export XVII_DOMAIN=xvii.network
export XVII_TOKEN=xv_… # an API token, see Concepts → Tokens
xvii pages deploy dist
In GitLab CI and GitHub Actions you can skip the token entirely: see Deploy from CI.
Help
xvii help # every command
xvii help apps deploy # flags and examples of one command
The same information, on one page: CLI reference.