dashboard

Dashboard Output Formats

The dashboard supports a wide range of output formats, making it easy to consume the data in different ways. The format can be specified using the -f or --format flag.

Below are examples of the output from the hackernews module for each supported format.

---

tsv (Default)

Tab-separated values, similar to CSV but using tabs as delimiters. The format is date\tmodule\tchannels\tnamespace\tvalue.

2025-09-03T14:48:11Z	hackernews	karma	pg	20

---

plain

Simple, clean text output suitable for scripting or a quick glance.

Hacker News
Karma: 20

---

pretty

Text output enhanced with ANSI colors and bolding for better readability in a terminal.

\e[1mHacker News\e[0m
Karma: 20

---

json

A single, well-formed JSON object containing all the metrics. The output from a single module is a fragment that is assembled into a larger object by the main script.

{ "karma": 20 }

When run as a full report, the output looks like this:

{
  "github": {
    "repo-1": { ... }
  },
  "hackernews": {
    "karma": 20
  }
}

---

xml

A single, well-formed XML document containing all the metrics.

<hackernews><karma>20</karma></hackernews>

---

html

A self-contained HTML document for viewing in a web browser.

<h2>Hacker News</h2>
<ul>
  <li>Karma: 20</li>
</ul>

---

yaml

A single, well-formed YAML document.

hackernews:
  karma: 20

---

csv

Comma-separated values suitable for spreadsheets. The format is date,module,channels,namespace,value. For modules with nested data, there will be multiple rows.

2025-09-03T14:48:11Z,hackernews,karma,pg,20

---

---

table

A human-readable ASCII table, generated from the TSV data.

date                  module      channels    namespace   value
2025-09-03T14:48:20Z  hackernews  karma       pg          20

---

markdown

A GitHub-flavored Markdown document.

### Hacker News

- Karma: 20

This site is open source. Improve this page.