splashboard 0.2.0

A customizable terminal splash screen with plugin-based data sources
Documentation

splashboard

CI codecov

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

# cargo
cargo install splashboard

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

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

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

After install, run:

splashboard install

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

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

Docs

📖 https://unhappychoice.github.io/splashboard/

  • Getting started — install, wire your shell, render your first splash
  • Concepts — the mental model (Widget = Fetcher + Renderer + Layout slot)
  • Configuration — the full TOML schema
  • Presets & Themes — curated dashboards and palettes
  • Trust model — how per-directory configs are sandboxed
  • Reference — every fetcher and renderer with options and compatible shapes

Status

Usable day-to-day. Widget catalog tracked as a living roadmap in issue #41 — new fetchers and renderers land as PRs that tick the checkboxes.

License

ISC

Related

  • gitlogue — cinematic git history replay
  • gittype — CLI typing game from your source code
  • mdts — local Markdown tree server