About five minutes
Install and run vidbyte-cli
Go from a fresh Python environment to a signed-in CLI whose local checks pass, ready to run your first agent. Every command installs or runs the published vidbyte-cli package from PyPI.
- Codex
- Claude Code
- OpenCode
- Grok
- Gemini
Let your agent set up vidbyte-cli
Copy a step-by-step prompt for an agent to install the CLI, verify your setup, and walk you through the next safe step. It checks what is already configured first and asks before installing software, handling credentials, or starting paid work.
Get the same prompt from your terminal
CLI setup prompt
vidbyte-cli setup-promptInstall vidbyte-cli from PyPI
The CLI requires Python 3.11 or newer. Install it into a virtual environment so its dependencies stay separate from your other Python projects. Pick your operating system.
Create a virtual environment
Creates an isolated Python environment in a
.venvfolder in the current directory, so the CLI never touches your system Python. On some systems the interpreter is namedpython3instead ofpython.Create
bashpython -m venv .venvActivate it
Points
pythonandpipat the virtual environment for this terminal session. Run it again whenever you open a new terminal.Activate
bashsource .venv/bin/activateInstall the CLI
Downloads the latest release from PyPI and adds the
vidbyte-clicommand. Calling pip throughpython -mmakes sure the install lands in the environment you just activated.Install
bashpython -m pip install vidbyte-cliConfirm the installed version
Prints the installed release number, which proves
vidbyte-cliis on your PATH and tells you which version you are running.Verify
bashvidbyte-cli --version
Create a virtual environment
Creates an isolated Python environment in a
.venvfolder in the current directory, so the CLI never touches your system Python. On some systems the interpreter is namedpython3instead ofpython.Create
bashpython -m venv .venvActivate it
Points
pythonandpipat the virtual environment for this PowerShell session. If PowerShell refuses to run the script, runSet-ExecutionPolicy -Scope CurrentUser RemoteSignedonce, then activate again.Activate
bash.venv\Scripts\Activate.ps1Install the CLI
Downloads the latest release from PyPI and adds the
vidbyte-clicommand. Calling pip throughpython -mmakes sure the install lands in the environment you just activated.Install
bashpython -m pip install vidbyte-cliConfirm the installed version
Prints the installed release number, which proves
vidbyte-cliis on your PATH and tells you which version you are running.Verify
bashvidbyte-cli --version
List the available commands
Shows the full command tree and the root options, such as --format, --profile, and --no-input, which always come before the command name.
Inspect
vidbyte-cli --helpUpgrade to the latest release
Replaces the installed CLI with the newest version published on PyPI. Run it inside the same environment you installed into.
Upgrade
python -m pip install --upgrade vidbyte-cliPrefer a global command? Install with pipx
pipx installs the CLI into its own managed environment and puts vidbyte-cli on your PATH, so it works in every terminal without activating anything. Update it later with pipx upgrade vidbyte-cli.
pipx
pipx install vidbyte-cliSign in to Vidbyte
API-backed research uses your Vidbyte account's usage balance. Local runtime admission also uses that balance by default, while model usage stays billed to your own provider account.
Log in with your Vidbyte API key
Prompts for your key without echoing it, verifies it with Vidbyte, and stores it only when verification succeeds. Create a key on the API Keys settings page first.
Log in
bashvidbyte-cli loginCheck which account is active
Shows the account the stored key belongs to. Run it before sending paid research work so you know which balance will be charged.
Verify
bashvidbyte-cli whoami
Check local runtime prerequisites
The base install is enough for hosted research. For local runtimes, install the Codex extra, then run the doctor and catalog commands before any paid admission.
Install the local runtime extra (optional)
Adds the Codex dependencies used by local runtime commands. If you only run hosted research, skip this step.
Optional extra
bashpython -m pip install "vidbyte-cli[codex]"Diagnose the local host
Reports whether the coding-agent host that local runtimes drive is available on this machine. It is read-only and offline, and it never reads your credentials or repository contents.
Diagnose
bashvidbyte-cli runtime doctorList local runtimes and prices
Fetches the current catalog of local runtime primitives, with the price and supported host for each, so you can see what a run costs before you start one.
Catalog
bashvidbyte-cli runtime list
Set up a model key for local execution
The current persistence and task-board runtimes use an OpenAI model API key. This is a model credential, not a connection to an external work platform.
Store your OpenAI key
Run provider login to enter the key through a hidden prompt; the CLI verifies it before storing it.
Model key
bashvidbyte-cli provider login openaiVerify the stored model key
Rechecks which OpenAI account the CLI model key uses without displaying the key.
Model key check
bashvidbyte-cli provider whoami openai
Want the CLI to read a GitHub repository, a Slack channel, or a Drive file as context? Platform connections are set up on their own page, and their OAuth tokens are stored separately from model keys.