Warp

https://docs.warp.dev/
Admin
Warp is a modern, AI-powered terminal for developers, offering advanced features like code...
Tokens:211,046
Snippets:3,624
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run the demo application

Source: https://docs.warp.dev/guides/external-tools/sentry-mcp-fix-sentry-error-in-empower-website

Commands to install dependencies and start the Empower Plant demo application.

```bash
npm installnpm start
```

--------------------------------

### Create an environment with guided setup

Source: https://docs.warp.dev/platform/environments

Use this command to have Warp automatically inspect repositories and recommend configuration settings.

```bash
# Local file paths/create-environment ./warp-internal ./warp-server
/create-environment warpdotdev/warp-internal warpdotdev/warp-server
# GitHub URLs/create-environmenthttps://github.com/warpdotdev/warp-internal.git
```

--------------------------------

### Guided Environment Creation

Source: https://docs.warp.dev/reference/cli/integration-setup

Use the /create-environment command to trigger an automated setup flow based on local paths or GitHub repository URLs.

```bash
# File paths/create-environment ./warp-internal ./warp-server
/create-environment warpdotdev/warp-internal warpdotdev/warp-server
# GitHub URLs/create-environment https://github.com/warpdotdev/warp-internal.git
```

--------------------------------

### Run worker with all flags via Docker

Source: https://docs.warp.dev/platform/self-hosting/reference

Example command demonstrating how to start the worker container with various configuration flags, including volume mounts and environment variable passthrough.

```bash
docker run -v /var/run/docker.sock:/var/run/docker.sock \
  -e WARP_API_KEY="$WARP_API_KEY" \
  warpdotdev/oz-agent-worker \
  --worker-id "prod-runner-1" \
  --log-level debug \
  --no-cleanup \
  --max-concurrent-tasks 4 \
  --idle-on-complete 10m \
  -v /opt/shared-cache:/cache:ro \
  -e NPM_TOKEN=your_token \
  -e GITHUB_TOKEN
```

--------------------------------

### Install and Run via Go

Source: https://docs.warp.dev/platform/self-hosting/managed-docker

Install the worker binary directly using the Go toolchain.

```bash
go install github.com/warpdotdev/oz-agent-worker@latest
oz-agent-worker --api-key "$WARP_API_KEY" --worker-id "my-worker"
```

--------------------------------

### Run Worker with CLI Flags

Source: https://docs.warp.dev/platform/self-hosting/managed-docker

Example command to start the worker container with common configuration flags and volume mounts.

```bash
docker run -v /var/run/docker.sock:/var/run/docker.sock \
  -e WARP_API_KEY="$WARP_API_KEY" \
  warpdotdev/oz-agent-worker \
  --worker-id "prod-runner-1" \
  --log-level debug \
  --max-concurrent-tasks 4 \
  --idle-on-complete 10m \
  -v /opt/shared-cache:/cache:ro \
  -e NPM_TOKEN=your_token \
  -e GITHUB_TOKEN
```

--------------------------------

### Install OpenCode via shell script

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-opencode

Use the official installation script to quickly set up OpenCode on your system.

```bash
curl -fsSL https://opencode.ai/install | bash
```

--------------------------------

### Install Ollama on Windows

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-ollama

Use PowerShell to download and execute the installation script for Windows.

```powershell
irm https://ollama.com/install.ps1 | iex
```

--------------------------------

### Install Gemini CLI

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-gemini-cli

Use these commands to install the Gemini CLI globally on your system.

```bash
npm install -g @google/gemini-cli
```

```bash
brew install gemini-cli
```

--------------------------------

### Install common skills

Source: https://docs.warp.dev/guides/agent-workflows/write-product-and-tech-specs-with-agents

Install the required product and tech spec skills globally using npx.

```bash
npx skills@latest add warpdotdev/common-skills --skill write-product-spec --agent warp --global
npx skills@latest add warpdotdev/common-skills --skill write-tech-spec --agent warp --global
```

--------------------------------

### Create a cloud environment

Source: https://docs.warp.dev/enterprise/getting-started/quickstart

Launch the interactive setup flow for a new cloud execution environment.

