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

Commit 6b9e8b3

Browse files
committed
Update README for new scope
1 parent fc0c867 commit 6b9e8b3

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# coder-cli
22

3-
`coder` provides a one-way, live file sync to your Coder Enterprise environment.
4-
5-
It is useful in cases where you want to use an unsupported IDE with your Coder
6-
Environment.
3+
`coder` is a command line utility for Coder Enterprise.
74

85
## Install
96

@@ -18,12 +15,21 @@ $ coder login https://my-coder-enterprise.com
1815

1916
## Setting up a Live Sync
2017

18+
`coder sync` is useful in cases where you want to use an unsupported IDE with your Coder
19+
Environment.
20+
21+
2122
Ensure that `rsync` is installed locally and in your environment.
2223

2324
``
2425
$ coder sync ~/Projects/cdr/enterprise/. my-env:~/enterprise
2526
``
2627

28+
## Remote Terminal
29+
30+
You can access your environment's terminal with `coder sh <env>`. You can also
31+
execute a command in your environment with `coder sh <env> [command] [args]`.
32+
2733
## Caveats
2834

2935
- The `coder login` flow will not work when the CLI is ran from a different network

0 commit comments

Comments
 (0)