-
Notifications
You must be signed in to change notification settings - Fork 237
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add go tooling instructions to CONTRIBUTING
Make README setup instructions independent of go tools, also updated binary name to match with beta.
- Loading branch information
Zachary Scott
committed
Jun 22, 2018
1 parent
8493988
commit 8d42f72
Showing
2 changed files
with
40 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,42 +2,24 @@ | |
|
||
This project is the seed for CircleCI's new command-line application. | ||
|
||
## Requirements | ||
|
||
* Go 1.10+ | ||
* Make | ||
* ... | ||
|
||
## Getting Started | ||
|
||
You should already have [installed Go](https://golang.org/doc/install) and setup your [workspace](https://golang.org/doc/code.html#Workspaces). | ||
|
||
This includes setting a valid `$GOPATH`. | ||
|
||
### 1. Get the repo | ||
|
||
TODO: make this easier once repo is public | ||
### 1. Get the latest binary | ||
|
||
``` | ||
# Setup circleci source in your $GOPATH | ||
$ mkdir -p $GOPATH/src/github.com/circleci | ||
$ cd $GOPATH/src/github.com/circleci | ||
# Clone the repo | ||
$ git clone [email protected]/circleci/circleci-cli | ||
$ cd circleci-cli | ||
``` | ||
Download the [latest release](https://github.com/CircleCI-Public/circleci-cli/releases/latest) from GitHub for your operating system. If you're on a Mac, this would be `circleci-cli_0.1.X_darwin_amd64.tar.gz`. | ||
|
||
### 2. Build the binary | ||
### 2. Put the binary in your $PATH | ||
|
||
``` | ||
$ make | ||
$ tar -xvzf circleci-cli_0.1.X_darwin_amd64.tar.gz | ||
$ mv circleci-beta /usr/local/bin | ||
``` | ||
|
||
### 3. Run Diagnostic check | ||
### 3. Run a Diagnostic check | ||
|
||
``` | ||
$ ./build/target/darwin/amd64/circleci-cli diagnostic | ||
$ circleci-beta diagnostic | ||
Please enter your CircleCI API token: | ||
OK. | ||
|
@@ -88,7 +70,7 @@ fragment FullType on __Type { | |
You can now pipe that file to the `query` command to send it. | ||
|
||
``` | ||
$ cat query.gql | ./build/target/darwin/amd64/circleci-cli query | ||
$ cat query.gql | circleci-beta query | ||
``` | ||
|
||
This should pretty-print back a JSON response from the server: | ||
|