Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/content/docs/agent-platform/cli-agents/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Third-Party CLI Agents
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
2 changes: 2 additions & 0 deletions src/content/docs/agent-platform/cloud-agents/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ 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';

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
2 changes: 2 additions & 0 deletions 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 Down
2 changes: 2 additions & 0 deletions src/content/docs/agent-platform/cloud-agents/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ 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
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
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
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
2 changes: 2 additions & 0 deletions src/content/docs/code/git-worktrees.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Git worktrees
description: >-
Warp natively supports Git worktrees, letting you work on multiple branches
simultaneously with full Code Review, Codebase Context, and Agent support.
sidebar:
label: "Git Worktrees"
---

Warp natively supports [Git worktrees](https://git-scm.com/docs/git-worktree) — a Git feature that lets you check out multiple branches simultaneously in separate directories, all backed by the same repository. This is different from simply switching branches: with worktrees, you can have `~/project` on `main` and `~/project-wt/feature-x` on `feature-x` at the same time, with no stashing or context-switching required.
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
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
2 changes: 2 additions & 0 deletions src/content/docs/getting-started/supported-shells.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ 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
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
Save and share prompts in Warp Drive to automate commits, code reviews, and
PR creation across your team.
sidebar:
label: "Trigger reusable actions with Saved Prompts"
label: "Trigger reusable actions with saved prompts"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
Use Warp to pull, organize, and analyze Cloud Run production logs by
severity with natural language prompts and automated Python scripts.
sidebar:
label: "Analyze Cloud Run logs"
label: "Analyze cloud run logs"
---
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: >-
Use the Context7 MCP server to give Warp agents real-time access to
framework documentation for automated project upgrades.
sidebar:
label: "Context7 MCP: Update Astro project with best practices"
label: "Context7 MCP: update Astro project with best practices"
---
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: >-
Connect Warp to Figma's remote MCP server via OAuth and generate front-end
code directly from your design files.
sidebar:
label: "Figma Remote MCP: Create a website from a Figma file from scratch"
label: "Figma remote MCP: create a website from a Figma file"
---
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: >-
Connect the GitHub MCP server to Warp to summarize open PRs, create issues
from TODO comments, and automate repo management.
sidebar:
label: "GitHub MCP: Summarize open PRs and create GitHub issues"
label: "GitHub MCP: summarize open PRs and create GitHub issues"
---
import VideoEmbed from '@components/VideoEmbed.astro';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
Use Warp's Linear MCP integration to update ticket descriptions, propagate
changes to subtasks, and maintain a lean build strategy.
sidebar:
label: "Linear MCP: Update tickets with a lean build approach"
label: "Linear MCP: update tickets with a lean build approach"
---
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: >-
Configure the Puppeteer MCP server in Warp to automate browser tasks like
navigating sites, scraping product data, and analyzing reviews.
sidebar:
label: "Puppeteer MCP: Scrape Amazon web reviews"
label: "Puppeteer MCP: scrape Amazon web reviews"
---
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: >-
Connect the Sentry MCP server to Warp, fetch live error data, diagnose stack
traces, and auto-generate fixes for production issues.
sidebar:
label: "Sentry MCP: Fix Sentry error in Empower website"
label: "Sentry MCP: fix Sentry error in empower website"
---
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: >-
Connect SQLite and Stripe MCP servers to Warp and run conversational queries
against your local database and payment data.
sidebar:
label: "SQLite and Stripe MCP: Basic queries you can make after setup"
label: "SQLite and Stripe MCP: basic queries you can make after setup"
---
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 @@ -3,6 +3,8 @@ title: Agent Mode Context
description: >-
Agents use your Warp Drive content—Workflows, Notebooks, Rules, MCP Servers,
and Environment Variables—for context-aware responses.
sidebar:
label: "Agent Mode context"
---

[Agent Mode](/agent-platform/local-agents/interacting-with-agents/) can leverage your [Warp Drive](/knowledge-and-collaboration/warp-drive/) contents to tailor responses to your personal and team developer workflows and environments.
Expand Down
Loading
Loading