README.md

May 18, 2026 · View on GitHub

splashboard

A customizable terminal splash rendered on shell startup and on cd.
_{splashboard = splash + dashboard}

Instead of a blinking cursor, every new shell shows a dashboard of the things you actually care about — greetings, git status, CI health, PRs, a contributions heatmap, the moon phase. The killer feature: a repo that ships ./.splashboard/dashboard.toml auto-reshapes the splash when you cd in, so different repos get different splashes for free.

Install

curl -fsSL https://raw.githubusercontent.com/unhappychoice/splashboard/main/install.sh | bash

Other install methods

# cargo
cargo install splashboard

# Homebrew (macOS / Linux)
brew install unhappychoice/tap/splashboard

# cargo-binstall (prebuilt binaries from GitHub Releases)
cargo binstall splashboard

# Nix flake
nix run github:unhappychoice/splashboard
nix profile install github:unhappychoice/splashboard

Prebuilt binaries for Linux (x86_64 / aarch64), macOS (x86_64 / aarch64), and Windows (x86_64) are also attached to each GitHub Release.

splashboard install then detects your shell, walks you through template / theme pickers, and wires your rc for you.

splashboard install

Prefer to own the rc edit yourself? Append one line that re-sources splashboard init <shell> on every shell start — upgrades to splashboard ship an updated init snippet automatically:

echo 'eval "$(splashboard init zsh)"'                              >> ~/.zshrc
echo 'eval "$(splashboard init bash)"'                             >> ~/.bashrc
echo 'splashboard init fish | source'                              >> ~/.config/fish/config.fish
echo 'Invoke-Expression (& splashboard init powershell | Out-String)' >> $PROFILE
splashboard init nushell | save --append ~/.config/nushell/config.nu