|
1 | | -[](https://travis-ci.org/hyperhq/hypercli) |
| 1 | +# HyperCLI [](https://travis-ci.org/hyperhq/hypercli) |
2 | 2 |
|
3 | | -Hyper.sh client for Mac/Linux |
| 3 | +Go version of Hyper.sh client command line tools. |
| 4 | + |
| 5 | +## Install |
| 6 | + |
| 7 | +### Quick and Easy (Recommended) |
| 8 | + |
| 9 | +Grab the latest version for your system on the [Releases](https://github.com/hyperhq/hypercli/releases) page or build it by yourself as the [instruction](#how-to-build). |
| 10 | + |
| 11 | +You can either run the binary directly or add somewhere in your $PATH. |
| 12 | + |
| 13 | +## Getting Started |
| 14 | + |
| 15 | +#### Before Getting Started |
| 16 | + |
| 17 | +Before you can use Hyper.sh, be sure you've [created a free account with Hyper.sh](http://www.hyper.sh) and [generate your credentials on Hyper.sh](https://docs.hyper.sh/GettingStarted/generate_api_credential.html). |
| 18 | + |
| 19 | +Once the installation and setup completes, enter `hyper config` in your terminal. The CLI will prompt to ask for your API credential: |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | +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`. |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +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). |
| 28 | + |
| 29 | +You only need to do that once for your machine. If you've done that, then you can continue. |
| 30 | + |
| 31 | +[See the official docs](http://docs.hyper.sh/) for more detailed info on using Hyper.sh. |
| 32 | + |
| 33 | +#### Actually Getting Started |
| 34 | + |
| 35 | +The easiest way to get started is by digging around. |
| 36 | + |
| 37 | +`$ hyper --help` for example usage and a list of commands |
| 38 | + |
| 39 | +## How to build |
4 | 40 |
|
5 | | -How to build |
6 | 41 | ``` |
7 | 42 | $ mkdir $GOPATH/src/github.com/hyperhq/ |
8 | 43 | $ cd $GOPATH/src/github.com/hyperhq/ |
9 | 44 | $ git clone https://github.com/hyperhq/hypercli hypercli |
10 | 45 | $ cd hypercli |
11 | 46 | $ ./build.sh |
12 | 47 | ``` |
| 48 | + |
| 49 | +## Contributing |
| 50 | + |
| 51 | +Give us a pull request! File a bug! |
| 52 | + |
0 commit comments