Make Galaxy project presentation explicit
This commit is contained in:
@@ -1,112 +1,65 @@
|
||||
<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"><img height="20" alt="Built with Warp" src="https://raw.githubusercontent.com/warpdotdev/brand-assets/main/Github/Built-With-Warp-Export@2x.png" /></a>
|
||||
|
||||
<a href="https://oz.warp.dev"><img height="20" alt="Powered by Oz" src="https://raw.githubusercontent.com/warpdotdev/brand-assets/main/Github/Powered-By-Oz-Export@2x.png" /></a>
|
||||
</p>
|
||||
# Galaxy
|
||||
|
||||
<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>
|
||||
Galaxy is a local-first developer terminal with an agent that works alongside your shell. It is
|
||||
designed to keep your conversations, settings, and personal workspace data on your machine while
|
||||
letting you explicitly connect the model providers and local agents you choose.
|
||||
|
||||
> [!NOTE]
|
||||
> OpenAI is the founding sponsor of the new, open-source Warp repository, and the new agentic management workflows are powered by GPT models.
|
||||
## What Galaxy provides
|
||||
|
||||
<h1></h1>
|
||||
- A fast terminal, editor, and local workspace for development.
|
||||
- Agent conversations with Galaxy-owned permissions for shell, file, and MCP actions.
|
||||
- Provider connections for ChatGPT subscriptions, OpenAI-compatible APIs, Anthropic, Gemini,
|
||||
Vertex AI, AWS Bedrock, and ACP agent runtimes.
|
||||
- Local Galaxy Drive content, including rules, profiles, notebooks, workflows, and MCP settings.
|
||||
- Explicit network boundaries: model traffic goes only to configured providers, and network tools
|
||||
remain opt-in.
|
||||
|
||||
## About
|
||||
## Building from source
|
||||
|
||||
[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).
|
||||
Galaxy is a Rust workspace. Platform setup and the common development tools are installed with:
|
||||
|
||||
## Installation
|
||||
```bash
|
||||
./script/bootstrap
|
||||
```
|
||||
|
||||
You can [download Warp](https://www.warp.dev/download) and [read our docs](https://docs.warp.dev/) for platform-specific instructions.
|
||||
Then build or run the client with:
|
||||
|
||||
## Warp Contributions Overview Dashboard
|
||||
```bash
|
||||
cargo run
|
||||
```
|
||||
|
||||
Explore [build.warp.dev](https://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
|
||||
Before submitting changes, run the repository checks:
|
||||
|
||||
## Oz for OSS
|
||||
```bash
|
||||
./script/format
|
||||
cargo clippy --workspace --all-targets --all-features --tests -- -D warnings
|
||||
cargo test
|
||||
```
|
||||
|
||||
Maintaining a popular open-source project? [Apply for Oz credits](https://tally.so/r/LZWxqG) to explore [Oz for OSS](https://github.com/warpdotdev/oz-for-oss).
|
||||
See [AGENTS.md](AGENTS.md) for architecture notes, platform setup, coding conventions, and the
|
||||
focused commands used by the project.
|
||||
|
||||
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.
|
||||
## Contributing
|
||||
|
||||
Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a change. Bug reports should include
|
||||
reproduction steps, expected and actual behavior, platform details, and relevant logs or
|
||||
screenshots that do not contain secrets. Security issues must be reported privately according to
|
||||
[SECURITY.md](SECURITY.md).
|
||||
|
||||
UI changes should include manual verification, and visual changes should include before-and-after
|
||||
screenshots when practical. Changes to local persistence, provider boundaries, or agent execution
|
||||
should include focused automated coverage.
|
||||
|
||||
## Licensing
|
||||
|
||||
Warp's UI framework (the `warpui_core` and `warpui` crates) are licensed under the [MIT license](LICENSE-MIT).
|
||||
The Galaxy application and most workspace crates are licensed under
|
||||
[AGPL-3.0-only](LICENSE-AGPL). The GalaxyUI crates are licensed under the
|
||||
[MIT License](LICENSE-MIT). Individual third-party components retain the licenses required by
|
||||
their respective notices and source files.
|
||||
|
||||
The rest of the code in this repository is licensed under the [AGPL v3](LICENSE-AGPL).
|
||||
## Project direction
|
||||
|
||||
## 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.
|
||||
|
||||
> [!TIP]
|
||||
> **Chat with contributors and the Warp team** in the [`#oss-contributors`](https://warpcommunity.slack.com/archives/C0B0LM8N4DB) Slack channel — a good place for ad-hoc questions, design discussion, and pairing with maintainers. New here? [Join the Warp Slack community](https://go.warp.dev/join-preview) first, then jump into `#oss-contributors`.
|
||||
|
||||
### 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 [AGENTS.md](AGENTS.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 — contributors hang out in [`#oss-contributors`](https://warpcommunity.slack.com/archives/C0B0LM8N4DB).
|
||||
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)
|
||||
The migration plan in [plans/galaxy-local-first-rig.md](plans/galaxy-local-first-rig.md) records the
|
||||
local-first architecture, provider boundary, and remaining work. Contributions should preserve
|
||||
those boundaries: no inherited Warp service is required for a fresh install, and no provider or
|
||||
agent may bypass Galaxy's permission and egress policy.
|
||||
|
||||
Reference in New Issue
Block a user