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

docs(readme): reduce a11y so coder v2 users don't stumble upon this #501

Merged
merged 1 commit into from
Jan 4, 2023
Merged

docs(readme): reduce a11y so coder v2 users don't stumble upon this #501

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 2 additions & 39 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,7 @@
# Coder CLI
# Coder v1 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)

> **Note**: This is the command line utility for [Coder Classic](https://coder.com/docs/coder).
> If you are using [Coder OSS](https://coder.com/docs/coder-oss/latest), use [these instructions](https://coder.com/docs/coder-oss/latest/install)
> to install the CLI.
> **Note**: This is the command line utility for [Coder Classic](https://coder.com/docs/coder). If you are using [Coder v2 / Coder OSS](https://coder.com/docs/coder-oss/latest), use [these instructions](https://coder.com/docs/coder-oss/latest/install) to install the CLI.

## Code

As of v1.24.0, the Coder CLI is closed source. The code in this repo will remain
as it was when closed on 20 October 2021. We will continue to use issues and
releases for the time being, but this may change.

We recommend using the SDK included in this repo until we publish the new Go SDK
that's currently in progress.

We will not accept any further pull requests.

## Bugs & feature requests

To report bugs and request features, please [open an issue](https://github.com/cdr/coder-cli/issues/new).

## Installation

### Homebrew (Mac, Linux)

```sh
brew install cdr/coder/coder-cli
```

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

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