coder-cli

module
v1.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 20, 2020 License: GPL-3.0

README

coder-cli

coder is a command line utility for Coder Enterprise.

Install

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

Login

$ 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

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.

Directories

Path Synopsis
cmd
internal
config
Package config provides facilities for working with the local configuration directory.
Package config provides facilities for working with the local configuration directory.
Package wush is Coder Enterprise's protocol for transmitting Linux command execution over a WebSocket connection.
Package wush is Coder Enterprise's protocol for transmitting Linux command execution over a WebSocket connection.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL