README
¶
Coder CLI
coder is a command line utility for Coder Enterprise.
To report bugs and request features, please open an issue.
Installation
Homebrew (Mac, Linux)
brew install cdr/coder/coder-cli
Download (Windows, Linux, Mac)
Download the latest release:
- Click a release and download the tar file for your operating system (ex: coder-cli-linux-amd64.tar.gz)
- Extract the
coderbinary.
Usage
View the usage documentation here.
You can find additional Coder usage documentation on coder.com/docs/cli.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
coder
command
|
|
|
Package coder provides simple APIs for integrating Go applications with Coder Enterprise.
|
Package coder provides simple APIs for integrating Go applications with Coder Enterprise. |
|
internal
|
|
|
activity
Package activity defines the logic for tracking usage activity metrics.
|
Package activity defines the logic for tracking usage activity metrics. |
|
cmd
Package cmd constructs all subcommands for coder-cli.
|
Package cmd constructs all subcommands for coder-cli. |
|
coderutil
Package coderutil providers utilities for high-level operations on coder-sdk entities.
|
Package coderutil providers utilities for high-level operations on coder-sdk entities. |
|
config
Package config provides facilities for working with the local configuration directory.
|
Package config provides facilities for working with the local configuration directory. |
|
loginsrv
Package loginsrv defines the login server in use by coder-cli for performing the browser authentication flow.
|
Package loginsrv defines the login server in use by coder-cli for performing the browser authentication flow. |
|
sync
Package sync contains logic for establishing a file sync between a local machine and a Coder Enterprise environment.
|
Package sync contains logic for establishing a file sync between a local machine and a Coder Enterprise environment. |
|
version
Package version contains the compile-time injected version string and related utiliy methods.
|
Package version contains the compile-time injected version string and related utiliy methods. |
|
x/xcobra
Package xcobra wraps the cobra package to provide richer functionality.
|
Package xcobra wraps the cobra package to provide richer functionality. |
|
x/xterminal
Package xterminal provides functions to change termios or console attributes and restore them later on.
|
Package xterminal provides functions to change termios or console attributes and restore them later on. |
|
pkg
|
|
|
clog
Package clog provides rich error types and logging helpers for coder-cli.
|
Package clog provides rich error types and logging helpers for coder-cli. |
|
tablewriter
Package tablewriter provides helpers for printing human-readable tabular data from slices of structs.
|
Package tablewriter provides helpers for printing human-readable tabular data from slices of structs. |
|
tcli
Package tcli provides a framework for CLI integration testing.
|
Package tcli provides a framework for CLI integration testing. |
Click to show internal directories.
Click to hide internal directories.