diff --git a/README.md b/README.md index 8c6682b0be..3335a34fbc 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

- Self-Hosted Cloud Development Environments + Self-Hosted Cloud Development Environments and AI Agents

@@ -33,15 +33,19 @@ -[Coder](https://coder.com) enables organizations to set up development environments in their public or private cloud infrastructure. Cloud development environments are defined with Terraform, connected through a secure high-speed Wireguard® tunnel, and automatically shut down when not used to save on costs. Coder gives engineering teams the flexibility to use the cloud for workloads most beneficial to them. +[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

- Coder Hero Image + Coder platform showing templates and a running workspace

## Quickstart @@ -61,7 +65,7 @@ coder server ## Install -The easiest way to install Coder is to use our +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. @@ -84,17 +88,18 @@ coder server coder server --postgres-url --access-url ``` -Use `coder --help` to get a list of flags and environment variables. Use our [install guides](https://coder.com/docs/install) for a complete walkthrough. +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 our docs [here](https://coder.com/docs) or visit a specific section below: +Browse the [documentation](https://coder.com/docs) or visit a specific section below: -- [**Templates**](https://coder.com/docs/templates): Templates are written in Terraform and describe the infrastructure for workspaces - [**Workspaces**](https://coder.com/docs/workspaces): Workspaces contain the IDEs, dependencies, and configuration information needed for software development -- [**IDEs**](https://coder.com/docs/ides): Connect your existing editor to a workspace +- [**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 our paid features built for large teams +- [**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 @@ -104,30 +109,32 @@ Feel free to [open an issue](https://github.com/coder/coder/issues/new) if you h ## Integrations -We are always working on new integrations. Please feel free to open an issue and ask for an integration. Contributions are welcome in any official or community repositories. +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 Container Builder**](https://github.com/coder/envbuilder): Build development environments using `devcontainer.json` on Docker, Kubernetes, and OpenShift -- [**Coder Registry**](https://registry.coder.com): Build and extend development environments with common use-cases +- [**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). -- [**Setup Coder**](https://github.com/marketplace/actions/setup-coder): An action to setup coder CLI in GitHub workflows. +- [**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 -We are always happy to see new contributors to Coder. If you are new to the Coder codebase, we have -[a guide on how to get started](https://coder.com/docs/CONTRIBUTING). We'd love to see your -contributions! +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 [here](https://jobs.ashbyhq.com/coder?utm_source=github&utm_medium=readme&utm_campaign=unknown) if you're interested in joining our team. +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. diff --git a/docs/README.md b/docs/README.md index 4848a8a153..ed57b83fd0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,14 +2,49 @@ -Coder is a self-hosted, open source, cloud development environment that works -with any cloud, IDE, OS, Git provider, and IDP. +Coder is a self-hosted platform for running AI coding agents and cloud +development environments on infrastructure you control. It works with any +cloud, IDE, OS, Git provider, and IDP. -![Screenshots of Coder workspaces and connections](./images/hero-image.png)_Screenshots of Coder workspaces and connections_ +![Coder platform showing templates and a running workspace](./images/hero-image.png) -Coder is built on common development interfaces and infrastructure tools to -make the process of provisioning and accessing remote workspaces approachable -for organizations of various sizes and stages of cloud-native maturity. +## Coder Workspaces + +[Coder Workspaces](./user-guides/index.md) are cloud development environments +defined with Terraform, connected through a secure Wireguard tunnel, and +automatically shut down when not in use. Agents and developers share the same +workspace infrastructure. + +- **Defined in Terraform**: Templates describe the infrastructure for each + workspace, from EC2 VMs and Kubernetes Pods to Docker containers. +- **Any architecture and OS**: Support ARM and x86-64 across Windows, Linux, + and macOS from a single deployment. +- **Managed by admins**: Platform teams create and maintain templates that + enforce approved images, resource limits, and security policies. +- **Accessed from any IDE**: Connect through VS Code, JetBrains, Cursor, + a web terminal, remote desktop, or SSH. +- **Automatic shutdown**: Idle workspaces stop automatically to reduce + cloud spend, and restart in seconds when needed. + +## Coder Agents + +[Coder Agents](./ai-coder/agents/index.md) is a native AI coding agent built +into Coder. The agent loop runs in the Coder control plane on your +infrastructure, not in the workspace and not in a vendor's cloud. Developers +interact with agents through the web UI, the CLI (`coder agents`), or the REST +API for programmatic and CI-driven workflows. + +- **Self-hosted agent loop**: The control plane handles planning, model + calls, and tool dispatch. Workspaces have zero AI awareness. +- **No API keys in workspaces**: LLM credentials stay in the control plane. +- **Any model**: Anthropic, OpenAI, Google, Bedrock, or self-hosted + endpoints. Switching is a configuration change. +- **Governance and cost controls**: Centralized model approval, per-user + spend limits, and audit logging. +- **Open source and inspectable**: The full platform is available to audit + and extend. + +![Coder Agents chat interface with git diff sidebar](./images/agents-hero-image.png) ## IDE support @@ -34,46 +69,57 @@ You can use: ## Why remote development -Remote development offers several benefits for users and administrators, including: +Provisioning consistent development environments for a large engineering team +is difficult. Each developer has preferences for operating systems, editors, +and toolchains, and ensuring a reliable build environment across all of them +is a maintenance burden. A missed step during onboarding or an unsupported +local configuration can cost hours of debugging. -- **Increased speed** +Remote development solves this by moving the environment off the developer's +machine and into managed infrastructure. The developer's laptop becomes a +portal into the actual compute where work happens. If a device is lost or +replaced, access is simply revoked; no source code or credentials are stored +locally. - - Server-grade cloud hardware speeds up operations in software development, from - loading the IDE to compiling and building code, and running large workloads - such as those for monolith or microservice applications. +This approach provides: -- **Easier environment management** +- **Speed**: Server-grade hardware accelerates builds, tests, and large + workloads without requiring expensive local machines. +- **Consistency**: Infrastructure tools such as Terraform, nix, Docker, and + Dev Containers produce identical environments for every developer. +- **Security**: Source code stays on private servers. Users and groups are + managed through [SSO](./admin/users/oidc-auth/index.md) and + [RBAC](./admin/users/groups-roles.md#roles). +- **Compatibility**: Workspaces share infrastructure configurations with + staging and production, reducing configuration drift. +- **Accessibility**: Browser-based IDEs and remote IDE extensions let + developers work from any device, including lightweight laptops, + Chromebooks, and tablets. - - Built-in infrastructure tools such as Terraform, nix, Docker, Dev Containers, and others make it easier to onboard developers with consistent environments. - -- **Increased security** - - - Centralize source code and other data onto private servers or cloud services instead of local developers' machines. - - Manage users and groups with [SSO](./admin/users/oidc-auth/index.md) and [Role-based access controlled (RBAC)](./admin/users/groups-roles.md#roles). - -- **Improved compatibility** - - - Remote workspaces can share infrastructure configurations with other - development, staging, and production environments, reducing configuration - drift. - -- **Improved accessibility** - - Connect to remote workspaces via browser-based IDEs or remote IDE - extensions to enable developers regardless of the device they use, whether - it's their main device, a lightweight laptop, Chromebook, or iPad. - -Read more about why organizations and engineers are moving to remote -development on [our blog](https://coder.com/blog), the +Read more on the [Coder blog](https://coder.com/blog), the [Slack engineering blog](https://slack.engineering/development-environments-at-slack), -or from [OpenFaaS's Alex Ellis](https://blog.alexellis.io/the-internet-is-my-computer/). +or from [Alex Ellis at OpenFaaS](https://blog.alexellis.io/the-internet-is-my-computer/). ## Why Coder -The key difference between Coder and other remote IDE platforms is the added -layer of infrastructure control. -This additional layer allows admins to: +The key difference between Coder and other platforms is that the entire system, +agent loop, control plane, model routing, and workspace provisioning, runs on +infrastructure you control. -- Simultaneously support ARM, Windows, Linux, and macOS workspaces. +For agents, this means platform teams can: + +- Run the entire agent loop on their infrastructure, with no SaaS + dependency for orchestration. +- Define MCP servers, skills, and system prompts centrally so every agent + session starts with the same tools, policies, and context. +- Keep LLM credentials out of workspaces entirely. +- Tie every agent action to an authenticated user identity. +- Support air-gapped and restricted-network deployments with self-hosted models. + +For workspaces, this means admins can: + +- Support any architecture (ARM, x86-64) and operating system + (Windows, Linux, macOS). - Modify pod/container specs, such as adding disks, managing network policies, or setting/updating environment variables. - Use VM or dedicated workspaces, developing with Kernel features (no container @@ -81,29 +127,28 @@ This additional layer allows admins to: - Enable persistent workspaces, which are like local machines, but faster and hosted by a cloud service. -## How much does it cost? +## Pricing -Coder is free and open source under +Coder is free and open source under the [GNU Affero General Public License v3.0](https://github.com/coder/coder/blob/main/LICENSE). -All developer productivity features are included in the Open Source version of -Coder. -A [Premium license is available](https://coder.com/pricing#compare-plans) for enhanced -support options and custom deployments. +All developer productivity features are included in the open source version. +A [Premium license](https://coder.com/pricing#compare-plans) is available for +enhanced support and custom deployments. -## How does Coder work +## How Coder works -Coder workspaces are represented with Terraform, but you don't need to know -Terraform to get started. -We have a [database of production-ready templates](https://registry.coder.com/templates) -for use with AWS EC2, Azure, Google Cloud, Kubernetes, and more. +Coder workspaces are represented with Terraform, but you do not need to know +Terraform to get started. The +[Coder Registry](https://registry.coder.com/templates) provides production-ready +templates for AWS EC2, Azure, Google Cloud, Kubernetes, and other providers. ![Providers and compute environments](./images/providers-compute.png)_Providers and compute environments_ -Coder workspaces can be used for more than just compute. -You can use Terraform to add storage buckets, secrets, sidecars, -[and more](https://developer.hashicorp.com/terraform/tutorials). +Workspaces can include more than just compute. Terraform can add storage +buckets, secrets, sidecars, and +[other resources](https://developer.hashicorp.com/terraform/tutorials). -Visit the [templates documentation](./admin/templates/index.md) to learn more. +See the [templates documentation](./admin/templates/index.md) for details. ## What Coder is not @@ -134,13 +179,9 @@ Visit the [templates documentation](./admin/templates/index.md) to learn more. You must host Coder in a private data center or on a cloud service, such as AWS, Azure, or GCP. -## Using Coder v1? +## Learn more -If you're a Coder v1 customer, view [the v1 documentation](https://coder.com/docs/v1) -or [the v2 migration guide and FAQ](https://coder.com/docs/v1/guides/v2-faq). - -## Up next - -- [Template](./admin/templates/index.md) +- [Coder Agents](./ai-coder/agents/index.md) +- [Templates](./admin/templates/index.md) - [Installing Coder](./install/index.md) -- [Quickstart](./tutorials/quickstart.md) to try Coder out for yourself. +- [Quickstart tutorial](./tutorials/quickstart.md) diff --git a/docs/images/agents-hero-image.png b/docs/images/agents-hero-image.png new file mode 100644 index 0000000000..5e80f7b586 Binary files /dev/null and b/docs/images/agents-hero-image.png differ diff --git a/docs/images/hero-image.png b/docs/images/hero-image.png index da879491ff..dbce970dec 100644 Binary files a/docs/images/hero-image.png and b/docs/images/hero-image.png differ