plaus

README

plaus

A terminal analytics dashboard for Plausible Analytics. View your website stats without leaving the terminal.

Built with Bubble Tea, Lip Gloss, and ntcharts.

Features

• Top-line metrics: visitors, visits, pageviews, bounce rate, visit duration
• Visitor trend sparkline chart
• Top pages and top sources panels
• Time period switching: today, yesterday, 7 days, 30 days
• Live visitor count with realtime indicator (today view)
• Self-hosted Plausible support

Install

From release

Download the latest binary from Releases.

From source

go install github.com/chrissy-dev/plaus/cmd/plaus@latest

Build locally

git clone https://github.com/chrissy-dev/plaus.git
cd plaus
go build -o plaus ./cmd/plaus

Setup

1. Initialize config

plaus init

Creates ~/.config/plaus/config.json and prompts for your Plausible base URL (defaults to https://plausible.io).

2. Add a site

plaus add example.com

Prompts for your Stats API key and stores it in the config.

3. Launch dashboard

plaus example.com

Keyboard shortcuts

Key	Action
1	Today
2	Yesterday
3	Last 7 days
4	Last 30 days
r	Refresh data
q	Quit

Other commands

plaus sites             # List configured sites
plaus remove example.com  # Remove a site
plaus version           # Show version

Config

Config is stored at ~/.config/plaus/config.json:

{
  "base_url": "https://plausible.io",
  "default_site": "example.com",
  "sites": {
    "example.com": {
      "token": "your-api-key"
    }
  }
}

License

MIT