bodash

bodash

bodash (Blue Ocean dashboard) is a CLI dashboard for displaying Jenkins job states in your terminal using the Blue Ocean REST API.

By default, bodash queries https://$BODASH_DOMAIN/blue/rest/users/$BODASH_USER/favorites once and displays the received name, id, job state/result and either running job duration or relative finished job end time in a colorized tabular format.

The dashboard looks something like this:

Tue, 22 Feb 2022 22:22:22 UTC
-----------------------------
App Test Deploy        9052   RUNNING  1 minute 42 seconds
App Build              12345  RUNNING  5 minutes 8 seconds
App Long Test          9125   FAILURE  1 hour 12 minutes ago
App Staging Deploy     5255   SUCCESS  4 hours 24 minutes ago
App Production Deploy  942    SUCCESS  2 days 5 hours ago

Installation

Get a pre-built binary from releases or build from source:

$ git clone https://github.com/jnnl/bodash
$ cd bodash
$ go build

Configuration

Run bodash --help to get available configuration options.

These options must be provided, either as command line arguments or environment variables:

• -user or BODASH_USER: Jenkins user whose favorites will be queried for job information.
• -token or BODASH_TOKEN: API token for supplied Jenkins user.

Also, one of the following must be provided:

• -domain or BODASH_DOMAIN: Blue Ocean instance domain name.
• -url or BODASH_URL: Blue Ocean favorites url, overrides -domain.

Note that provided command line arguments will always take precedence over corresponding environment variables.

If you wish to run the dashboard in a periodically updating loop, specify the -interval along with a 1 second or greater time.ParseDuration compatible duration string.

Here's how to display a dashboard for jobs favorited in Blue Ocean as user dashboard on ci.example.com, refreshed every 5 seconds:

bodash -domain ci.example.com -user dashboard -token 0123456789ABCDEF -interval 5s

Notes

• bodash currently uses HTTP basic authentication to authenticate with the Blue Ocean API. This may change in the future.