```bash
/create-environment
```

--------------------------------

### Verify Docker installation

Source: https://docs.warp.dev/platform/self-hosting/managed-docker

Check that the Docker daemon is running and accessible before starting the worker.

```bash
docker info
```

--------------------------------

### Create a first-party integration via CLI

Source: https://docs.warp.dev/platform/overview

Use this command to initiate the setup flow for first-party integrations.

```bash
oz integration create …
```

--------------------------------

### Update environment setup commands

Source: https://docs.warp.dev/reference/cli/troubleshooting

Install missing tools or dependencies directly within the environment configuration.

```bash
oz environment update --setup-command "apt-get update && apt-get install -y "
```

--------------------------------

### Initialize and Open Project Rules

Source: https://docs.warp.dev/guides/configuration/how-to-create-project-rules-for-an-existing-project-astro-typescript-tailwind

Use these commands to generate a starter Warp.md file and open it in the side editor for customization.

```text
/init
```

```text
/open-project-rules
```

--------------------------------

### GET /agent/runs/{runId}/timeline

Source: https://docs.warp.dev/api

Retrieve chronological setup and lifecycle timeline events for an agent run.

```APIDOC
## GET /agent/runs/{runId}/timeline

### Description
Retrieve chronological setup and lifecycle timeline events for an agent run.

### Method
GET

### Endpoint
/agent/runs/{runId}/timeline

### Parameters
#### Path Parameters
- **runId** (string) - Required - The unique identifier of the run
```

--------------------------------

### Create a Bitbucket-enabled environment

Source: https://docs.warp.dev/platform/integrations/bitbucket

Configure a new environment with setup commands to clone a repository using the stored API token. Ensure single quotes are used for setup commands to prevent premature shell expansion of the secret variable.

```bash
oz environment create \
  --name "my-bitbucket-cloud-env" \
  --docker-image <image> \
  --setup-command 'git clone https://x-bitbucket-api-token-auth:$BITBUCKET_API_TOKEN@bitbucket.org/your-workspace/your-repo.git' \
  --setup-command 'cd your-repo && <install dependencies>'
```

--------------------------------

### Example Integration Not Configured Error Response

Source: https://docs.warp.dev/reference/api-and-sdk/troubleshooting/errors/integration-not-configured

This JSON response illustrates the structure of an integration_not_configured error, including the integration name and a setup URL.

```json
{
  "type": "/reference/api-and-sdk/troubleshooting/errors/integration-not-configured/",
  "title": "Slack integration is not configured",
  "status": 400,
  "instance": "/api/v1/agent/tasks",
  "error": "Slack integration is not configured",
  "retryable": false,
  "integration_name": "slack",
  "setup_url": "https://oz.warp.dev/integrations"
}
```

--------------------------------

### Define Windows in Launch Configuration

Source: https://docs.warp.dev/terminal/sessions/launch-configurations

Example structure for defining multiple windows with individual tabs and working directories.

```yaml
# Warp Launch Configuration## This configuration has two windows,# each with one tab in different starting directories.
---
name: Example Windows
windows:
  - tabs:
      - title: Documents
        layout:
          cwd: /Users/warp-user/Documents
        color: blue
  - tabs:
      - title: Warp User
        layout:
          cwd: /Users/warp-user
        color: green
```

--------------------------------

### Initialize Gemini CLI

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-gemini-cli

Run this command to start the authentication flow for the first time.

```bash
gemini
```

--------------------------------

### Example Tech Stack Preferences Rule

Source: https://docs.warp.dev/guides/configuration/how-to-set-tech-stack-preferences-with-rules

Define preferred frameworks and build tools for different project types. This rule guides the AI to use specific technologies and avoid legacy stacks.

```plaintext
Rule: Tech Stack Preferences- Use Astro for websites.- Use SvelteKit for desktop apps.- Prefer Vite for build tooling.- Avoid legacy stacks like Create React App or Express.
```

--------------------------------

### Create an environment with a setup command

Source: https://docs.warp.dev/platform/integrations/azure-devops

Configures a new environment with setup commands to clone a repository using the injected secret. Use single quotes to prevent premature shell expansion of the secret variable.

