diff --git a/README.md b/README.md index 93b78902..11e09fa5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# coder-cli +# Coder CLI [![GitHub Release](https://img.shields.io/github/v/release/cdr/coder-cli?color=6b9ded&include_prerelease=false)](https://github.com/cdr/coder-cli/releases) [![Documentation](https://godoc.org/cdr.dev/coder-cli?status.svg)](https://pkg.go.dev/cdr.dev/coder-cli/coder-sdk) @@ -9,20 +9,23 @@ To report bugs and request features, please [open an issue](https://github.com/cdr/coder-cli/issues/new). -## Usage +## Installation -View the `coder-cli` documentation [here](./docs/coder.md). +### Homebrew (Mac, Linux) -You can find additional Coder Enterprise usage documentation on [https://enterprise.coder.com](https://enterprise.coder.com/docs/getting-started). +```sh +brew install cdr/coder/coder-cli +``` -## Install Release +### Download (Windows, Linux, Mac) Download the latest [release](https://github.com/cdr/coder-cli/releases): 1. Click a release and download the tar file for your operating system (ex: coder-cli-linux-amd64.tar.gz) -2. Extract the `coder` binary from the tar file, ex: +2. Extract the `coder` binary. -```bash -cd ~/go/bin -tar -xvf ~/Downloads/coder-cli-linux-amd64.tar.gz -``` +## Usage + +View the usage documentation [here](./docs/coder.md). + +You can find additional Coder usage documentation on [coder.com/docs/cli](https://coder.com/docs/cli).