Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

docs: add brew install snippet to readme #208

Merged
merged 3 commits into from
Dec 25, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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).