```bash
oz environment create \
  --name "my-azure-devops-env" \
  --docker-image <image> \
  --setup-command 'git clone https://$AZURE_DEVOPS_TOKEN@dev.azure.com/your-org/your-project/_git/your-repo' \
  --setup-command 'cd your-repo && <install dependencies>'
```

--------------------------------

### Manually install the Claude Code notification plugin

Source: https://docs.warp.dev/agents/cli-agents/claude-code

Use these commands to install the notification plugin if the auto-install feature is unavailable. Requires jq to be installed on the system.

```bash
/plugin marketplace add warpdotdev/claude-code-warp/plugin install warp@claude-code-warp
```

```bash
claude plugin marketplace add warpdotdev/claude-code-warpclaude plugin install warp@claude-code-warp
```

--------------------------------

### Verify CLI Installation

Source: https://docs.warp.dev/agents/cli/quickstart

Check the installed version of the Warp CLI.

```bash
warp --version
```

--------------------------------

### Build and Run from Source

Source: https://docs.warp.dev/platform/self-hosting/managed-docker

Clone the repository, compile the binary, and execute the worker.

```bash
git clone https://github.com/warpdotdev/oz-agent-worker.git
cd oz-agent-worker
go build -o oz-agent-worker
./oz-agent-worker --api-key "$WARP_API_KEY" --worker-id "my-worker"
```

--------------------------------

### GET /agent/schedules/{scheduleId}

Source: https://docs.warp.dev/api

Get details for a specific scheduled agent.

```APIDOC
## GET /agent/schedules/{scheduleId}

### Description
Retrieve detailed information about a specific scheduled agent.

### Method
GET

### Endpoint
/agent/schedules/{scheduleId}

### Parameters
#### Path Parameters
- **scheduleId** (string) - Required - The unique identifier of the scheduled agent
```

--------------------------------

### Verify Codex CLI installation

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-codex-cli

Check the installed version of the Codex CLI.

```bash
codex --version
```

--------------------------------

### Configure Active Window, Tab, and Focus

Source: https://docs.warp.dev/terminal/sessions/launch-configurations

Example showing how to set the active window, active tab, and focused pane using index and boolean flags.

```yaml
# Warp Launch Configuration## This configuration has two tabs, with the second tab active.# Two vertical split panes in the first tab and the top pane focused.# Two horizontal split panes in the second tab and the right pane focused.---
name: Example Active and Focus
active_window_index: 0
windows:
  - active_tab_index: 1
    tabs:
      - title: Tab 1
        layout:
          split_direction: vertical
          panes:
            - cwd: /Users/warp-user/Documents
              is_focused: true
            - cwd: /Users/warp-user/Documents/Projects
      - title: Tab 2
        layout:
          split_direction: horizontal
          panes:
            - cwd: /Users/warp-user/Downloads
            - cwd: /Users/warp-user
              is_focused: true
```

--------------------------------

### Start a Postgres REPL

Source: https://docs.warp.dev/guides/devops/how-to-write-sql-commands-inside-a-postgres-repl

Connect to your PostgreSQL database using the psql command-line tool to enter the interactive REPL.

```bash
psql -U postgres -d my_database
```

--------------------------------

### Install Warp Agent CLI

Source: https://docs.warp.dev/agents/cli/quickstart

Commands to install the CLI on macOS/Linux or Windows.

```bash
curl -fsSL https://app.warp.dev/download/agent-cli | bash
```

```powershell
Invoke-RestMethod "https://app.warp.dev/download/agent-cli.ps1" | Invoke-Expression
```

--------------------------------

### Launch a Gemini CLI Session

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-gemini-cli

Navigate to a project directory and start the CLI.

```bash
cd ~/your-projectgemini
```

--------------------------------

### Example Claude Code Prompts

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-claude-code

Examples of tasks that can be requested once a session is active.

```text
Explain the architecture of this project
```

```text
Add input validation to the user registration endpoint
```

--------------------------------

### Initialize project context

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-opencode

Run the /init command within the TUI to generate the AGENTS.md configuration file.

```text
/init
```

