Usage

To use dash, follow these steps after you’ve installed it:

1. Run

   gh dash

2. Press ? for help.

3. Run gh dash --help for more info:

   Usage:
     gh dash [flags]
   
   Flags:
     -c, --config string   use this configuration file (default lookup: a .gh-dash.yml file if inside a git repo, $GH_DASH_CONFIG env var, or if not set, $XDG_CONFIG_HOME/gh-dash/config.yml)
         --debug           passing this flag will allow writing debug output to debug.log
     -h, --help            help for Dash

Flags

--config

Specify the path to a configuration file to use for the dashboard. If the configuration file doesn’t exist or is invalid, dash returns an error.

gh dash --config path/to/configuration/file.yml

Aliases	Type	Default
-c	String	.gh-dash.yml file if inside a git repo, $GH_DASH_CONFIG env var, or if not set, $XDG_CONFIG_HOME/gh-dash/config.yml

If you don’t specify this flag, dash uses the default configuration. If the file doesn’t exist, dash will create it.

The location of the default configuration file depends on your system:

1. If $GH_DASH_CONFIG is a non-empty string, dash will use this file for its configuration.
2. 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.
3. 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.

For more information about authoring configurations, see Configuration.

--debug

Specify whether dash should write logs to the debug.log file in the current directory. By default, dash doesn’t output debug information.

gh dash --debug

Aliases	Type	Default
(None)	Boolean	false

When you use this flag, dash creates the debug.log file in the current directory if it doesn’t exist. If the file does exist, dash appends new log entries to it.

--help

Use this flag to display the help information for dash in the terminal. If you specify this flag, dash ignores all other flags. It only displays the help information.

gh dash --help

Aliases	Type	Default
-h	Boolean	false

--version

Use this flag to display the version information for dash in the terminal. If you specify this flag with the --config or --debug flags, dash ignores them. It only displays the version information.

gh dash --version

Aliases	Type	Default
-v	Boolean	false

When you use this flag, dash emits the following information:

gh-dash version <version>
commit: <commit_sha>
built at: <build_timestamp>
built by: <build_user>
goos: <operating_system>
goarch: <cpu_architecture>

• <version> is the extension’s semantic version without a v prefix.
• <commit_sha> is the exact commit SHA the extension was built from.
• <build_timestamp> is the UTC date and time when the extension was built.
• <build_user> is who built the extension. For official releases, this is always goreleaser.

For example, the version information for the v3.7.7 release on Windows with an x64 processor is:

gh-dash version 3.7.7
commit: 6ce3f89ab0d73dd88e359133699d1cf920f88699
built at: 2023-04-15T08:42:16Z
built by: goreleaser
goos: windows
goarch: amd64

Default Keybindings

When you use dash, it displays the dashboard as a terminal UI (TUI). In the TUI, you can use several commands by pressing key combinations to navigate and interact with the dashboard.

You can press the ? key to toggle the help menu in the UI. The help menu lists the available keybindings for the current context.

You can press the q key to quit the dashboard and return to your normal terminal view.

For more information about the keybindings for the dashboard, see Keybindings.