Skip to content

docs(WARP): add crate overview section #11445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Arvuno wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(WARP): add crate overview section #11445

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d321c7
docs(WARP): add crate overview section
May 20, 2026
6cd90ae
docs: add crate overview section
May 21, 2026
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
17 changes: 17 additions & 0 deletions WARP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,23 @@ This is a Rust-based terminal emulator with a custom UI framework called **WarpU
- `crates/ipc/` - Inter-process communication
- `crates/graphql/` - GraphQL client and schema

### Crate Overview

The repository is a Cargo workspace with 60+ member crates. Key crates:

- `crates/ai/` — AI integration, agent mode, and context management
- `crates/channel_versions/` — Channel and version management for updates
- `crates/command/` — Command execution and shell integration
- `crates/editor/` — Text editing and buffer management
- `crates/graphql/` — GraphQL client, schema definitions, and query execution
- `crates/http_client/` — HTTP client utilities
- `crates/http_server/` — HTTP server for local Warp server features
- `crates/ipc/` — Inter-process communication between app and server
- `crates/warpui/` and `crates/warpui_core/` — Custom UI framework (Entity-Component-Handle pattern)
- `crates/warp_core/` — Core utilities, platform abstractions, and shared types
- `app/` — Main application binary: terminal emulation, shell management, AI integration, authentication, settings, workspace management
- `crates/integration/` — Integration test framework

### Key Architectural Patterns

1. **Entity-Handle System**: Views reference other views via handles, not direct ownership
Expand Down