From bdd0f13139db5389ed99de1537d6e77ebea0a36f Mon Sep 17 00:00:00 2001 From: Colin Adler Date: Thu, 21 May 2020 15:13:13 -0500 Subject: [PATCH] Link out to enterprise CLI docs --- README.md | 57 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index eac06b3b..9cde5043 100644 --- a/README.md +++ b/README.md @@ -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 `. You can also -execute a command in your environment with `coder sh [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).