Skip to content
This repository was archived by the owner on Feb 8, 2021. It is now read-only.

Commit 5ad7679

Browse files
authored
Merge pull request #220 from carmark/readme
update README.md
2 parents 5ec8817 + 8e9fd20 commit 5ad7679

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

README.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,52 @@
1-
[![Build Status](https://travis-ci.org/hyperhq/hypercli.svg?branch=master)](https://travis-ci.org/hyperhq/hypercli)
1+
# HyperCLI [![Build Status](https://travis-ci.org/hyperhq/hypercli.svg?branch=master)](https://travis-ci.org/hyperhq/hypercli)
22

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+
![](https://trello-attachments.s3.amazonaws.com/56daae9b816ec930c8d98197/720x143/9fdd9a68694376d4ec62a3d93409e67c/upload_3_18_2016_at_6_11_19_PM.png)
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+
![](https://trello-attachments.s3.amazonaws.com/56daae9b816ec930c8d98197/635x160/c9caa016982d5884eb06578292c154bf/config.png)
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
440

5-
How to build
641
```
742
$ mkdir $GOPATH/src/github.com/hyperhq/
843
$ cd $GOPATH/src/github.com/hyperhq/
944
$ git clone https://github.com/hyperhq/hypercli hypercli
1045
$ cd hypercli
1146
$ ./build.sh
1247
```
48+
49+
## Contributing
50+
51+
Give us a pull request! File a bug!
52+

0 commit comments

Comments
 (0)