lazygocd
~/lazygocd/quickstart

Quickstart

There is no setup wizard outside the app. Run lazygocd and the connect form opens right in the terminal, walks you through four inputs, and drops you into the dashboard.

First run: the connect form

  1. Server URL

    Your GoCD base URL including the /go path, for example https://gocd.example.com/go, with no trailing slash.

  2. Auth method

    An arrow-key choice between username & password and an access token. Tokens are recommended; create one in GoCD under your user's Access Tokens page.

  3. Credential

    The token or password, typed masked. If your server has no auth at all, leave the username blank.

  4. TLS choice

    Whether to skip TLS certificate verification. Say no unless the server uses a self-signed certificate you trust.

  5. Done

    On confirm it saves the config and loads straight into the dashboard. Press A any time later to reopen the same form as "Reconnect to GoCD", for example after a token expires.

Where config lives

Everything is written under ~/.config/lazygocd/. The config file is saved with mode 0600 because it holds a plaintext credential.

~/.config/lazygocd/config.toml 
server_url = "https://gocd.example.com/go"

# one of the two auth styles:
auth_token = "your-access-token"          # recommended
# username = "ci-viewer"
# password = "..."

insecure_skip_verify = false              # true only for self-signed certs
poll_interval_secs = 30                    # dashboard/history auto-refresh

# optional: only needed to check private repos' latest commit
# github_token = "ghp_..."  (optional: gh auth token is used automatically if unset)
# github_api_base = "https://ghe.example.com/api/v3"  (GitHub Enterprise)
# notifications = true  (desktop alerts when a favorite starts failing)
FileWhat it holds
config.tomlServer URL, credentials, TLS choice, poll interval, optional GitHub token. Mode 0600.
dashboard_cache.jsonThe last successful dashboard load, so the next launch paints instantly. Safe to delete.
favorites.jsonNames of starred pipelines, pinned to the top of the tree.

Environment variable overrides

Env vars always win over the config file. Handy for scripting, CI, or trying a second server without touching your saved config. Setting a full set (URL plus a credential) skips the connect form entirely.

VariableOverrides
GOCD_URLServer base URL, e.g. https://gocd.example.com/go
GOCD_USERNAMEUsername for basic auth
GOCD_PASSWORDPassword for basic auth
GOCD_TOKENAccess token; used instead of username/password when set
GOCD_INSECUREAny value skips TLS certificate verification (e.g. GOCD_INSECURE=1)
GITHUB_TOKENGitHub personal access token for private-repo commit checks
 
# one-shot session against a different server, config file untouched
$ GOCD_URL=https://gocd.example.com/go GOCD_TOKEN=your-token lazygocd
tip Press @ inside the app to connect a GitHub token interactively instead of exporting GITHUB_TOKEN. It's optional either way; public repos are checked unauthenticated (rate-limited).
Learn the keys How it stays fast