devdash

DevDash is a configurable terminal dashboard for developers and creators: choose the metrics you need, from your computer, your servers, Github or Google, and display them in one place.

[!NOTE] This is the maintained fork of Phantas0s/devdash, archived in 2023. It supports Google Analytics 4 and runs on current Go and libraries. Coming from the original? See Upgrading.

Features

• Display data from:
  • Your computer, or a remote one through SSH: memory, CPU, disks, network... and the output of your own commands and scripts.
  • Github: stars, views, commits, issues, pull requests, Github Actions runs.
  • Google Analytics 4 and Google Search Console.
  • Any API answering in JSON.
  • The availability of your websites, Feedly subscribers, the branches of a local Git repository.
• Place your widgets on a grid, and choose their size, colors and data. Everything has a default.
• Reuse options with themes.
• As many dashboards as you want, written in YAML, JSON or TOML, and switch between them with a keystroke.
• The data is refreshed automatically, or with a keystroke. Edit a dashboard without leaving DevDash.
• devdash check finds the mistakes in your dashboards, and a JSON schema gives the completion of your editor.

Installation

Download the binary for your OS from the latest release, or:

# Linux, into /usr/local/bin
curl -fsSL https://raw.githubusercontent.com/PiercingXX/devdash/master/install/linux.sh | bash

# With Go 1.26 or later
go install github.com/PiercingXX/devdash@latest

Getting started

Run devdash. On the first run, it creates a default dashboard in $XDG_CONFIG_HOME/devdash/default.yml (~/.config/devdash on Linux) and displays it.

• CTRL+e edits the dashboard, CTRL+r reloads it, CTRL+n / CTRL+p switch to the next / previous one, CTRL+c quits.
• devdash -c <name> displays another dashboard, for example one of the examples.
• devdash list lists your dashboards, devdash generate creates one for a blog or a Github project, devdash check finds their mistakes.

Documentation

• Getting started: installation, commands, keyboard shortcuts.
• Examples, with their screenshots.
• Configuration, widgets and display options, dates.
• The services: Monitor, Host, Github, Google Analytics 4, Google Search Console, Feedly, Git, Display, JSON.
• Upgrading from the original DevDash.

Contributing

Bug reports, ideas and pull requests are welcome: see CONTRIBUTING.md. Please report vulnerabilities privately, see SECURITY.md. The changelog lists the changes of each version.

Acknowledgements

DevDash was created by Matthieu Cneude. The gopher of the logo comes from the free gophers pack of MariaLetta. DevDash was inspired by wtf and tdash.

Licence

Apache Licence 2.0