open-index/open-npm huggingface dataset:
npm package: @supalytics/cli
Description: CLI for Supalytics web analytics
Author: Supalytics
Latest version: 0.4.4

# Supalytics CLI

Command-line interface for [Supalytics](https://www.supalytics.co) web analytics.

```
░█▀▀░█░█░█▀█░█▀█░█░░░█░█░▀█▀░▀█▀░█▀▀░█▀▀
░▀▀█░█░█░█▀▀░█▀█░█░░░░█░░░█░░░█░░█░░░▀▀█
░▀▀▀░▀▀▀░▀░░░▀░▀░▀▀▀░░▀░░░▀░░▀▀▀░▀▀▀░▀▀▀
```

## Requirements

- [Bun](https://bun.sh) runtime

## Installation

```bash
bun add -g @supalytics/cli
```

## Setup

### Quick Start

```bash
supalytics init
```

Opens browser to log in, creates your site, and gives you the tracking snippet.

### Manual Setup

```bash
supalytics login           # Opens browser for authentication
supalytics sites add       # Create a new site
```

## Usage

### Quick Stats

```bash
supalytics stats              # Last 30 days (default)
supalytics stats today
supalytics stats yesterday
supalytics stats week
supalytics stats month
supalytics stats 7d
```

### Realtime

```bash
supalytics realtime           # Current visitors
supalytics realtime --watch   # Auto-refresh every 30s
```

### Trend

```bash
supalytics trend              # Daily visitor trend with bar chart
supalytics trend --period 7d  # Last 7 days
supalytics trend --compact    # Compact sparkline only
```

### Breakdowns

```bash
supalytics pages              # Top pages
supalytics referrers          # Top referrers
supalytics countries          # Traffic by country
```

### Custom Queries

```bash
# Top pages with revenue
supalytics query -d page -m visitors,revenue

# Traffic by country and device
supalytics query -d country,device -m visitors

# Filter by country
supalytics query -d page -f "country:is:US"

# UTM campaign performance
supalytics query -d utm_source,utm_campaign -m visitors,revenue
```

### Events

```bash
supalytics events                          # List all events
supalytics events signup                   # Show properties for event
supalytics events signup --property plan   # Breakdown by property
```

## Options

All commands support:

- `-s, --site <domain>` - Query a specific site
- `-t, --test` - Query localhost/test data instead of production
- `--json` - Output raw JSON
- `--no-revenue` - Exclude revenue metrics
- `-f, --filter <filter>` - Filter data (format: `field:operator:value`)

### Filters

```bash
-f "country:is:US"
-f "page:contains:/blog"
-f "device:is:mobile"
-f "referrer:is:twitter.com"
```

## Site Management

```bash
supalytics sites                       # List all sites
supalytics sites add example.com       # Create site with domain
supalytics sites add my-project        # Or use any name, update later
supalytics sites update my-project -d example.com  # Set the real domain
supalytics default example.com         # Set default site
supalytics stats -s other.com          # Query specific site
```

## Shell Completions

Enable tab completion for your shell:

```bash
# Bash (add to ~/.bashrc)
eval "$(supalytics completions bash)"

# Zsh (add to ~/.zshrc)
eval "$(supalytics completions zsh)"

# Fish
supalytics completions fish > ~/.config/fish/completions/supalytics.fish
```

## License

Apache-2.0