How to Configure
dash
has extensive configuration options.
- The config is usually created under
$HOME/.config/gh-dash/config.yml
, but this changes between operating systems anddash
has many ways to override that. dash
will also look for a.gh-dash.yml
file if in a git repository to allow for project specific configuration.- Use the [
--config
][01] flag or$GH_DASH_CONFIG
to specify an alternate configuration.
How does
Using the following logic:dash
determine which configuration file to use?
- If
$GH_DASH_CONFIG
is a non-empty string,dash
will use this file for its configuration. - If
$GH_DASH_CONFIG
isn’t set and you’re in a git repository, it will look for.gh-dash.yml
or.gh-dash.yaml
in the repository root. - If neither of the above applies, then:
- If
$XDG_CONFIG_HOME
is a non-empty string, the default path is$XDG_CONFIG_HOME/gh-dash/config.yml
. - If
$XDG_CONFIG_HOME
isn’t set, then:- On Linux and macOS systems, the default path is
$HOME/.config/gh-dash/config.yml
. - On Windows systems, the default path is
%USERPROFILE%\.config\gh-dash\config.yml
.
- On Linux and macOS systems, the default path is
Options
Section titled “Options”The configuration for dash
is schematized. The pages in this section list the configuration
options, their defaults, and how you can use them.
Schema
Section titled “Schema”Documentation and schema for the configuration of your GitHub dashboard.
PR Section Documentation for configuring the PR sections of your GitHub dashboard.
Issue Section Documentation for configuring the issue's sections of your GitHub dashboard.
Keybindings Documentation for defining commands for your GitHub dashboard.
Searching How to search and filter issues and prs
Defaults Documentation for the default setting options for your GitHub dashboard.
Layout Documentation for configuring your GitHub dashboard’s layout.
Theme Documentation for configuring your GitHub dashboard’s theme.