Beginner's guide

Get started with OzBridge
in a few minutes

Use Warp's AI agents straight from VS Code chat. No technical background needed — follow the steps and you'll be up and running.

Let's go →

How it works

💬 You type in chat
🔌 OzBridge
⚙️ Oz CLI
🤖 AI agent
✅ Result in chat
1

What you need before you start

💻

VS Code

Microsoft's editor — free and cross-platform.

≥ 1.96.0
🤖

GitHub Copilot Chat

The AI chat extension for VS Code. Required for the @oz panel.

any version

Warp Terminal

The advanced terminal that ships the “Oz” agent CLI.

latest stable
🔑

Warp account

Free sign-up at app.warp.dev.

free
2

Install Warp and the Oz CLI

🪟 Windows
🍎 macOS
🐧 Linux
1

Download Warp

Go to warp.dev and download the Windows installer. Run it and follow the wizard.

Downloading and installing Warp on Windows
⬇️
GIF: Downloading and installing Warp on Windows
GIF · 16:9 · ~800×450px
2

Check that Oz is on your PATH

Open PowerShell and run:

PowerShell
PS C:\> where oz
C:\Users\YourName\AppData\Local\Programs\Warp\oz.cmd
Checking Oz on the PATH from PowerShell
GIF: Checking Oz on the PATH from PowerShell
GIF · 16:9
3

First sign-in

Authenticate with your Warp account:

PowerShell
PS C:\> oz auth login
Opening browser for authentication...
✓ Successfully logged in!
Signing in with Oz
🔑
GIF: Signing in with Oz (browser opens → callback)
GIF · 16:9
1

Install with Homebrew

Terminal
$ brew install warp
$ which oz
/Applications/Warp.app/Contents/MacOS/oz
$ oz auth login
✓ Successfully logged in!

Alternatively, download the .dmg from warp.dev.

1

Install from the website

Follow the instructions for your distribution at warp.dev, then verify:

Terminal
$ which oz
~/.warp/bin/oz
$ oz auth login
✓ Successfully logged in!
3

Install the extension in VS Code

1

Install the VSIX file

Open VS Code's integrated terminal (Ctrl+`) and run:

VS Code Terminal
PS> code --install-extension ozbridge.vsix
Extension 'ozbridge.vsix' was successfully installed.
Installing the VSIX from the VS Code terminal
📦
GIF: Installing the VSIX from the VS Code terminal
GIF · 16:9
2

Reload the window

Press Ctrl+Shift+P, type Reload Window and press Enter.

Reload Window from the Command Palette
🔄
GIF: Reload Window from the Command Palette
GIF · 16:9
💡 Alternative — from source

If you are a developer, clone the repository, run npm install && npm run build and press F5 to launch the Extension Development Host.

4

First run and health check

Let's confirm everything works with a single command:

W
Copilot Chat — @oz
You
@oz /config
W
⚙️ OzBridge configuration
────────────────────────
Available — version: unknown
Model: auto
Profile: Default
Timeout: 300 s
First run — @oz /config in chat
🎬
GIF: First run — typing @oz /config in chat and seeing the reply
GIF · 16:9
✅ All good?

If you see “✅ Available” you're ready. If you see “❌ Not available” head to Troubleshooting.

5

Basic usage

Everything happens in Copilot Chat. Always start with @oz.

🚀

Local run — /run

W
Copilot Chat
You
@oz /run fix the bug in the login function
W
🔄 Agent running...

Done
Found and fixed the bug: isAuthenticated was not being updated after the token refresh...
Running /run — the agent analyses and fixes the code
🚀
GIF: Running /run — the agent analyses and fixes the code
GIF · 16:9
💡 Tip

Select some code in the editor before sending the command: the agent picks it up as extra context and gives better results.

☁️

Cloud run — /cloud

W
Copilot Chat
You
@oz /cloud run the tests and generate the coverage report
W
☁️ Task sent to the cloud — ID: run-a7f3
⏳ Queued... → 🔄 Running... → ✅ Done!

Coverage: 98.15% statements, 98.68% lines.
⚠️ Heads up — credits

Cloud runs consume credits from your Warp account. Local runs (/run) are free.

📊

Run status — /status

W
Copilot Chat
You
@oz /status
W
📋 Recent runs:
run-a7f3 — ✅ SUCCEEDED — 2 min ago
run-b291 — 🔄 RUNNING — 30 sec ago
🏗️

Initialise a project — /init

The first time you use Warp in a project, run @oz /init to scaffold the configuration files automatically:

Result
Created .agents/skills/ with 7 SKILL.md files
Created .warp/rules/PROJECT.md
Project scaffolding with /init
🏗️
GIF: Project scaffolding with /init
GIF · 16:9
6

Every available command

/run

Run an AI agent locally in your workspace.

@oz /run refactor this function
/cloud

Run an agent in the cloud (consumes credits).

@oz /cloud deploy to staging
/status