--------------------------------

### Example environment_setup_failed response

Source: https://docs.warp.dev/reference/api-and-sdk/troubleshooting/errors/environment-setup-failed

A JSON response object illustrating the structure of an environment_setup_failed error.

```json
{
  "type": "/reference/api-and-sdk/troubleshooting/errors/environment-setup-failed/",
  "title": "Failed to clone repository: branch 'main' not found in acme/backend",
  "status": 500,
  "instance": "/api/v1/agent/tasks",
  "error": "Failed to clone repository: branch 'main' not found in acme/backend",
  "retryable": false
}
```

--------------------------------

### Install Warp on Linux

Source: https://docs.warp.dev/enterprise/getting-started/getting-started-developers

Commands for installing the Warp terminal on Debian/Ubuntu and Fedora/RHEL distributions.

```bash
# Debian/Ubuntusudo dpkg -i warp-terminal_*.deb
# Fedora/RHELsudo rpm -i warp-terminal-*.rpm
```

--------------------------------

### Compare safe and unsafe setup commands

Source: https://docs.warp.dev/platform/environments

Use idempotent commands to ensure environment stability across runs. Avoid commands that may fail on subsequent executions or cause configuration drift.

```bash
# Safer patterns (repeatable and stable)mkdir -p .cachenpm ci
# Less safe patterns (can fail on rerun or drift over time)mkdir .cachenpm install
```

--------------------------------

### Install samply on Windows

Source: https://docs.warp.dev/support-and-community/troubleshooting-and-support/sending-us-feedback

Installs the samply tool for recording CPU traces via PowerShell.

```powershell
powershell -ExecutionPolicy Bypass -c "irm https://github.com/mstange/samply/releases/download/samply-v0.13.1/samply-installer.ps1 | iex"
```

--------------------------------

### Example provider resource name output

Source: https://docs.warp.dev/enterprise/enterprise-features/byollm-gemini-enterprise

The expected format returned by the describe command.

```text
projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID
```

--------------------------------

### Verifying CLI Installation

Source: https://docs.warp.dev/reference/cli/troubleshooting

Check the installed version of the CLI to confirm it is correctly configured in your path.

```bash
oz --version
```

--------------------------------

### Launch OpenCode in a project directory

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-opencode

Navigate to the target project folder and execute the opencode command to start the TUI.

```bash
cd ~/your-projectopencode
```

--------------------------------

### Verify Gemini CLI Installation

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-gemini-cli

Check that the Gemini CLI is correctly installed and accessible in your terminal.

```bash
gemini --version
```

--------------------------------

### Project Development Commands

Source: https://docs.warp.dev/guides/configuration/how-to-create-project-rules-for-an-existing-project-astro-typescript-tailwind

Standard commands for managing dependencies, starting the development server, and building the project.

```bash
# Install dependencies
npm install
# Set up environment (Firebase config is public but consider security)
# No additional env setup needed for development
# Development server
npm run dev
```

--------------------------------

### Display Help Information

Source: https://docs.warp.dev/agents/cli/reference

Prints usage information for all available CLI flags.

```bash
warp --help
```

--------------------------------

### Install Codex CLI

Source: https://docs.warp.dev/guides/external-tools/how-to-set-up-codex-cli

Global installation commands for Codex CLI using npm or Homebrew.

```bash
npm install -g @openai/codex
```

```bash
brew install codex
```

--------------------------------

### Install Warp via RPM package

Source: https://docs.warp.dev/getting-started/quickstart/installation-and-setup

Installs a downloaded RPM package using zypper.

```bash
sudo zypper install ./<file>.rpm
```

--------------------------------

### Start Warp CLI

Source: https://docs.warp.dev/agents/cli/quickstart

Initialize the CLI to begin the login process.

```bash
warp
```

--------------------------------

### Initialize Git Repository and Commit

Source: https://docs.warp.dev/guides/build-an-app-in-warp/building-a-chrome-extension-d3js-javascript-html-css

Initialize a Git repository and commit the initial project files for version control.

```bash
git init
git add .
git commit -m "Initial Sankey
Stone
extension"
```
Tokens:
Raw