Command line tool for the Hyper.sh platform.
Go Shell Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api Fix time in func logs Jun 14, 2018
builder add hyper-api instead of engine-api Nov 6, 2017
cli add hyper-api instead of engine-api Nov 6, 2017
cliconfig add hyper-api instead of engine-api Nov 6, 2017
container add hyper-api instead of engine-api Nov 6, 2017
contrib Update completion about hyper-load Jun 10, 2017
daemon add hyper-api instead of engine-api Nov 6, 2017
distribution add hyper-api instead of engine-api Nov 6, 2017
dockerversion add client version, and fix typos (#6) Apr 8, 2016
docs Add support details for storage driver Feb 4, 2016
errors fix typos, change docker to hyper for output Apr 3, 2016
experimental Fixed typo in experimental/plugins_graphdriver.md Jan 16, 2016
hack add hyper-api instead of engine-api Nov 6, 2017
hyper add hyper-api instead of engine-api Nov 6, 2017
image add hyper-api instead of engine-api Nov 6, 2017
integration-cli Merge pull request #238 from Jimmy-Xu/autotest-dockerfile Nov 24, 2017
layer update import path to hyperhq/hypercli Apr 5, 2016
man Add note about legacy links Feb 2, 2016
migrate/v1 Changes cross-repository blob mounting to a blob Create option Jan 14, 2016
opts Windows: Add support for named pipe protocol Feb 2, 2016
pkg [master] fix ansi_reader Apr 14, 2018
profiles add hyper-api instead of engine-api Nov 6, 2017
project update import path to hyperhq/hypercli Apr 5, 2016
reference update import path to hyperhq/hypercli Apr 5, 2016
registry [update-vendor] update go-connection in vendor Jan 5, 2018
runconfig add hyper-api instead of engine-api Nov 6, 2017
utils add container add/remove changes in stats sub-command Dec 28, 2016
vendor/src [master] update go-ansiterm Apr 14, 2018
volume fix dead lock in volume store dereference Jan 27, 2016
.dockerignore Add vendor/pkg to .dockerignore Dec 5, 2015
.gitignore [integration-test] adjust vendor for integration-test Jun 19, 2017
.mailmap update authors and mailmap Jun 7, 2015
.travis.yml update go version to 1.8 Nov 6, 2017
AUTHORS update authors and mailmap Jun 7, 2015
CHANGELOG.md Bump version to v1.10.0 Feb 4, 2016
CONTRIBUTING.md CONTRIBUTING: add guidelines regarding email Jan 8, 2016
Dockerfile update comment Feb 2, 2016
Dockerfile.aarch64 Sync with Dockerfile Feb 3, 2016
Dockerfile.armhf update comment Feb 2, 2016
Dockerfile.dev [region] fix integration-cli Sep 16, 2017
Dockerfile.gccgo update comment Feb 2, 2016
Dockerfile.ppc64le Merge pull request #19516 from tophj-ibm/update-registry-on-dockerfil… Jan 29, 2016
Dockerfile.qa [region] update integration-cli, change --host to --region Sep 15, 2017
Dockerfile.s390x Need -lpthread to compile Notary Jan 29, 2016
Dockerfile.simple Include xfsprogs in build environment. Nov 11, 2015
Dockerfile.windows Windows: Update dockerfile.windows Jan 21, 2016
LICENSE Update LICENSE date Dec 31, 2015
MAINTAINERS Add Lei Jitang to MAINTAINERS. Jan 15, 2016
Makefile Pass KEEPBUNDLE in Docker build environment. Feb 4, 2016
NOTICE update license and readme Apr 5, 2016
README.md [integration-test] adjust vendor for integration-test Jun 19, 2017
ROADMAP.md Fix typo in ROADMAP.md Sep 12, 2015
VENDORING.md Create standard vendor policies. Jan 7, 2016
VERSION [master] bump version to 1.10.17 Jun 14, 2018
build.sh fix compose pull issue from private registry Aug 18, 2016

README.md

HyperCLI Build Status

Go version of Hyper.sh client command line tools.

Install

Quick and Easy (Recommended)

Grab the latest version for your system on the Releases page or build it by yourself as the instruction.

You can either run the binary directly or add somewhere in your $PATH.

Getting Started

Before Getting Started

Before you can use Hyper.sh, be sure you've created a free account with Hyper.sh and generate your credentials on Hyper.sh.

Once the installation and setup completes, enter hyper config in your terminal. The CLI will prompt to ask for your API credential:

The credential is stored in a local configuration file $HOME/.hyper/config.json. The configuration file is similar to Docker's, with an extra section clouds.

Or you can use environmental vairables HYPER_ACCESS and HYPER_SECRET to pass the access key and secret key (CLI will search for these envs before loading the configuration file).

You only need to do that once for your machine. If you've done that, then you can continue.

See the official docs for more detailed info on using Hyper.sh.

Actually Getting Started

The easiest way to get started is by digging around.

$ hyper --help for example usage and a list of commands

How to build

$ mkdir $GOPATH/src/github.com/hyperhq/
$ cd $GOPATH/src/github.com/hyperhq/
$ git clone https://github.com/hyperhq/hypercli hypercli
$ cd hypercli
$ ./build.sh

Contributing

Give us a pull request! File a bug!