Skip to content
Docs menu

Venom Cloud quickstart

Sign up, create an API key, install the venom CLI, point it at Venom Cloud and test it.

View .md

Four steps from a new account to a first answer. The console walks you through the same steps on its Get started page.

Create an account

Sign up and name your organisation. You are its owner. The console then opens Get started; you can come back to it later from Settings or the API keys page (or sign in and open /get-started).

Create an API key

On Get started, name the key (who or what uses it, such as alice-laptop) and create it. Keys start with vck_. The console shows a key once: copy it then. A lost key can't be shown again; revoke it under Settings, API keys, and make another.

Install, connect and test

On macOS or Linux, paste this into a terminal, with your key in place of vck_…. Get started shows it with the key already filled in.

# 1. Install the venom CLI
curl -fsSL https://raw.githubusercontent.com/elishahbiz/venom-releases/main/install.sh | sh
export PATH="$HOME/.venom/bin:$PATH"

# 2. Point it at Venom Cloud
export VENOM_BASE_URL=https://cloud.usevenom.dev/v1
export VENOM_API_KEY=vck_…

# 3. Test it: checks the endpoint and the key, then one prompt
venom doctor
venom -p "Reply with the single word: ready"

The installer checks the download against its SHA256SUMS and links ~/.venom/bin/venom. VENOM_BASE_URL is this cloud's OpenAI-compatible endpoint, including /v1, and VENOM_API_KEY is your key. venom doctor checks the endpoint, the key and the models and prints PASS, WARN or FAIL with a fix on each line; the prompt after it should answer "ready". Windows and other install options are in the CLI quickstart.

To check the key without the CLI, list the models it may use:

curl https://cloud.usevenom.dev/v1/models \
  -H "Authorization: Bearer vck_…"

Keep the setting

The exports last for one shell. Add them to ~/.zshrc or ~/.bashrc:

export PATH="$HOME/.venom/bin:$PATH"
export VENOM_BASE_URL=https://cloud.usevenom.dev/v1
export VENOM_API_KEY=vck_…

Then run venom in a project. Requests show up in the console under Requests, by key name.

Troubleshooting

Symptom Cause and fix
401 from /v1/models The key is wrong, revoked or missing its vck_ prefix. Create a new one under Settings, API keys.
venom: command not found ~/.venom/bin is not on your PATH. Run the export PATH=… line, or add it to your shell profile.
venom doctor FAILs on the endpoint Check VENOM_BASE_URL ends in /v1 and has no trailing slash.