1. Project Overview & Quickstart (warpdotdev/warp) Copy Chapter

[!NOTE]
OpenAI is the founding sponsor of the new, open-source Warp repository, and the new agentic management workflows are powered by GPT models.

About Copy Chapter

Warp is an agentic development environment, born out of the terminal. Use Warp's built-in coding agent, or bring your own CLI agent (Claude Code, Codex, Gemini CLI, and others).

Installation Copy Chapter

You can download Warp and read our docs for platform-specific instructions.

Warp Contributions Overview Dashboard Copy Chapter

Explore build.warp.dev to:

• Watch thousands of Oz agents triage issues, write specs, implement changes, and review PRs
• View top contributors and in-flight features
• Track your own issues with GitHub sign-in
• Click into active agent sessions in a web-compiled Warp terminal

Oz for OSS Copy Chapter

Maintaining a popular open-source project? Apply for Oz credits to explore Oz for OSS.

Oz for OSS is our partner program for bringing the same agentic open-source management workflows used in this repository to select partner repositories. We work directly with maintainers to implement workflows for issue triage, PR review, community management, and contributor coordination in a way that fits each project.

Licensing Copy Chapter

Warp's UI framework (the warpui_core and warpui crates) are licensed under the MIT license.

The rest of the code in this repository is licensed under the AGPL v3.

Open Source & Contributing Copy Chapter

Warp's client codebase is open source and lives in this repository. We welcome community contributions and have designed a lightweight workflow to help new contributors get started. For the full contribution flow, read our CONTRIBUTING.md guide.

[!TIP]
Chat with contributors and the Warp team in the #oss-contributors Slack channel — a good place for ad-hoc questions, design discussion, and pairing with maintainers. New here? Join the Warp Slack community first, then jump into #oss-contributors.

Issue to PR Copy Section

Before filing, search existing issues for your bug or feature request. If nothing exists, file an issue using our templates. Security vulnerabilities should be reported privately as described in CONTRIBUTING.md.

Once filed, a Warp maintainer reviews the issue and may apply a readiness label: ready-to-spec signals the design is open for contributors to spec out, and ready-to-implement signals the design is settled and code PRs are welcome. Anyone can pick up a labeled issue — mention @oss-maintainers on an issue if you'd like it considered for a readiness label.

Building the Repo Locally Copy Section

To build and run Warp from source:

./script/bootstrap   # platform-specific setup
./script/run         # build and run Warp
./script/presubmit   # fmt, clippy, and tests

See AGENTS.md for the full engineering guide, including coding style, testing, and platform-specific notes.

Joining the Team Copy Chapter

Interested in joining the team? See our open roles.

Support and Questions Copy Chapter

1. See our docs for a comprehensive guide to Warp's features.
2. Join our Slack Community to connect with other users and get help from the Warp team — contributors hang out in #oss-contributors.
3. Try our Preview build to test the latest experimental features.
4. Mention @oss-maintainers on any issue to escalate to the team — for example, if you encounter problems with the automated agents.

Code of Conduct Copy Chapter

We ask everyone to be respectful and empathetic. Warp follows the Code of Conduct. To report violations, email warp-coc at warp.dev.

Open Source Dependencies Copy Chapter

We'd like to call out a few of the open source dependencies that have helped Warp to get off the ground:

• Tokio
• NuShell
• Fig Completion Specs
• Warp Server Framework
• Alacritty
• Hyper HTTP library
• FontKit
• Core-foundation
• Smol

2. Official Technical Reference & Guides (warpdotdev/docs) Copy Chapter

Warp Docs

Source content for docs.warp.dev, the documentation site for Warp and the Oz agent platform.

About Copy Chapter

Warp is an agentic development environment, born out of the terminal. This repository contains the public documentation for Warp's terminal, editor, agents, collaboration features, API, and support content.

The site is built with Astro and Starlight. Content is written in MDX and organized under src/content/docs/.

Building the project Copy Chapter

Node.js 20.19+, 22.12+, or 24 is required. The supported versions match Astro 6's runtime requirements and are enforced in package.json.

Install dependencies:

npm install

Start the local development server:

npm run dev

Open http://localhost:4321 to preview the docs site locally.

Environment variables Copy Chapter

The site runs without local environment variables. To enable optional integrations like the Ask AI button, copy .env.example to .env and fill in the public values:

cp .env.example .env

Repository structure Copy Chapter

Content lives in src/content/docs/, organized by product area:

• terminal/ - Warp terminal features, including blocks, sessions, editor behavior, and appearance.
• code/ - Code editor, code review, and Git worktree documentation.
• getting-started/ - Installation, quickstarts, migration guides, and onboarding content.
• knowledge-and-collaboration/ - Warp Drive, teams, and Admin Panel documentation.
• agent-platform/ - Agent Platform docs, including agent capabilities, local agents, CLI agents, and cloud agents.
• reference/ - CLI, API, SDK, keyboard shortcut, and technical reference docs.
• support-and-community/ - Troubleshooting, billing, privacy, and support content.
• enterprise/ - Enterprise features, SSO, and team management documentation.
• changelog/ - Public release changelog.
• university/ - Guides and tutorials.

Sidebar structure is configured in astro.config.mjs. Redirects are configured in vercel.json.

Contributing Copy Chapter

The Warp docs are open source, and contributions are welcome. For substantial changes, open or comment on an issue first so the docs team can align on scope. Small fixes like typo corrections, broken links, and minor clarifications can go straight to a pull request.

Read CONTRIBUTING.md for the full contribution flow, local setup, style expectations, and pull request checklist.

Agent skills Copy Chapter

The .warp/skills/ directory contains agent skills used by the Warp docs team for automated workflows, including style linting, link checking, changelog updates, and terminology syncing. The skills are included for transparency and as examples of how Oz skills can automate documentation workflows. See warpdotdev/oz-skills for more examples.

Some skills depend on internal Warp repositories (warp-internal, warp-server) and won't run end-to-end without access to those codebases.

Support and questions Copy Chapter

• Browse the published Warp docs.
• Join the Slack Community to connect with other users and contributors.
• Open a GitHub issue for docs bugs, missing coverage, or suggested improvements.

Code of Conduct and security Copy Chapter

This project follows Warp's Code of Conduct. Report security issues through the private channels described in Warp's security policy, not through public issues.

License Copy Chapter

Warp Docs is licensed under the MIT License.