Quickstart

Install

Voidx needs a Voids.run subscription / API key. Create one in the dashboard.

This guide walks through editing a Git project with Voidx and a ChatGPT subscription.

For Linux or macOS:

curl -fsSL https://raw.githubusercontent.com/voids-run/voidx/refs/heads/main/install.sh | bash

wget -qO- https://raw.githubusercontent.com/voids-run/voidx/refs/heads/main/install.sh | bash

install.sh downloads a release archive for your platform and installs the binary to $HOME/.local/bin.

Initial setup

voidx init

Setup asks four questions:

Voidx API key. Update it later with voidx login.
Allow local Codex ChatGPT auth? When enabled, voidx reads ~/.codex/auth.json and may upload it to remote workspaces so Codex can use your ChatGPT subscription. Decline to keep that file local.
Enable E2EE cloud sync? Sync makes your repositories, SSH keys, and private models available on all your devices. Voidx encrypts synced data end to end.
Git SSH key policy. Controls how Git authentication works in the sandbox. The default keeps your private key on your machine. See Security.

Start a workspace

(Optional) Fork a repo to edit

Use a fresh SSH key for this. See Security.

Generate a key for the fork:

ssh-keygen -t ed25519 -C "your_email@example.com"

Add the public key to the repo’s deploy keys and grant it write access.

Configure keys and the repo

To keep this guide short, we skip model configuration: use your ChatGPT subscription and log in with codex. To bring your own model, run voidx model add; the endpoint must support the OpenAI Responses API.

Pulling and pushing the repo requires an SSH key. If you enabled cloud sync, voidx syncs your SSH keys to all your devices, protected by E2EE.

voidx ssh-key add nginx-key ~/.ssh/nginx

voidx repo add nginx git@github.com:username/nginx.git --ssh-key nginx-key

Start a remote VM that clones the repo:

voidx start nginx

Or use the short form:

voidx s nginx

Now put the agent to work in your workspace.

Leave and come back

The sandbox and the agent inside keep working after you close your laptop or drop offline. You can reconnect to a running sandbox from any device, including your phone.

/exit (or Ctrl+D Ctrl+C) closes the UI. The sandbox keeps running until its lifetime expires (24 hours by default).
voidx reconnect (or voidx rec for short) opens a picker of recent sandboxes.
/lease +2h buys more time; /lease alone prints usage help.

Shut down

You pay for a sandbox as long as it runs in the cloud. End one yourself with /destroy. Otherwise it self-destructs after one day; adjust that schedule with /lease.

Slash commands

Type / to see every command with completion; the full list is in Slash Commands.

About Slash commands