{"id":13437207,"url":"https://github.com/Phantas0s/devdash","last_synced_at":"2025-03-19T06:30:51.580Z","repository":{"id":35128159,"uuid":"143766121","full_name":"Phantas0s/devdash","owner":"Phantas0s","description":":bento: Highly Configurable Terminal Dashboard for Developers and Creators","archived":true,"fork":false,"pushed_at":"2023-07-19T05:44:41.000Z","size":48450,"stargazers_count":1620,"open_issues_count":8,"forks_count":37,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-02-19T06:25:14.007Z","etag":null,"topics":["cli","dashboard","github","go","golang","google-analytics","google-search-console","gopher","metrics","monitoring","terminal","terminal-dashboards","tui"],"latest_commit_sha":null,"homepage":"https://thedevdash.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Phantas0s.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/funding.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"Phantas0s"}},"created_at":"2018-08-06T18:16:55.000Z","updated_at":"2025-02-10T18:52:54.000Z","dependencies_parsed_at":"2024-01-10T02:43:18.020Z","dependency_job_id":null,"html_url":"https://github.com/Phantas0s/devdash","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Phantas0s%2Fdevdash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Phantas0s%2Fdevdash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Phantas0s%2Fdevdash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Phantas0s%2Fdevdash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Phantas0s","download_url":"https://codeload.github.com/Phantas0s/devdash/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244370880,"owners_count":20442309,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","dashboard","github","go","golang","google-analytics","google-search-console","gopher","metrics","monitoring","terminal","terminal-dashboards","tui"],"created_at":"2024-07-31T03:00:55.056Z","updated_at":"2025-03-19T06:30:46.571Z","avatar_url":"https://github.com/Phantas0s.png","language":"Go","readme":"![travis CLI](https://travis-ci.org/Phantas0s/devdash.svg?branch=master\u0026style=for-the-badge) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/ec1e19b08f3b40d19f3acaf93e3e186b)](https://www.codacy.com/app/Phantas0s/devdash?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=Phantas0s/devdash\u0026amp;utm_campaign=Badge_Grade)  [![Go Report Card](https://goreportcard.com/badge/github.com/Phantas0s/devdash)](https://goreportcard.com/report/github.com/Phantas0s/devdash) [![Hits-of-Code](https://hitsofcode.com/github/phantas0s/devdash)](https://hitsofcode.com/view/github/phantas0s/devdash) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Documentation](https://img.shields.io/website?url=https%3A%2F%2Fthedevdash.com\u0026label=documentation)\n![logo of devdash with a gopher](./doc/img/logo.jpg) \n[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=DevDash%20-%20Highly%20Configurable%20Terminal%20Dashboard%20For%20Developers:\u0026url=https%3A%2F%2Fgithub.com%2Fphantas0s%2Fdevdash\u0026hashtags=developers,dashboard,terminal,CLI,golang)\n\nDevDash is a highly configurable terminal dashboard for developers and creators who want to choose and display the most up-to-date metrics they need, at one place.\n\n[![google analytics example DevDash configuration](./example/img/mix-1.png)](https://raw.githubusercontent.com/Phantas0s/devdash/master/example/img/mix-1.png)\n\n## Why using DevDash?\n\n* Pull and display the data in nice widgets using YAML (or JSON) config files, from: \n    * Your own computer. From your own scripts and command lines too!\n    * A remote computer via SSH.\n    * Github.\n    * Travis.\n    * Google Analytics.\n    * Google Search Console.\n    * Feedly.\n\n* A lot of flexibility compared to other terminal dashboards:\n  * Choose the widgets you want.\n  * Place your widgets where you want.\n  * Choose the data you want to display, the colors you want to use, and a lot of other things for each widget.\n  * Don't want to personalize everything? Don't overwrite the defaults, then.\n* Unlimited amount of different dashboards with different configurations.\n* Data refreshed automatically via time ticks, or via a keyboard shortcut (Ctrl + r by default).\n\n## Video\n\nYou can watch a [quick demo on Youtube](https://www.youtube.com/watch?v=aYQVJRuBrC8\u0026feature=youtu.be).\n\n## Menu\n\n* [Installation](#installation)\n* [Getting Started](#getting-started)\n* [Documentation](#documentation)\n* [Acknowledgement](#acknowledgement)\n* [Contribute](#contribute)\n* [Licence](#licence)\n* [Making of](#Making-of)\n* [Showcase](#showcase)\n\n## Installation\n\nYou can simply grab the [latest released binary file](https://github.com/Phantas0s/devdash/releases/latest) and download the version you need, depending on your OS.\n\n### Linux script\n\nTo download DevDash in `/usr/local/bin`, run the following in a terminal:\n\n```shell\ncurl -LO https://raw.githubusercontent.com/Phantas0s/devdash/master/install/linux.sh | bash\n```\n\n### macOS\n\nOn macOS, DevDash can also be installed via [MacPorts](https://www.macports.org):\n\n```shell\nsudo port install devdash\n```\n\nMore information [here](https://ports.macports.org/port/devdash/).\n\n### Manual installation\n\nYou need to: \n1. Clone this repository \n2. In your terminal, run in the root directory of the project `go build devdash.go`\n\n## Getting started\n\n* If you run `devdash` without giving a dashboard configuration, it will:\n    * Create a config for the default dashboard (`default.yml`) in `$XDG_CONFIG_HOME/devdash`.\n    * Display this default dashboard.\n* You have [many examples here](https://thedevdash.com/getting-started/examples/) to modify this default dashboard or create your own from scratch.\n* Each dashboard need a config file. To pass this config file to DevDash, you need to use the option `-c`. For example: `devdash -c default`.\n    * If you only pass the filename of the dashboard's config, it needs to be in the working directory or in `$XDG_CONFIG_HOME/devdash`.\n    * You can also pass a relative or absolute path to the config.\n    * The dashboard's config can be written in YAML, JSON, or TOML.\n\nThe value of `$XDG_CONFIG_HOME` depends of your OS. Here are the defaults (if you didn't modify it):\n\n* **Unix systems**: `~/.config`\n* **macOS**: `~/Library/Application Support`\n* **Windows**: `%LOCALAPPDATA%`\n\n\n## Documentation\n\n[The complete DevDash documentation is here](https://thedevdash.com)\n\nYou'll find in there:\n\n* [Installation / getting started](https://thedevdash.com/getting-started/installation/)\n* [Simple examples](https://thedevdash.com/getting-started/examples/)\n* [Real-life use cases](https://thedevdash.com/getting-started/use-cases/devdash/)\n* [Complete reference of dashboard's config](https://thedevdash.com/reference/)\n\nIf you want to see even more real life examples, I've [all of them in my dotfiles](https://github.com/Phantas0s/.dotfiles/tree/master/devdash).\n\n## Acknowledgement\n\nThanks to [MariaLetta](https://github.com/MariaLetta/free-gophers-pack) for the awesome and beautiful Gopher pack! I used it for my logo on top.\n\nDevDash was inspired from other open source projects:\n\n* [wtf](https://github.com/wtfutil/wtf)\n* [tdash](https://github.com/jessfraz/tdash)\n\n## Bugs and Ideas\n\nIf you have any idea to improve DevDash or if you see any bug, please open an issue.\n\n## Contribute\n\nThanks a lot if you want to contribute to DevDash!\n\nIf you want to implement a new feature, let's speak about it first (by opening an issue) and decide if it fits DevDash scope.\n\n## Making Of\n\nFor anybody interested how I managed to develop DevDash on side of a full time job, and how I organized my time and kept my motivation, [I wrote an article about that on my blog](https://thevaluable.dev/programming-side-project-example-devdash/).\n\n## Licence\n\n[Apache Licence 2.0](https://choosealicense.com/licenses/apache-2.0/)\n\n## Showcase\n\n![google analytics example DevDash configuration](./example/img/thevaluabledev-2.png)\n-------\n![google analytics example DevDash configuration](./example/img/terminal.png)\n-------\n![google analytics example DevDash configuration](./example/img/thevaluabledev-3.png)\n-------\n![github example DevDash configuration](./example/img/devdash-1.png)\n","funding_links":["https://github.com/sponsors/Phantas0s"],"categories":["HarmonyOS","Command Line","Go","Repositories"],"sub_categories":["Windows Manager","Terminal Dashboard"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPhantas0s%2Fdevdash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPhantas0s%2Fdevdash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPhantas0s%2Fdevdash/lists"}