mirror of
https://github.com/coder/coder.git
synced 2026-11-01 12:53:26 +08:00
Ben Potter
4ed03f5ee2
Points README readers to the right places and cuts redundancy. ## Links - Dev Containers now links to the docs, so people land on setup steps instead of the envbuilder repo - Why Coder now links to the docs (https://coder.com/docs/about#why-coder) instead of the marketing page - Removed JetBrains Gateway Plugin (retired) - Removed the community Terraform provisioning link (outdated) - Added AI Gateway to the docs section, since it's not discoverable otherwise - Added Coding Agents, pointing to the registry modules for running Claude Code, Codex, and OpenCode isolated in Coder workspaces - Added the Terraform provider (coderd) for declaratively managing Coder deployment configuration as code - Added the Coder Agents Chat Action under community integrations - Moved Coder Discord to the top of the community list and clarified it's where to get support and hear about new product updates first ## Structure - Merged the redundant Quickstart and Install sections into one install → try locally → production flow, with a note up top pointing to the install guides. `coder server` now appears once per purpose instead of three times - Windows install now says "latest binary or installer" and links to GitHub Releases - Support section now spells out what goes where: issues for bugs and feature requests, Discord and GitHub Discussions for community support and showcasing what you built, and dedicated support included in Coder Premium (coder.com/pricing) 🤖 Generated with Coder Agents on behalf of @bpmct
126 lines
7.7 KiB
Markdown
126 lines
7.7 KiB
Markdown
<!-- markdownlint-disable MD041 -->
|
|
<div align="center">
|
|
<a href="https://coder.com#gh-light-mode-only">
|
|
<img src="./docs/images/logo-black.png" alt="Coder Logo Light" style="width: 128px">
|
|
</a>
|
|
<a href="https://coder.com#gh-dark-mode-only">
|
|
<img src="./docs/images/logo-white.png" alt="Coder Logo Dark" style="width: 128px">
|
|
</a>
|
|
|
|
<h1>
|
|
Self-Hosted Cloud Development Environments and AI Agents
|
|
</h1>
|
|
|
|
<a href="https://coder.com#gh-light-mode-only">
|
|
<img src="./docs/images/banner-black.png" alt="Coder Banner Light" style="width: 650px">
|
|
</a>
|
|
<a href="https://coder.com#gh-dark-mode-only">
|
|
<img src="./docs/images/banner-white.png" alt="Coder Banner Dark" style="width: 650px">
|
|
</a>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
[Quickstart](#quickstart) | [Docs](https://coder.com/docs) | [Why Coder](https://coder.com/docs/about#why-coder) | [Premium](https://coder.com/pricing#compare-plans)
|
|
|
|
[](https://cdr.co/discord-Y6fMxGdNRg)
|
|
[](https://github.com/coder/coder/releases/latest)
|
|
[](https://pkg.go.dev/github.com/coder/coder)
|
|
[](https://www.bestpractices.dev/projects/9511)
|
|
[](https://scorecard.dev/viewer/?uri=github.com%2Fcoder%2Fcoder)
|
|
[](./LICENSE)
|
|
|
|
</div>
|
|
|
|
[Coder](https://coder.com) is a self-hosted platform for cloud development environments and AI coding agents. Workspaces are defined with Terraform, connected through a secure Wireguard® tunnel, and automatically shut down when not used. Coder Agents runs a native AI coding agent whose loop executes in the control plane on your infrastructure, with no API keys in workspaces.
|
|
|
|
- Define cloud development environments in Terraform
|
|
- EC2 VMs, Kubernetes Pods, Docker Containers, etc.
|
|
- Automatically shutdown idle resources to save on costs
|
|
- Onboard developers in seconds instead of days
|
|
- Delegate coding work to AI agents on your infrastructure
|
|
- Bring any model (Anthropic, OpenAI, Google, Bedrock, self-hosted)
|
|
- No LLM credentials in workspaces, user identity on every action
|
|
- Centralized model governance, cost tracking, and audit logging
|
|
|
|
<p align="center">
|
|
<img src="./docs/images/hero-image.png" alt="Coder platform showing templates and a running workspace">
|
|
</p>
|
|
|
|
## Quickstart
|
|
|
|
> Check out our [install guides](https://coder.com/docs/install) for other methods and a complete tutorial.
|
|
|
|
Try Coder with the [install script](https://github.com/coder/coder/blob/main/install.sh) on Linux and macOS, or grab the latest binary or installer from [GitHub Releases](https://github.com/coder/coder/releases/) on Windows:
|
|
|
|
```shell
|
|
curl -L https://coder.com/install.sh | sh
|
|
```
|
|
|
|
Start the server and open [http://localhost:3000](http://localhost:3000) to create your initial user, create a Docker template, and provision your first workspace:
|
|
|
|
```shell
|
|
coder server
|
|
```
|
|
|
|
For a production deployment, add a PostgreSQL database (version 13 or later) and an external access URL, and see our [validated architectures](https://coder.com/docs/admin/infrastructure/validated-architectures) for sizing and infrastructure guidance:
|
|
|
|
```shell
|
|
coder server --postgres-url <url> --access-url <url>
|
|
```
|
|
|
|
Without these flags, Coder uses a built-in database and sets up a `*.try.coder.app` access URL for evaluation. Use `coder --help` for the full list of flags and environment variables.
|
|
|
|
## Documentation
|
|
|
|
Browse the [documentation](https://coder.com/docs) or visit a specific section below:
|
|
|
|
- [**Workspaces**](https://coder.com/docs/user-guides/workspace-management): Workspaces contain the IDEs, dependencies, and configuration information needed for software development
|
|
- [**Templates**](https://coder.com/docs/admin/templates): Templates are written in Terraform and describe the infrastructure for workspaces
|
|
- [**Coder Agents**](https://coder.com/docs/ai-coder/agents): Delegate coding work to AI agents running on your self-hosted infrastructure
|
|
- [**AI Gateway**](https://coder.com/docs/ai-coder/ai-gateway): Centralize authentication, auditing, and cost controls for AI tooling
|
|
- [**Administration**](https://coder.com/docs/admin): Learn how to operate Coder
|
|
- [**Premium**](https://coder.com/pricing#compare-plans): Learn about paid features built for large teams
|
|
- [**IDEs**](https://coder.com/docs/user-guides/workspace-access): Connect your existing editor to a workspace
|
|
|
|
## Support
|
|
|
|
[Open an issue](https://github.com/coder/coder/issues/new) for bugs and feature requests.
|
|
|
|
For community support, showcasing what you built, and feedback on in-progress features, join our [Discord](https://discord.gg/coder) or [GitHub Discussions](https://github.com/coder/coder/discussions).
|
|
|
|
Dedicated support is included in Coder Premium. For more information, visit [coder.com/pricing](https://coder.com/pricing).
|
|
|
|
## Integrations
|
|
|
|
New integrations are always in progress. Open an issue to request one. Contributions are welcome in any official or community repository.
|
|
|
|
### Official
|
|
|
|
- [**Coder Registry**](https://registry.coder.com): Templates, modules, and integrations for common development environments
|
|
- [**Coding Agents**](https://registry.coder.com/modules?search=tag%3Aagent): Run agents like Claude Code, Codex, and OpenCode isolated in Coder workspaces
|
|
- [**coderd Terraform Provider**](https://github.com/coder/terraform-provider-coderd): Declaratively manage your Coder deployment configuration as code
|
|
- [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote): Open any Coder workspace in VS Code with a single click
|
|
- [**JetBrains Toolbox Plugin**](https://plugins.jetbrains.com/plugin/26968-coder): Open any Coder workspace from JetBrains Toolbox with a single click
|
|
- [**Dev Containers**](https://coder.com/docs/user-guides/devcontainers): Build development environments using `devcontainer.json` on Docker, Kubernetes, and OpenShift
|
|
- [**Kubernetes Log Stream**](https://github.com/coder/coder-logstream-kube): Stream Kubernetes Pod events to the Coder startup logs
|
|
- [**Self-Hosted VS Code Extension Marketplace**](https://github.com/coder/code-marketplace): A private extension marketplace that works in restricted or airgapped networks integrating with [code-server](https://github.com/coder/code-server).
|
|
- [**GitHub Actions**](https://github.com/marketplace/actions/setup-coder): An action to set up the Coder CLI in GitHub workflows
|
|
|
|
### Community
|
|
|
|
- [**Coder Discord**](https://cdr.co/discord-5hw2sjadGU): Chat with the community, get support, and hear about new product updates first
|
|
- [**Community Templates**](https://registry.coder.com/templates?search=status%3Acommunity): Community-contributed workspace templates in the Coder Registry
|
|
- [**Community Modules**](https://registry.coder.com/modules?search=status%3Acommunity): Community-contributed modules to extend Coder templates
|
|
- [**Coder Template GitHub Action**](https://github.com/marketplace/actions/update-coder-template): A GitHub Action that updates Coder templates
|
|
- [**Coder Agents Chat Action**](https://github.com/coder/agents-chat-action): A GitHub Action that starts a Coder Agents chat against a GitHub issue or pull request
|
|
|
|
## Contributing
|
|
|
|
New contributors are always welcome. If you are new to the Coder codebase, see
|
|
[the contribution guide](https://coder.com/docs/about/contributing/CONTRIBUTING) to get started.
|
|
|
|
## Hiring
|
|
|
|
Apply on the [careers page](https://jobs.ashbyhq.com/coder?utm_source=github&utm_medium=readme&utm_campaign=unknown) if you are interested in joining the team.
|