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

Link out to enterprise CLI docs #24

Merged
merged 1 commit into from
May 23, 2020
Merged

Link out to enterprise CLI docs #24

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
57 changes: 2 additions & 55 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,59 +2,6 @@

`coder` is a command line utility for Coder Enterprise.

## Install

```go
go get cdr.dev/coder-cli/cmd/coder
```

## Login
```shell script
$ coder login https://my-coder-enterprise.com
```

## Setting up a Live Sync

`coder sync` is useful in cases where you want to use an unsupported IDE with your Coder
Environment.

Ensure that `rsync` is installed locally and in your environment.

``
$ coder sync ~/Projects/cdr/enterprise/. my-env:~/enterprise
``

## Remote Terminal

You can access your environment's terminal with `coder sh <env>`. You can also
execute a command in your environment with `coder sh <env> [command] [args]`.

## Environments

List all active environments for the user.

``
$ coder envs
``

## Development URLs

You can retrieve the devurl of an environment.

``
$ coder url my-env 8080
``

## Caveats

- The `coder login` flow will not work when the CLI is ran from a different network
than the browser. [Issue](https://github.com/cdr/coder-cli/issues/1)

## Sync Architecture

We decided to use `rsync` because other solutions are extremely slow for the initial
sync.

Later, we may use `mutagen` for a two-way sync alternative when
it supports custom transports.
To view usage documentation, head over to [https://enterprise.coder.com](https://enterprise.coder.com/docs/getting-started).

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