CLI for easy access to Conch functionality
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
cmd/conch
example
pkg
release
.gitignore
Gopkg.lock
Gopkg.toml
LICENSE
Makefile
README.md

README.md

What

conch is a CLI for accessing the Conch API.

Go Report Card

Getting The App

Releases are available over at https://github.com/joyent/conch-shell/releases for a handful of platforms, including macOS, Linux, and Solaris/SmartOS.

Joyent Employees

The latest production release at https://github.com/joyent/conch-shell/releases/latest is certified against the production instance.

The most recent release is not certified for production yet (thus the 'pre-release' tag) and probably works best against the staging instance. Grab it at https://github.com/joyent/conch-shell/releases

Data Guarantee

One of the major goals of this application is to provide a stable data interface for the Conch API. To that end, to the best of our ability, the JSON output (conch -j :command) will not remove data or change its meaning. Data may be added, but not subtracted. If data must be removed, this change will be announced in advance and the major version of the application will be incremented.

Exceptions

Device Reports

Device reports have evolved organically over time and are inconsistent. While an effort is underway to standardize those reports, at the time of writing, existing reports cannot be parsed in such a way as to guarantee consistent results. As such, the JSON output of a device report matches the data as provided by the API, without any guarantees of compatibility.

Notes

SSL Certs

Go makes a lot of assumptions about a user's runtime environment. One assumption is that a system holds SSL certs in a set of default directories which are hardcoded into the go runtime by platform. If the user's runtime differs from go's expectation, the user will receive a message like x509: failed to load system roots and no roots provided.

To set a custom location for SSL certs, one can specify SSL_CERT_DIR or SSL_CERT_FILE in the environment before running conch shell.

For instance: SSL_CERT_FILE=/opt/certs.pem conch login

Copyright / License

Copyright Joyent Inc

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Building

  • go get github.com/joyent/conch-shell. This installs the code at $GOPATH/src/github.com/joyent/conch-shell
  • In the conch-shell checkout:
    • make tools - Install the necessary build tools
    • make - Build the application

Notes

Always use the Makefile to build the app. The Makefile passes necessary build vars into the app.