vanishDOCS

Run your first command

Put vanish in front of a command and it runs on a managed Linux machine against your working tree, uncommitted changes included. Output streams back to your terminal, and Vanish exits with the command's exit code.

Install

curl -fsSL https://vanishcompute.com/install.sh | bash

The script supports macOS, and Linux with glibc, on arm64 and x86_64. It downloads one binary, checks it against the release's SHA-256 checksum, and installs it as vanish in /usr/local/bin if you can write there, otherwise in ~/.local/bin. It changes nothing else and does not edit your shell configuration. You can read it first at https://vanishcompute.com/install.sh.

~/.local/bin is not on the default PATH on macOS. If vanish answers command not found, add it. The installer prints the exact line for your shell; for zsh it is:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
export PATH="$HOME/.local/bin:$PATH"

Sign in

vanish login

This opens GitHub sign-in in your browser and saves a credential for this machine. New accounts start with free starter credits, and no card is needed. Pricing has the rates, and login covers headless machines and CI.

Run a command

In your repository, put vanish in front of a command you already run, for example:

vanish cargo test

Two things to expect:

  • The first run in a repository takes longer. Vanish uploads and hashes the tree first: about a minute and a half on a 27 GB tree. After that, Vanish adds roughly a second to a command in a normal repository.
  • Files the command writes are staged, not written into your working tree. A build that succeeds leaves target/ as it was until you apply the result.

To write the results into your tree as each Run finishes, add --apply:

vanish --apply cargo build

To make that the default for a repository, put apply = true in a .vanish.toml file at its root. If you change a file during a Run and the Run writes the same file, --apply keeps your version, leaves the whole result staged, and lists the paths.

To apply a staged result yourself:

vanish results
vanish results apply TOKEN --dry-run
vanish results apply TOKEN --yes

vanish results lists staged results with their tokens; replace TOKEN with one of them. If applying would replace existing files, read the dry run, then add --force.

Workers run Amazon Linux, so the command must be one Linux can run. Node.js with npm, Bun, Rust with cargo, Python 3, make, gcc, g++, clang, cmake and git are preinstalled. Other tools, including Go, Java, pip and pytest, are not; see toolchains. Your laptop's node_modules and Python virtual environments are not sent with a Run and do not carry over from one Run to the next, so install dependencies in the same Run that uses them:

vanish sh -c "npm ci && npm test"

Runs and recovery covers flags, limits and errors.

If a Run fails in a way you cannot explain, bring the Run ID it printed to the Discord while it is still on screen. The Run ID is what lets us trace it.

On this page