#Settings

#Where it lives

labdash settings path      # where the file is
labdash settings show      # what is in it, never a credential

labdash settings show prints an example file when there is nothing to show.

#Pointing at a different file

Pass --config <path>, or set LABDASH_CONFIG. A separate work and personal setup is two files.

labdash --config ~/work/labdash.yml

#What it holds

Four areas, and nothing else.

#Instances

Which GitLab labdash talks to, and how to reach it: the host, apiHost, subfolder, an OAuth clientId, a CA certificate, a client certificate, a proxy, and custom headers. repoPaths records where your clones live on disk.

#Your account

Nothing in this file is secret. An instance names the environment variable that holds its token in tokenEnv, and that is the whole of it. Tokens live in the OS keyring, or in credentials.json at mode 0600 on a machine with no keyring. See security.

#Appearance

Theme name, icon set, row density, table separators, date format, timezone, spinner style, reduced motion, and the splash. Beside them sit three operational switches: log sets the log level, updateCheck turns the release check on or off, and confirmQuit decides whether q asks first.

#Notifications

Three switches deciding when labdash raises a desktop notification. Two of the three are off, and the one that is on fires only for a pipeline you pointed at yourself. See watch and notify.

#The whole file, at its largest

defaultHost: gitlab.example.com

instances:
  gitlab.example.com:
    apiHost: api.example.com
    subfolder: gitlab
    clientId: <application id>
    tokenEnv: GITLAB_WORK_TOKEN
    caCert: /etc/ssl/corp-root.pem
    proxy: http://proxy.corp:3128

repoPaths:
  platform/*: ~/code/platform/*

theme:
  name: ember
  dateFormat: relative

notifications:
  onWatchedPipeline: true

log:
  level: warn

That is the ceiling rather than a starting point. Against gitlab.com, a machine with no settings file at all reaches a working dashboard.

#Settings and state

labdash keeps a second file for what it remembers: pinned views, collapsed groups, sort order, and the view you were last on. labdash writes that file itself, migrates it between versions, and resets it with a note if it ever becomes unreadable. Delete it and you lose your pins; nothing else changes. What a view contains comes from browsing, filtering, and pinning inside the application, not from the settings file.

#Related pages