Petra Donka
e12c14e2d5
Updated image source in README to use GitHub link. ## Description <!-- Please remember to add your design buddy onto the PR for review, if it contains any UI changes! --> ## Testing <!-- How did you test this change? What automated tests did you add? If you didn't add any new tests, what's your justification for not adding any? If you're not sure whether you should add a test, check our testing policy: https://www.notion.so/warpdev/How-We-Code-at-Warp-257fe43d556e4b3c8dfd42f70004cc72#1f97825450504baa9c5fd87a737daa09 --> ## Server API dependencies <!-- You may remove this section if your PR does not have any server dependencies. --> - [ ] Is this change necessary to make the client compatible with a desired [server API breaking change](https://www.notion.so/warpdev/How-to-safely-introduce-server-API-breaking-changes-0aa805ff5d5d41fd8834f3c95caba0b4?pvs=4#d55ecf8aea3449949d3c33b0e67f6800)? - [ ] Does this change rely on a [new server API](https://www.notion.so/warpdev/How-to-add-a-new-full-stack-feature-8412cede405a4ec194b32bdd4b951035?pvs=4#04da1e6a493542d68b3e998c7d339640)? - [ ] If so, is the use of this API restricted to client channels that rely on the staging server (e.g. WarpDev)? - [ ] Is this change enabling the use of a server API on client channels that rely on the production server (e.g. WarpStable)? - [ ] If so, has the new server API been stable on production for at least one server release cycle? See [here](https://www.notion.so/warpdev/How-to-add-a-new-full-stack-feature-8412cede405a4ec194b32bdd4b951035?pvs=4#73b202f939834b97ab1fbdf7fc82cd53) for more details. ## Agent Mode - [ ] Warp Agent Mode - This PR was created via Warp's AI Agent Mode ## Changelog Entries for Stable <!-- The entries below will be used when constructing a soft-copy of the stable release changelog. Leave blank or remove the lines if no entry in the stable changelog is needed. Entries should be on the same line, without the `{{` `}}` brackets. You can use multiple lines, even of the same type. The valid suffixes are: * NEW-FEATURE: for new, relatively sizable features. Features listed here will likely have docs / social media posts / marketing launches associated with them, so use sparingly. * IMPROVEMENT: for new functionality of existing features. * BUG-FIX: for fixes related to known bugs or regressions. * IMAGE: the image specified by the URL (hosted on GCP) will be added to Dev & Preview releases. For Stable releases, see the pinned doc in the #release Slack channel. * OZ: Oz-related updates. Use `CHANGELOG-OZ`. At most 4 Oz updates are shown in-app per release. --> CHANGELOG-NEW-FEATURE: {{text goes here...}} CHANGELOG-IMPROVEMENT: {{text goes here...}} CHANGELOG-BUG-FIX: {{text goes here...}} CHANGELOG-BUG-FIX: {{more text goes here...}} CHANGELOG-IMAGE: {{GCP-hosted URL goes here...}} CHANGELOG-OZ: {{text goes here...}}
90 lines
4.3 KiB
Markdown
90 lines
4.3 KiB
Markdown
<a href="https://www.warp.dev">
|
|
<img width="1024" alt="Warp Agentic Development Environment product preview" src="https://github.com/user-attachments/assets/9976b2da-2edd-4604-a36c-8fd53719c6d4" />
|
|
</a>
|
|
|
|
<p align="center">
|
|
<a href="https://www.warp.dev">Website</a>
|
|
·
|
|
<a href="https://www.warp.dev/code">Code</a>
|
|
·
|
|
<a href="https://www.warp.dev/agents">Agents</a>
|
|
·
|
|
<a href="https://www.warp.dev/terminal">Terminal</a>
|
|
·
|
|
<a href="https://www.warp.dev/drive">Drive</a>
|
|
·
|
|
<a href="https://docs.warp.dev">Docs</a>
|
|
·
|
|
<a href="https://www.warp.dev/blog/how-warp-works">How Warp Works</a>
|
|
</p>
|
|
|
|
> [!NOTE]
|
|
> OpenAI is the founding sponsor of the new, open-source Warp repository, and the new agentic management workflows are powered by GPT models.
|
|
|
|
<h1></h1>
|
|
|
|
## About
|
|
|
|
[Warp](https://www.warp.dev) 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
|
|
|
|
You can [download Warp](https://www.warp.dev/download) and [read our docs](https://docs.warp.dev/) for platform-specific instructions.
|
|
|
|
## Licensing
|
|
|
|
Warp's UI framework (the `warpui_core` and `warpui` crates) are licensed under the [MIT license](LICENSE-MIT).
|
|
|
|
The rest of the code in this repository is licensed under the [AGPL v3](LICENSE-AGPL).
|
|
|
|
## Open Source & Contributing
|
|
|
|
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](CONTRIBUTING.md) guide.
|
|
|
|
### Issue to PR
|
|
|
|
Before filing, [search existing issues](https://github.com/warpdotdev/warp/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) for your bug or feature request. If nothing exists, [file an issue](https://github.com/warpdotdev/warp/issues/new/choose) using our templates. Security vulnerabilities should be reported privately as described in [CONTRIBUTING.md](CONTRIBUTING.md#reporting-security-issues).
|
|
|
|
Once filed, a Warp maintainer reviews the issue and may apply a readiness label: [`ready-to-spec`](https://github.com/warpdotdev/warp/issues?q=is%3Aissue+is%3Aopen+label%3Aready-to-spec) signals the design is open for contributors to spec out, and [`ready-to-implement`](https://github.com/warpdotdev/warp/issues?q=is%3Aissue+is%3Aopen+label%3Aready-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
|
|
|
|
To build and run Warp from source:
|
|
|
|
```bash
|
|
./script/bootstrap # platform-specific setup
|
|
./script/run # build and run Warp
|
|
./script/presubmit # fmt, clippy, and tests
|
|
```
|
|
|
|
See [WARP.md](WARP.md) for the full engineering guide, including coding style, testing, and platform-specific notes.
|
|
|
|
## Joining the Team
|
|
|
|
Interested in joining the team? See our [open roles](https://www.warp.dev/careers).
|
|
|
|
## Support and Questions
|
|
|
|
1. See our [docs](https://docs.warp.dev/) for a comprehensive guide to Warp's features.
|
|
2. Join our [Slack Community](https://go.warp.dev/join-preview) to connect with other users and get help from the Warp team.
|
|
3. Try our [Preview build](https://www.warp.dev/download-preview) 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
|
|
|
|
We ask everyone to be respectful and empathetic. Warp follows the [Code of Conduct](CODE_OF_CONDUCT.md). To report violations, email warp-coc at warp.dev.
|
|
|
|
## Open Source Dependencies
|
|
|
|
We'd like to call out a few of the [open source dependencies](https://docs.warp.dev/help/licenses) that have helped Warp to get off the ground:
|
|
|
|
* [Tokio](https://github.com/tokio-rs/tokio)
|
|
* [NuShell](https://github.com/nushell/nushell)
|
|
* [Fig Completion Specs](https://github.com/withfig/autocomplete)
|
|
* [Warp Server Framework](https://github.com/seanmonstar/warp)
|
|
* [Alacritty](https://github.com/alacritty/alacritty)
|
|
* [Hyper HTTP library](https://github.com/hyperium/hyper)
|
|
* [FontKit](https://github.com/servo/font-kit)
|
|
* [Core-foundation](https://github.com/servo/core-foundation-rs)
|
|
* [Smol](https://github.com/smol-rs/smol)
|