Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/update readme #21

Merged
merged 4 commits into from
Oct 12, 2018
Merged

Feature/update readme #21

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bb02ad2
add development steps to readme
iampeterbanjo Oct 11, 2018
a3ae987
fix markdown lint issues
iampeterbanjo Oct 11, 2018
71ebbbf
mention recommended dev approach
iampeterbanjo Oct 11, 2018
0ae3e40
add jenkins installation notes
iampeterbanjo Oct 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 20 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,16 @@

![usage](usage.gif)

A commandline interface for Jenkins.
A commandline interface for Jenkins.

### Features
## Features

* Queries the current status of jobs in parallel.
* Can trigger Jenkins builds from the commandline.
* Visualizes the status of jobs and nodes.
* Can diff the output two runs.

###

```
```Shell
usage: riffraff [<flags>] <command> [<args> ...]

Flags:
Expand Down Expand Up @@ -52,46 +50,52 @@ Commands:
Open a job in the browser
```

### Installation
## Installation

```
```Shell
go get github.com/mre/riffraff
```

...or download a static binary from the [releases page](https://github.com/mre/riffraff/releases).

### Getting started
## Getting started

You need to set the following environment variables:

```
```Shell
export JENKINS_URL="http://example.com/"
export JENKINS_USER="username"
export JENKINS_PW="password"
```

You might want to put those into your `~/.bashrc`, `~/.zshrc` or equivalent.

## Usage

### Usage

```
```Shell
riffraff status jenkins-job-name
```

This will print the current status of all Jenkins jobs matching the given pattern (`jenkins-job-name` in this case).
You can use any regular expression for that, e.g.:

```
```Shell
riffraff status "^application-.*-unittests$"
```

You can get the full output of each last job matching the pattern with
You can get the full output of each last job matching the pattern with

```
```Shell
riffraff status -v "^application-.*-unittests$"
```

### OBTW
## Development

* Install golang version 1.11 or later for [go modules](https://github.com/golang/go/wiki/Modules) support
* Clone this repository to a directory in your `$GOPATH/src` tree (recommended) or use`go get -u github.com/mre/riffraff.git` (uses https not SSH)
* In the source folder run `go run main.go` to install modules and run `riffraff`
* If you don't have a Jenkins server you can run it by using its [`.war` file](https://jenkins.io/doc/pipeline/tour/getting-started/) (recommended) or installing its [`.deb` file](https://jenkins.io/doc/book/installing)

## OBTW

The tool is named after the [butler from the Rocky Horror Picture Show](https://en.wikipedia.org/wiki/The_Rocky_Horror_Picture_Show:_Let%27s_Do_the_Time_Warp_Again), and not the rapper with the same name ;-).