mirror of
https://github.com/coder/coder.git
synced 2026-06-03 04:58:23 +00:00
Ben Potter
6711552f7b
Adds Coder Agents messaging to the README and about page (docs/README.md), and updates the hero screenshots. **README.md**: Adds agents to the tagline, intro paragraph, feature bullets, and documentation links. Reorders docs section (Workspaces, Templates, Agents, Administration, Premium, IDEs). Refreshes integrations: Registry first, renames Dev Container Builder to Dev Containers, Setup Coder to GitHub Actions, adds community templates/modules/Discord links. Removes "we" language and vague link text per docs style feedback. **docs/README.md**: Adds dedicated Coder Workspaces and Coder Agents sections with inline links to their respective doc pages. Rewrites "Why remote development" as prose instead of a flat bullet list. Adds agents benefits to "Why Coder" (MCP servers, skills, system prompts). Fixes heading punctuation, replaces "Up next" with "Learn more", corrects ARM/OS positioning. Removes stale Coder v1 section. **Screenshots**: Replaces hero-image.png with an updated screenshot showing templates and a running workspace with IDE apps. Adds agents-hero-image.png showing the agents chat UI with the git diff sidebar. > Generated with [Coder Agents](https://coder.com/agents)
141 lines
7.6 KiB
Markdown
141 lines
7.6 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/why) | [Premium](https://coder.com/pricing#compare-plans)
|
|
|
|
[](https://discord.gg/coder)
|
|
[](https://github.com/coder/coder/releases/latest)
|
|
[](https://pkg.go.dev/github.com/coder/coder)
|
|
[](https://goreportcard.com/report/github.com/coder/coder/v2)
|
|
[](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
|
|
|
|
The most convenient way to try Coder is to install it on your local machine and experiment with provisioning cloud development environments using Docker (works on Linux, macOS, and Windows).
|
|
|
|
```shell
|
|
# First, install Coder
|
|
curl -L https://coder.com/install.sh | sh
|
|
|
|
# Start the Coder server (caches data in ~/.cache/coder)
|
|
coder server
|
|
|
|
# Navigate to http://localhost:3000 to create your initial user,
|
|
# create a Docker template and provision a workspace
|
|
```
|
|
|
|
## Install
|
|
|
|
The easiest way to install Coder is to use the
|
|
[install script](https://github.com/coder/coder/blob/main/install.sh) for Linux
|
|
and macOS. For Windows, use the latest `..._installer.exe` file from GitHub
|
|
Releases.
|
|
|
|
```shell
|
|
curl -L https://coder.com/install.sh | sh
|
|
```
|
|
|
|
You can run the install script with `--dry-run` to see the commands that will be used to install without executing them. Run the install script with `--help` for additional flags.
|
|
|
|
> See [install](https://coder.com/docs/install) for additional methods.
|
|
|
|
Once installed, you can start a production deployment with a single command:
|
|
|
|
```shell
|
|
# Automatically sets up an external access URL on *.try.coder.app
|
|
coder server
|
|
|
|
# Requires a PostgreSQL instance (version 13 or higher) and external access URL
|
|
coder server --postgres-url <url> --access-url <url>
|
|
```
|
|
|
|
Use `coder --help` to get a list of flags and environment variables. See the [install guides](https://coder.com/docs/install) for a complete tutorial.
|
|
|
|
## Documentation
|
|
|
|
Browse the [documentation](https://coder.com/docs) or visit a specific section below:
|
|
|
|
- [**Workspaces**](https://coder.com/docs/workspaces): Workspaces contain the IDEs, dependencies, and configuration information needed for software development
|
|
- [**Templates**](https://coder.com/docs/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
|
|
- [**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/ides): Connect your existing editor to a workspace
|
|
|
|
## Support
|
|
|
|
Feel free to [open an issue](https://github.com/coder/coder/issues/new) if you have questions, run into bugs, or have a feature request.
|
|
|
|
[Join our Discord](https://discord.gg/coder) to provide feedback on in-progress features and chat with the community using Coder!
|
|
|
|
## 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
|
|
- [**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
|
|
- [**JetBrains Gateway Plugin**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click
|
|
- [**Dev Containers**](https://github.com/coder/envbuilder): 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
|
|
|
|
- [**Community Templates**](https://registry.coder.com/templates): Community-contributed workspace templates in the Coder Registry
|
|
- [**Community Modules**](https://registry.coder.com/modules): Community-contributed modules to extend Coder templates
|
|
- [**Provision Coder with Terraform**](https://github.com/ElliotG/coder-oss-tf): Provision Coder on Google GKE, Azure AKS, AWS EKS, DigitalOcean DOKS, IBMCloud K8s, OVHCloud K8s, and Scaleway K8s Kapsule with Terraform
|
|
- [**Coder Template GitHub Action**](https://github.com/marketplace/actions/update-coder-template): A GitHub Action that updates Coder templates
|
|
- [**Discord**](https://discord.gg/coder): Chat with the community and provide feedback on in-progress features
|
|
|
|
## Contributing
|
|
|
|
New contributors are always welcome. If you are new to the Coder codebase, see
|
|
[the contribution guide](https://coder.com/docs/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.
|