https://github.com/jessfraz/tdash
A terminal dashboard with stats from Google Analytics, GitHub, Travis CI, and Jenkins. Very much built specific to me.
https://github.com/jessfraz/tdash
Last synced: 10 days ago
JSON representation
A terminal dashboard with stats from Google Analytics, GitHub, Travis CI, and Jenkins. Very much built specific to me.
- Host: GitHub
- URL: https://github.com/jessfraz/tdash
- Owner: jessfraz
- License: mit
- Created: 2018-03-26T13:56:24.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-24T17:27:24.000Z (about 2 years ago)
- Last Synced: 2025-03-28T17:06:45.250Z (17 days ago)
- Language: Go
- Homepage:
- Size: 4.78 MB
- Stars: 309
- Watchers: 10
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tuis - tdash
README
# tdash
[](https://github.com/jessfraz/tdash/actions?query=workflow%3A%22make+all%22)
[](https://github.com/jessfraz/tdash/actions?query=workflow%3A%22make+image%22)
[](https://godoc.org/github.com/jessfraz/tdash)
[](https://github.com/jessfraz/tdash/releases)
A terminal dashboard with stats from Google Analytics, GitHub, Travis CI, and Jenkins. Very much built specific to me.
**Table of Contents**
- [Installation](#installation)
- [Binaries](#binaries)
- [Via Go](#via-go)
- [Running with Docker](#running-with-docker)
- [Usage](#usage)
- [Setup](#setup)
- [Google Analytics](#google-analytics)
- [Travis](#travis)
## Installation
#### Binaries
For installation instructions from binaries please visit the [Releases Page](https://github.com/jessfraz/tdash/releases).
#### Via Go
```console
$ go get github.com/jessfraz/tdash
```
#### Running with Docker
```console
$ docker run --rm -it \
--name tdash \
--volume /home/user/.tdash:/root/.tdash:ro \ # for the Google Analytics key file
r.j3ss.co/tdash
```
## Usage
```conosle
$ tdash -h
tdash - A terminal dashboard with stats from Google Analytics, GitHub, Travis CI, and Jenkins.
Usage: tdash
Flags:
--travis-owner Travis owner name for builds (can have more than one) (default: [])
-d enable debug logging (default: false)
--ga-viewid Google Analytics view IDs (can have more than one) (default: [])
--interval update interval (ex. 5ms, 10s, 1m, 3h) (default: 2m0s)
--jenkins-password Jenkins password for authentication (or env var JENKINS_PASSWORD)
--jenkins-uri Jenkins base URI (or env var JENKINS_BASE_URI)
--jenkins-username Jenkins username for authentication (or env var JENKINS_USERNAME)
--all Show all builds even successful ones, defaults to only showing failures (default: false)
--ga-keyfile Path to Google Analytics keyfile (default: ~/.tdash/ga.json)
--travis-token Travis CI API token (or env var TRAVISCI_API_TOKEN)
Commands:
version Show the version information.
```
## Setup
### Google Analytics
1. Enable the API: To get started using Analytics Reporting API v4, you need to
first create a project in the
[Google API Console](https://console.developers.google.com),
enable the API, and create credentials.
Follow the instructions
[for step enabling the API here](https://developers.google.com/anaytics/devguides/reporting/core/v4/quickstart/service-java).
2. Add the new service account to the Google Analytics account with
[Read & Analyze](https://support.google.com/analytics/answer/2884495)
permission.
The newly created service account will have an email address that looks
similar to: `[email protected]`.
Use this email address to
[add a user](https://support.google.com/analytics/answer/1009702) to the
Google Analytics view you want to access via the API.
### Travis
1. Get your Travis token: Go to the "Profile" tab on your
[Accounts page](https://travis-ci.org/profile)