Skip to content
Merged
6 changes: 6 additions & 0 deletions .agents/references/terminology.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ For the summary of the most critical terms (core features, Oz terms, terms to av
- **Tab** / **Pane** / **Window** — Warp's layout primitives: tabs within windows; panes are splits inside a tab/window.
*Usage note:* Use precisely to avoid confusing layouts.

- **Tab Configs** — Reusable TOML-based tab layout definitions that launch preconfigured terminal sessions.
*Usage note:* Capitalize as a feature name.

- **Vertical Tabs** — The sidebar-based tab management panel that replaces the horizontal tab bar.
*Usage note:* Capitalize as a feature name.

## Agent concepts

- **Ambient Agents** — Oz agents that run automatically in the background on a schedule or trigger, without interactive input.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/agent-platform/capabilities/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Capabilities
title: Capabilities overview
description: >-
Core capabilities and configuration options that shape how agents behave,
what context they have access to, and how they execute tasks.
Expand Down
4 changes: 3 additions & 1 deletion src/content/docs/agent-platform/cli-agents/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Third-Party CLI Agents
title: Third-party CLI agents overview
description: >-
Warp provides first-class support for third-party CLI coding agents with a
rich input editor, notifications, code review, and more.
sidebar:
label: "Overview"
---

Warp auto-detects supported CLI agents and enhances them with IDE-level features — a rich input editor, agent notifications, inline code review, remote session control, and more. Run your preferred coding agent inside Warp and get a better experience out of the box.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Deployment Patterns
description: >-
Common architectures for deploying cloud agents, including CLI-only,
Oz-hosted, and self-hosted execution patterns.
sidebar:
label: "Deployment patterns"
---

Teams adopt cloud agents in a few repeatable ways. This page outlines the most common architectures, what they're good for, and how they fit together.
Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/agent-platform/cloud-agents/faqs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Cloud Agent FAQs
description: >-
Frequently asked questions about cloud agents, including where agents run,
how runs work, supported models, security, and common workflows.
sidebar:
label: "Cloud agent FAQs"
---

This page answers common questions about cloud agents, including where they run, how they're configured, and how teams use cloud agents for day-to-day engineering work.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Cloud Providers (Preview)
description: >-
Connect Oz cloud agents to your AWS and GCP services.
sidebar:
label: "AWS, GCP, and other cloud providers"
---

Oz cloud agents can securely access cloud providers using short-lived OpenID Connect credentials.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Demo: Issue Triage Bot"
description: >-
A walkthrough demo showing how to trigger a cloud agent from a GitHub Action
to automatically triage bug reports and create draft pull requests.
sidebar:
label: "Demo: Issue triage bot"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: GitHub Actions quickstart
description: >-
Set up your first Oz agent in GitHub Actions in ~10 minutes. Run agents as
workflow steps to automate code review and issue triage.
sidebar:
label: "Quickstart"
---

Add Oz agents to your GitHub Actions workflows with [`oz-agent-action`](https://github.com/warpdotdev/oz-agent-action). This quickstart walks you through setting up your first GitHub Actions integration: a PR review workflow that automatically analyzes pull requests and posts inline review comments.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Integrations quickstart
description: >-
Trigger your first Oz agent from Slack in ~15 minutes and get results
in-thread.
sidebar:
label: "Quickstart"
---

Oz integrations let you trigger cloud agents directly from the tools your team already uses. This guide walks you through connecting Oz to Slack. Once set up, anyone on your team can tag @Oz in a message or thread to kick off a cloud agent that runs the task and posts results back to the conversation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: >-
Monitor and manage cloud agent activity across your team with Warp's
centralized management view, including filtering, status tracking, and
session inspection.
sidebar:
label: "Managing cloud agents"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/agent-platform/cloud-agents/mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: MCP Servers
description: >-
Connect cloud agents to external tools, APIs, and internal services using
MCP servers.
sidebar:
label: "MCP servers"
---

Cloud agents can call external tools through [Model Context Protocol (MCP) servers](/agent-platform/capabilities/mcp/). This lets agents reach beyond the terminal to automatically interact with systems like GitHub, dbt, Sentry, or any custom internal service, whenever the workflow requires it.
Expand Down
8 changes: 5 additions & 3 deletions src/content/docs/agent-platform/cloud-agents/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
title: Cloud Agents Overview
title: Cloud agents overview
description: >-
Run background agents in the cloud from events, schedules, or integrations
with team-wide observability.
sidebar:
label: "Cloud agents overview"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Oz Cloud Agents are **cloud-connected**, **background agents** that run on the [Oz Platform](/agent-platform/cloud-agents/platform/).

**New to cloud agents?** Start with the [Cloud Agents Quick Start](/agent-platform/cloud-agents/quickstart/) to run your first cloud agent in ~10 minutes.
**New to cloud agents?** Start with the [Cloud agents quickstart](/agent-platform/cloud-agents/quickstart/) to run your first cloud agent in ~10 minutes.

<VideoEmbed url="https://youtu.be/poLkJhO7fdo" />

Expand Down Expand Up @@ -142,7 +144,7 @@ If your credit balance reaches zero, cloud agent runs will not be able to execut

### Learn more

* [Cloud Agents Quick Start](/agent-platform/cloud-agents/quickstart/) — run your first cloud agent with an environment in ~10 minutes.
* [Cloud agents quickstart](/agent-platform/cloud-agents/quickstart/) — run your first cloud agent with an environment in ~10 minutes.
* [Oz Platform](/agent-platform/cloud-agents/platform/) — CLI, Oz API/SDK, orchestration, tasks, environments, hosts, integrations, and more.
* [Skills as Agents](/agent-platform/cloud-agents/skills-as-agents/) — run agents based on reusable skill definitions from the CLI, web app, API, or on a schedule.
* [Oz CLI](/reference/cli/) — shows how to run Oz agents in non-interactive mode from CI, scripts, or remote machines, including auth and common commands.
Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/agent-platform/cloud-agents/oz-web-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Oz Web App
description: >-
Use the Oz web app to manage cloud agents, view runs, create schedules, and
configure environments and integrations from any browser or mobile device.
sidebar:
label: "Oz web app"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Expand Down
4 changes: 3 additions & 1 deletion src/content/docs/agent-platform/cloud-agents/platform.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Oz Platform
description: >-
The Oz Platform provides the CLI, API/SDK, orchestration, environments, and
observability for cloud agents.
sidebar:
label: "Oz platform"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Expand All @@ -11,7 +13,7 @@ Cloud agents run on the **Oz Platform**. The platform gives you a consistent way
<VideoEmbed url="https://youtu.be/poLkJhO7fdo" />

:::note
**New to cloud agents?** Start with the [Cloud Agents Quick Start](/agent-platform/cloud-agents/quickstart/) to run your first agent in ~10 minutes.
**New to cloud agents?** Start with the [Cloud agents quickstart](/agent-platform/cloud-agents/quickstart/) to run your first agent in ~10 minutes.
:::

**Most production setups follow the same flow:**
Expand Down
6 changes: 4 additions & 2 deletions src/content/docs/agent-platform/cloud-agents/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: Cloud Agents Quick Start
title: Cloud agents quickstart
description: >-
Learn how to run your first Oz cloud agent in ~10 minutes. Cloud agents run
in remote environments, enabling automation, scheduling, and team
collaboration.
sidebar:
label: "Quickstart"
---

**Oz cloud agents** run in a remote environment and can be triggered from events, schedules, integrations, or manually. This enables scaling agents off your laptop, automating development tasks, and building apps on top of agents. Oz handles the orchestration, execution, and observability.
Expand Down Expand Up @@ -99,7 +101,7 @@ Follow the prompts to save your task definition. Once created, you can run it ag

**How this works:** Skills capture successful agent workflows as reusable building blocks. Instead of typing the same prompt repeatedly, you define it once. You can use it yourself, share it with teammates, schedule it to run automatically, or trigger it from integrations. Learn more about [Skills as Agents](/agent-platform/cloud-agents/skills-as-agents/).

**Prefer using the CLI?** See the [Oz CLI Quick Start](/reference/cli/quickstart/) for CLI-based workflows.
**Prefer using the CLI?** See the [Oz CLI quickstart](/reference/cli/quickstart/) for CLI-based workflows.

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Self-hosting
title: Self-hosting overview
description: >-
Run Oz cloud agents on your own infrastructure. Choose between a managed
worker daemon orchestrated by Oz or unmanaged CLI-based execution you
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Managed: Direct backend"
description: >-
Run the Oz managed worker with the Direct backend to execute cloud agent
tasks directly on the host, without Docker or Kubernetes.
sidebar:
label: "Managed: Direct"
---

Run the `oz-agent-worker` daemon with the **Direct backend** — tasks execute directly on the worker host without Docker or Kubernetes. Oz still orchestrates runs end to end (Slack, Linear, schedules, API, `oz agent run-cloud`); the worker just runs the agent in a per-task workspace on its own filesystem.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Managed: Docker backend"
description: >-
Run the Oz managed worker daemon with the Docker backend to execute cloud
agent tasks in isolated containers on your infrastructure.
sidebar:
label: "Managed: Docker"
---

Run the `oz-agent-worker` daemon with the **Docker backend** — the default managed path. Each agent task runs in an isolated Docker container spawned from the worker, with full orchestration by Oz (Slack, Linear, schedules, API, `oz agent run-cloud`).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Managed: Kubernetes backend"
description: >-
Deploy the Oz managed worker into a Kubernetes cluster with the included
Helm chart. Each agent task runs as a Kubernetes Job in your cluster.
sidebar:
label: "Managed: Kubernetes"
---

Deploy the `oz-agent-worker` daemon into a Kubernetes cluster using the included Helm chart. Each agent task runs as a **Kubernetes Job** in your cluster. Oz orchestrates runs end to end (Slack, Linear, schedules, API, `oz agent run-cloud`); your cluster provides the compute, scheduling, and policy enforcement.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Self-hosting quickstart
description: >-
Get a managed self-hosted Oz worker running on Docker and route your first
cloud agent run to it in under 10 minutes.
sidebar:
label: "Quickstart"
---

Run your first Oz cloud agent on your own infrastructure in ~10 minutes using the managed architecture with the Docker backend — the default and fastest path to self-hosting.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Self-hosting troubleshooting
description: >-
Diagnose and fix common problems with self-hosted Oz worker daemons across
Docker, Kubernetes, and Direct backends.
sidebar:
label: "Troubleshooting"
---

Diagnostic guides for the `oz-agent-worker` daemon and its task execution. Use this page when a worker won't start, won't connect, tasks stay queued, or tasks fail.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: >-
Run Oz agents in your existing CI, Kubernetes, or dev environments using the
oz agent run CLI. You orchestrate the runs; Warp provides tracking and
observability.
sidebar:
label: "Unmanaged"
---

With the unmanaged architecture, **you orchestrate agent runs** by invoking `oz agent run` directly from your existing CI pipelines, Kubernetes pods, VMs, or dev boxes. The agent runs on whatever host the command is executed from; Warp tracks the session for you but does not start or stop agents.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Skills as Agents
description: >-
Run agents based on skills for consistent, repeatable workflows. Use skills
with local or cloud agents from the CLI, Oz web app, API, or on a schedule.
sidebar:
label: "Skills as agents"
---

You can start an agent from a [skill](/agent-platform/capabilities/skills/)—a reusable set of instructions that defines what the agent should do. When you run an agent based on a skill, the skill provides the base prompt and behavior, while you supply additional context for that specific run.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: >-
Understand how access to cloud agents works for individuals and teams, how
billing and credits apply, and how Warp maps user identities across
integrations.
sidebar:
label: "Access, billing, and identity"
---

This page explains how access to cloud agents works for both individual users and teams, how billing and credits apply, and how Warp maps user identities across integrations.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Triggers
title: Triggers overview
description: >-
Configure triggers to run cloud agents automatically based on schedules or
events.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Scheduled Agents quickstart
description: >-
Schedule an Oz cloud agent to run recurring tasks automatically — issue
triage, dependency checks, code cleanup, and more.
sidebar:
label: "Quickstart"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Scheduled Agents
description: >-
Run cloud agents on a cron schedule for automated maintenance and recurring
tasks.
sidebar:
label: "Scheduled agents"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Cloud agent session sharing
description: >-
Open, inspect, and steer remote cloud agent runs in real time from Warp or
the web.
sidebar:
label: "Viewing cloud agent runs"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Agent Context
title: Agent context overview
description: >-
How to attach various forms of multi-modal context directly to Warp's Agent
within a prompt.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Code Editor Vim Keybindings
description: >-
Use Vim keybindings in Warp's code editor for keyboard-driven navigation and
editing.
sidebar:
label: "Code editor Vim keybindings"
---

## About Vim keybindings
Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/code/code-editor/find-and-replace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Find and Replace
description: >-
Search and replace text in Warp's code editor with regex, case sensitivity,
and smart case preservation.
sidebar:
label: "Find & replace"
---
import DemoVideo from '@components/DemoVideo.astro';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Getting started with Warp Enterprise
description: >-
Set up Warp Enterprise for your organization with SSO configuration, team
management, and admin controls.
sidebar:
label: "Getting started for admins"
---

This guide walks your IT or platform admin through initial Warp setup for your organization: configuring SSO, creating your team, inviting users, and setting Admin Panel policies.
Expand Down
4 changes: 3 additions & 1 deletion src/content/docs/enterprise/getting-started/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Quick start
title: Enterprise quickstart
description: >-
Get up and running with Warp Enterprise in under 10 minutes. Log in, set up
your terminal, and run your first Oz agent.
sidebar:
label: "Quickstart"
---

This quickstart walks you through the essentials: logging in via SSO, setting up Warp, and running your first Oz agent. You can complete this in under 10 minutes.
Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/enterprise/team-management/admin-panel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: >-
Centralized management for team administrators to configure Warp settings,
control agent behavior, and enforce security policies across your
organization.
sidebar:
label: "Admin panel"
---

The Admin Panel provides administrators with centralized control over team settings in Warp. Configure agent behavior, security policies, codebase indexing, and collaboration features for your entire organization from a single interface.
Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/getting-started/keyboard-shortcuts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Keyboard Shortcuts
description: >-
View, customize, and remap keyboard shortcuts for all Warp features.
sidebar:
label: "Keyboard shortcuts"
---
import { Tabs, TabItem } from '@astrojs/starlight/components';

Expand Down
3 changes: 2 additions & 1 deletion src/content/docs/getting-started/supported-shells.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Supported Shells
description: >-
Warp supports bash, zsh, fish, and PowerShell across macOS, Windows, and
Warp supports bash, zsh, fish, PowerShell, and WSL2 across macOS, Windows,
and Linux.
sidebar:
label: "Supported shells"
---

## Warp default shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
Configure custom agent profiles in Warp to control planning depth, autonomy,
and execution speed — demonstrated with YOLO and Strategic examples.
sidebar:
label: "Configure YOLO and Strategic Agent Profiles"
label: "Configure YOLO and strategic Agent Profiles"
---
import VideoEmbed from '@components/VideoEmbed.astro';
import { Steps } from '@astrojs/starlight/components';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
Create and maintain an AGENTS.md project rules file so coding agents always
understand your project's setup, commands, architecture, and conventions.
sidebar:
label: "Create Project Rules for an existing project"
label: "Create project Rules for an existing project"
---
import VideoEmbed from '@components/VideoEmbed.astro';
import { Steps, FileTree } from '@astrojs/starlight/components';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
Set up a self-serve data analytics workflow in Warp using two community
Skills that map questions to dbt models and structure reproducible analyses.
sidebar:
label: "Set up self-serve data analytics with Skills"
label: "Set up self-serve data analytics with skills"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Expand Down
Loading
Loading