Install the CLI

velixir is the canonical way to ship code to Velixir. It builds your dotnet publish output, uploads it to object storage, and waits for the deploy to land — all from a single command.

Install

The CLI is a self-contained .NET tool. The fastest path is via dotnet tool:

dotnet tool install --global Velixir.Cli

On macOS / Linux make sure ~/.dotnet/tools is on your PATH. On Windows the installer does this for you.

Verify with velixir --version. You should see the CLI banner and version number.

Sign in

Open your dashboard → API keys, create a key with Write permission, copy it.

velixir login

# Paste your key when prompted

The key is stored at ~/.velixir/config.json (mode 0600 on Unix). To sign out, delete that file.

Common commands

Command What it does
velixir login Save your API key for subsequent commands.
velixir apps List apps you can see across all your teams.
velixir init Wire the current directory to a Velixir app (creates .velixir.json).
velixir deploy Build → upload → deploy the current directory.
velixir deploy --slot staging Same, but to a specific deployment slot.
velixir deploy --skip-build Skip dotnet publish and upload an existing .velixir/publish/ folder.
velixir status Show the current app's deployment state per slot.

Flags worth knowing

  • --app <id> — Override the app in .velixir.json for a one-off deploy.
  • --publish-dir <path> — Use a different publish output directory.
  • --no-tail — Exit as soon as the deploy is enqueued instead of waiting for it to go healthy.

What about logs, env vars, rollback?

Streaming logs, env-var management, and rollback all work from the dashboard today. CLI coverage for those is on the roadmap; for now they live one click away in the app's tabs.