coder / cli

A minimal Go CLI package.

Self-Hosted Cloud Development Environments

Quickstart | Docs | Why Coder | Enterprise

Coder 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.

• 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

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).

# 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 our install script for Linux and macOS. For Windows, use the latest ..._installer.exe file from GitHub Releases.

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 for additional methods.

Once installed, you can start a production deployment with a single command:

# 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. Use our install guides for a complete walkthrough.

Documentation

Browse our docs here or visit a specific section below:

• Templates: Templates are written in Terraform and describe the infrastructure for workspaces
• Workspaces: Workspaces contain the IDEs, dependencies, and configuration information needed for software development
• IDEs: Connect your existing editor to a workspace
• Administration: Learn how to operate Coder
• Enterprise: Learn about our paid features built for large teams

Support

Feel free to open an issue if you have questions, run into bugs, or have a feature request.

Join our Discord to provide feedback on in-progress features and chat with the community using Coder!

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.

Official

• VS Code Extension: Open any Coder workspace in VS Code with a single click
• JetBrains Gateway Extension: Open any Coder workspace in JetBrains Gateway with a single click
• Dev Container Builder: Build development environments using devcontainer.json on Docker, Kubernetes, and OpenShift
• Module Registry: Extend development environments with common use-cases
• Kubernetes Log Stream: Stream Kubernetes Pod events to the Coder startup logs
• Self-Hosted VS Code Extension Marketplace: A private extension marketplace that works in restricted or airgapped networks integrating with code-server.

Community

• Provision Coder with Terraform: 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: A GitHub Action that updates Coder templates

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. We'd love to see your contributions!

Hiring

Apply here if you're interested in joining our team.

cli's Issues

Add example for global flags

e.g. a --verbose flag

Support subcommand aliases

And update help output of parent command to display aliases for subcommands.

Fix flag formatting in v0.3.0

   -d=false	Shorthand for --detach
                                                         --detach=false       Detached mode: run command in the background
	-e	Shorthand for --envs
                                                                 --envs               Set environment variables
	-i=false	Shorthand for --interactive
                                                    --interactive=false  Keep STDIN open even if not attached
  -t=false             Shorthand for --tty
	--tty=false	Allocate a pseudo-TTY
                                                       -w                   Shorthand for --workdir
	--workdir	Working directory inside the environment

Support Posix Flags

Currently multiple flags can't be combined, for example:

./cmd -a -b arg can't be shortened to ./cmd -ab arg

I know a benefit of cdr/cli is that it has no external deps, but I think it would be a better UX if we used https://github.com/spf13/pflag to support posix flags.

Move default value next to flag in help

--flag=value

instead of

--flag <desc> value

Add completions

Add short-hand flags

Allow commands to ignore flag parsing errors

coder sync should create top-level dest dir for rsync op

With a new environment, I tried

$ coder sync ~/dev/x11wasm russ-dev1:/home/coder/dev/x11wasm 2020-06-16 11:01:54 INFO doing initial sync (/home/russtopia/dev/x11wasm -> /home/coder/dev/x11wasm) 2020-06-16 11:01:58 FATAL sync: rsync: exit status 11

For coder sync to succeed, I had to first do
coder sh russ-dev1 $ mkdir dev $ exit

It might be good if the coder sync command was able to essentially do a mkdir -p <path> to ensure the rsync can operate on a brand new tree.

Support shell completions

Support generating fish, zsh, and/or bash completions. This would be 💯 💯 for https://github.com/cdr/coder-cli