Install the CLI

velixir is the canonical way to ship code to Velixir. It packages your project source, uploads it to object storage, and waits while the platform builds it and rolls it out, all from a single command. There is no local build step: you do not need the .NET SDK, tar, or any language toolchain on your machine to deploy, because the CLI packs your source in-process and the build runs on the platform.

Install

The velixir CLI is a standalone, self-contained binary. On macOS or Linux, install it in one line, no toolchain required:

curl -fsSL https://velixir.net/install.sh | sh

That drops velixir into ~/.velixir/bin (add it to your PATH if the installer says so). Pin a version with VELIXIR_VERSION=1.7.1 before sh.

If you already have the .NET SDK, or you are on Windows, you can install it as a .NET global tool instead:

dotnet tool install --global Velixir.Cli

With the tool install, make sure ~/.dotnet/tools is on your PATH on macOS / Linux. 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 Package the current directory's source, upload it, build it on the platform, and deploy.
velixir deploy --slot staging Same, but to a specific deployment slot.
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.
  • --source-dir <path> - Package source from a different directory instead of the current one.
  • --slot <name> - Deploy to a named slot (defaults to production).
  • --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.