Docs

Search Vex documentation

Search public documentation, commands, and release notes.

Browse documentation

CLI

CLI configuration

Configure Vex command line profiles and local settings without hiding important context.

On this page

Sign in and inspect

vex login uses the browser authorization flow and writes the successful local profile to ~/.config/vex/config.toml. It also makes a best-effort update to your JJ author identity, using the commit author email selected under Account settings.

Terminal
vex login
vex whoami
vex settings show --format json

Add extra addresses and pick the default commit author email at Account in the web app. Each extra address must be verified before Vex will write it into new commits. vex login refreshes the local JJ identity after a change; existing checkouts keep the previous user.email until you sign in again.

Use vex login --no-browser from a headless machine and complete the printed verification URL elsewhere. Use vex logout to remove the stored login.

Choose an organization context

An explicit organization default keeps org-scoped commands predictable. Switch by a readable slug, name, or ID; inspect it, or clear it when you do not want a default.

Terminal
vex context switch <org>
vex context show --format json
vex context clear

Set a datacenter default when you need one

Infrastructure-aware commands can use a saved default datacenter. Set it deliberately, inspect the result, or clear it to return to command-level selection.

Terminal
vex settings set-default-datacenter lon1
vex settings show --format json
vex settings clear-default-datacenter

Know which configuration wins

Configuration resolves in this order:

  1. Per-command flags such as --api-base-url and --api-token.
  2. Environment variables such as VEX_API_BASE_URL and VEX_API_TOKEN.
  3. The local config file at ~/.config/vex/config.toml.

Do not commit or copy the local config file between machines. On Windows + WSL, the WSL CLI profile is separate from Windows desktop configuration.

Keep workspace policy with the repository

Use vex ws from the main repository root to inspect or establish a checked-out workspace policy. The policy lives in .vex/workspace.toml; workspaces themselves live outside the parent checkout by default.

Terminal
vex ws config
vex ws config --init
vex ws create
vex ws list

Use vex ws remove <name> rather than deleting a registered workspace manually, so the repository lifecycle hooks run.

When workspaces have already been deleted by hand, or have outlived the work they were created for, vex prune finds the registrations left behind and removes them.