coder-cli

module

v1.37.1 Latest Latest Go to latest Published: Jul 20, 2022 License: GPL-3.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/coder/coder-cli

Links

Open Source Insights

README ¶

Coder CLI

Note: This is the command line utility for Coder Classic. If you are using Coder OSS, use these instructions to install the CLI.

Code

As of v1.24.0, the Coder CLI is closed source. The code in this repo will remain as it was when closed on 20 October 2021. We will continue to use issues and releases for the time being, but this may change.

We recommend using the SDK included in this repo until we publish the new Go SDK that's currently in progress.

We will not accept any further pull requests.

Bugs & feature requests

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 coder binary.

Usage

View the usage documentation here.

You can find additional Coder usage documentation on coder.com/docs/cli.

Directories ¶

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

Path	Synopsis
cmd
coder
coder-sdk Package coder provides simple APIs for integrating Go applications with Coder.	Package coder provides simple APIs for integrating Go applications with Coder.
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.
sync Package sync contains logic for establishing a file sync between a local machine and a Coder workspace.	Package sync contains logic for establishing a file sync between a local machine and a Coder workspace.
version Package version contains the compile-time injected version string and related utility methods.	Package version contains the compile-time injected version string and related utility methods.
x/xcobra Package xcobra wraps the cobra package to provide richer functionality.	Package xcobra wraps the cobra package to provide richer functionality.
x/xsync Package xsync provides utilities for concurrency.	Package xsync provides utilities for concurrency.
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.
proto Package proto contains shared messages for webrtc handshakes.	Package proto contains shared messages for webrtc handshakes.
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.
wsnet Package wsnet handles client and server ends of Workspace networking negotiations and protocol.	Package wsnet handles client and server ends of Workspace networking negotiations and protocol.