Skip to main content

Crate splashboard

Crate splashboard 

Source

Modules§

cache
catalog
TTY-formatted views over the fetcher / renderer catalog. Same data the xtask crate renders as Markdown for the docs site, reshaped for interactive terminal browsing: column-aligned plain text, compact enough for 80-column windows, dependency-free.
config
daemon
fetcher
install
One-shot onboarding: splashboard install wires the shell rc + writes a starter home/project dashboard pair from the template catalog. In a TTY we open a small gallery picker so users preview each preset before committing; non-TTY callers must supply --home-template / --project-template for a deterministic scripted flow.
layout
logging
tracing initialization for splashboard.
options
paths
payload
render
runtime
samples
Sample-output helpers and shape-level fallbacks.
secrets
Loader for $HOME/.splashboard/secrets.toml — a flat top-level TOML map of KEY = "value" pairs that get exported as process env at startup. Lives in its own file (not settings.toml) so dotfiles-in-git users can git-ignore exactly the file that holds tokens without losing their settings.
shell
templates
Curated dashboard templates shipped with splashboard. Each entry is a ready-to-run DashboardConfig — users pick one via splashboard install --template <name> (#58) and drop it into their $HOME/.splashboard/<home|project>.dashboard.toml or a repo’s ./.splashboard/dashboard.toml. Embedded via include_str! so no filesystem lookup is needed at install time.
theme
Semantic colour keys. Renderers look up named keys rather than hard-coding Color::Green, so users can repaint the whole splash by overriding a handful of tokens in [theme].
time
Project-wide locale + timezone helpers. Every fetcher / renderer that emits a human-readable timestamp goes through here so the same [general] defaults (and per-widget overrides) drive every clock-shaped output instead of each site reaching for Local::now() / Utc::now() independently.
trust