Check the status of recent runs.

@oz /status run-a7f3
/schedule

Create and manage scheduled runs (cron).

@oz /schedule list
/models

List the available AI models.

@oz /models
/mcp

List the configured MCP servers.

@oz /mcp
/config

Show the current configuration and CLI status.

@oz /config
/init

Generate the Skills and Rules files in the workspace.

@oz /init

/schedule sub-commands

list

Show every schedule.

@oz /schedule list
create

Create a new cron schedule.

@oz /schedule create lint "0 9 * * *" "Run lint"
pause / unpause

Pause or resume a schedule.

@oz /schedule pause sched-123
delete

Delete a schedule.

@oz /schedule delete sched-123
7

Customise the settings

Open VS Code settings (Ctrl+,) and search for ozBridge.

VS Code settings — OzBridge options
⚙️
GIF: Opening VS Code settings and changing OzBridge options
GIF · 16:9
Setting Default Description
ozPath oz Path to the Oz CLI. Change it only if Oz is not on your PATH.
defaultModel auto Default AI model. auto lets Warp pick the best one.
defaultProfile Default Agent profile to use.
defaultEnvironment (empty) Default cloud environment for /cloud.
timeoutMs 300000 Timeout for local runs (5 minutes). Raise it for long tasks.
cloudPollingIntervalMs 15000 Polling interval for cloud tasks (ms).
cloudPollingTimeoutMs 1800000 Maximum wait for a cloud task (30 min).
maxOutputChars 15000 Maximum output length in chat. Raise it if replies get truncated.

Common scenarios

⏱️

The agent times out

Set ozBridge.timeoutMs to 600000 (10 min) or higher.

🧠

You want a specific model

Set ozBridge.defaultModel to gpt-4o, claude-sonnet, and so on.

✂️

The reply gets truncated

Raise ozBridge.maxOutputChars to 15000 or 20000 if your output is very long.

8

Getting the most out of it

🎯 The extension automatically sends the agent:

📄

Open file

The contents of the active editor file.

🔦

Current selection

The selected code, if any.

⚠️

Errors and warnings

The diagnostics visible in the current file.

📁

Workspace

The project path and structure.

✍️ Write clear prompts

❌ Too vague
  • “fix the code”
  • “do the tests”
  • “improve everything”
  • “deploy”
✅ Clear and specific
  • “add error handling to fetchUser()”
  • “write unit tests for auth.ts”
  • “split the Sidebar component into sub-components”
  • “create a Dockerfile for the Node.js backend”

🗺️ Pick the right command

SituationCommand
Quick code change@oz /run ...
Long or heavy operation@oz /cloud ...
First project setup@oz /init
Check everything works@oz /config
Automate a recurring check@oz /schedule create ...
9

Troubleshooting common problems

❌ The Oz CLI is not found

Symptom: @oz /config shows “❌ Not available”.

Fixes:

1. Check that Warp is installed — open a terminal and run where oz (Windows) or which oz (macOS/Linux).

2. If the command is not found, go to Settings → ozBridge.ozPath and enter the full path to Oz.

3. After changing it, reload VS Code: Ctrl+Shift+PReload Window.

🔑 Authentication error

Open a terminal and run oz auth login. A browser opens for you to re-authenticate. After signing in, go back to VS Code and try again.

⏱️ The agent times out

Raise the timeout in settings:

• Local runs: ozBridge.timeoutMs (default 300,000 ms = 5 min)

• Cloud runs: ozBridge.cloudPollingTimeoutMs (default 1,800,000 ms = 30 min)

• For very heavy work, use /cloud instead of /run.

💬 Chat does not show @oz

1. Check that GitHub Copilot Chat is installed and enabled.

2. VS Code must be version ≥ 1.96.0.

3. Reload the window: Ctrl+Shift+PReload Window.

4. Check the OzBridge extension is enabled: Ctrl+Shift+X → search “OzBridge”.

✂️ Chat output is truncated

Raise ozBridge.maxOutputChars in settings (default: 15000). Try 20000 or more only if you genuinely need longer transcripts.

G

Glossary

Agent
An AI program that performs tasks on your code (analysis, writing, review, tests…).
CLI
Command Line Interface — a program you drive from a terminal. Oz is Warp's CLI.
Chat Participant
A VS Code extension that answers in Copilot Chat under a handle such as @oz.
Cloud run
An agent run on Warp's servers (consumes credits).
Local run
An agent run on your own machine (free).
MCP
Model Context Protocol — the standard for connecting context servers to AI models.
Oz
The CLI bundled with Warp for driving agents, models, schedules and integrations.
Prompt
The text you type in chat to tell the agent what to do.
Skills
.md files describing what each agent in the 7-stage pipeline is good at.
Slash command
A command prefixed with / in chat (e.g. /run, /cloud).
VSIX
The VS Code extension package format (a special kind of .zip).
Workspace
The project folder currently open in VS Code.