Run agents from your terminal
Run Vidbyte from your terminal
vidbyte-cli is the terminal app for hosted research threads, local coding agents, and reading context from GitHub, Slack, and Google Drive. Start with the quickstart, then connect a platform when a workflow needs it.
One terminal app for hosted and local work
The CLI signs in with a Vidbyte API key. Research runs on Vidbyte's servers, while local runtime commands drive a coding agent installed on your computer.
Hosted research — Open and continue research threads, then read each run's status while it works.
Local runtimes — Run Codex on your computer as a small team, a task board, or one persistent session.
Platform connections — Read a selected repository, pull request, Slack channel, or Drive file as context.
Profiles and configuration — Keep separate accounts and settings, and switch results to JSON for scripts.
What do I need to run it?
Python 3.11 or newer, a Vidbyte account, and a Vidbyte API key. Local coding agents also need Codex installed on your computer. Next-step ideas need no Codex, but the key must include the models:invoke permission.
What does it cost?
Hosted research is paid from your Vidbyte API balance. Local coding agents charge a flat $0.02 per run from that balance, and the model work is billed to your own OpenAI account or Codex subscription. Next-step ideas are billed per model call from that balance, at the model's token rate plus 2%, and need no OpenAI account.
Keep your three credentials apart
The CLI uses three separate credentials, each with its own command. Your Vidbyte key identifies your account, a model key runs local work, and a platform connection lets the CLI read context.
- Vidbyte API key
- What it is forIdentifies your Vidbyte account
- Set it up with
vidbyte-cli login - Model API key
- What it is forRuns models for local runtime commands
- Set it up with
vidbyte-cli provider login openai - Platform connection
- What it is forReads selected GitHub, Slack, or Drive context
- Set it up with
vidbyte-cli connections login github
| Credential | What it is for | Set it up with |
|---|---|---|
| Vidbyte API key | Identifies your Vidbyte account | vidbyte-cli login |
| Model API key | Runs models for local runtime commands | vidbyte-cli provider login openai |
| Platform connection | Reads selected GitHub, Slack, or Drive context | vidbyte-cli connections login github |
Start here
These pages are the shortest route from a fresh install to an agent doing real work.
Quickstart
Run your first agent
Agent skills
Platform connections
Check what's installed
Use vidbyte-cli --help to inspect the installed command tree. Results are written to stdout; progress, diagnostics, warnings, and errors go to stderr.
Inspect the installed CLI
vidbyte-cli --help
vidbyte-cli --version
vidbyte-cli doctor
vidbyte-cli runtime doctorRoot options come first — Options such as
--format,--profile, and--no-inputgo before the command name.JSON output —
--format jsonswitches results to JSON records for scripts and agents.Profiles —
--profile workkeeps a separate set of credentials and settings under a name.