docs/src/content/docs/configuration/defaults.mdx
defaults)These settings define the default behavior for the dashboard. You can override many of these settings on a per-section basis.
defaults:
issuesLimit: 20
notificationsLimit: 20
prApproveComment: LGTM
preview:
open: true
width: 0.45
prsLimit: 20
refetchIntervalMinutes: 30
view: prs
By default, the dashboard is configured to:
For more details on the default layouts, see the documentation for PR and issue layout definitions.
layout)This setting defines the layout for the work item tables in the dashboard. You can override
these settings in any section you define in the prSections or issueSections settings.
They determine which columns are displayed and how.
You can define how a PR section displays items in its table by setting options for the available columns. You can define a column's width, whether it grows to fill available space, and whether the column should be visible at all.
Note that if the length of a column's text exceeds the defined column width, the view
truncates the column's text to two characters shorter than the column's width. For example, if
the width is 6, gh-dash displays as gh-d.
Column headings have their color defined by the theme.colors.text.primary setting.
For more information, see PR Section Layout.
issues)You can define how an issue section displays items in its table by setting options for the available columns. You can define a column's width, whether it grows to fill available space, and whether the column should be visible at all.
Note that if the length of a column's text exceeds the defined column width, the view
truncates the column's text to two characters shorter than the column's width. For example, if
the width is 6, gh-dash displays as gh-d.
Column headings have their color defined by the theme.colors.text.primary setting.
For more information, see Issue Section Layout.
| Type | Minimum | Default |
|---|---|---|
| Integer | 1 | 20 |
This setting defines how many PRs the dashboard should fetch for each section when:
issuesLimit)| Type | Minimum | Default |
|---|---|---|
| Integer | 1 | 20 |
This setting defines how many issues the dashboard should fetch for each section when:
notificationsLimit)| Type | Minimum | Default |
|---|---|---|
| Integer | 1 | 20 |
This setting defines how many notifications the dashboard should fetch when:
preview)These settings define how the preview pane displays in the dashboard. You can specify whether the preview pane is open by default and how many columns wide it should be when
open)| Type | Default |
|---|---|
| Boolean | true |
Specifies whether the preview pane should be open by default for the selected work item when the dashboard loads. You can always use the toggle preview pane command to toggle the preview pane's visibility.
By default, the dashboard displays the preview pane.
width)| Type | Minimum | Default |
|---|---|---|
| Number | 0 | 0.45 |
Specifies the width of the preview pane. You can set the size to the percentage of the terminal size by using fractions (e.g. 0.4 would be 40%).
By default, the preview pane is 45% wide.
refetchIntervalMinutes)| Type | Minimum | Default |
|---|---|---|
| Integer | 0 | 30 |
This setting defines how often the dashboard should fetch issues and PRs from GitHub. The dashboard fetches work items for every section in the active view when the dashboard loads and the first time you switch to the inactive view.
After the dashboard fetches the work items for the first time, it waits until this setting's defined interval elapses before fetching the work items again.
By default, the dashboard refetches work items every 30 minutes.
To disable the refetching interval set it to 0.
You can always use the refresh current section or refresh all sections command to refetch work items in the current view. If you change the search query for a view, the dashboard fetches results for the updated query immediately.
dateFormat)| Type | Default |
|---|---|
| String | "relative" |
This setting defines how dates are formatted. The format either be "relative" or a go time format.
By default, the format is "relative" which fits just inside the default column width of updated at in the issues and pull request layouts.
You may need to adjust the layout column width depending on your format.
view)| Type | Options | Default |
|---|---|---|
| String | "prs", "issues" | 20 |
This setting defines whether the dashboard should display the PRs or Issues view when it first loads.
By default, the dashboard displays the PRs view.
prApproveComment)| Type | Default |
|---|---|
| String | "LGTM" |
This setting defines the default comment used as a starting point when approving a PR. This can be set as an empty string to not prefill a comment.
By default, the comment is "LGTM".
confirmQuit)| Type | Default |
|---|---|
| Boolean | false |
This setting specifies whether the user needs to confirm when quitting gh-dash
When this is on, gh-dash shows a prompt that requires the user to press <kbd>y</kbd>/<kbd>Enter</kbd> to actually quit.
Pressing any other key dismisses the message.
By default, dash doesn't need a confirmation.
includeReadNotifications)| Type | Default |
|---|---|
| Boolean | true |
This setting controls whether the default notification view includes read notifications alongside unread ones, matching GitHub’s default behavior.
When set to true (the default), notification sections with no explicit is: filter show
both read and unread notifications. When set to false, they show only unread notifications
plus any bookmarked items.
Explicit filters like is:unread or is:read in a section’s filters always override
this setting.
# Show only unread notifications by default (old behavior)
includeReadNotifications: false