glance

# Glance

AI-extensible personal dashboard. Create custom widgets with natural language — the AI handles data collection.

## Features

- **Custom Widgets** — Create widgets via AI with auto-generated JSX
- **Agent Refresh** — AI collects data on schedule and pushes to cache
- **Dashboard Export/Import** — Share widget configurations
- **Credential Management** — Secure API key storage
- **Real-time Updates** — Webhook-triggered instant refreshes

## Quick Start

```bash
# Navigate to skill directory (if installed via ClawHub)
cd "$(clawhub list | grep glance | awk '{print $2}')"

# Or clone directly
git clone https://github.com/acfranzen/glance ~/.glance
cd ~/.glance

# Install dependencies
npm install

# Configure environment
cp .env.example .env.local
# Edit .env.local with your settings

# Start development server
npm run dev

# Or build and start production
npm run build && npm start
```

Dashboard runs at **http://localhost:3333**

## Configuration

Edit `.env.local`:

```bash
# Server
PORT=3333
AUTH_TOKEN=your-secret-token        # Optional: Bearer token auth

# OpenClaw Integration (for instant widget refresh)
OPENCLAW_GATEWAY_URL=https://localhost:18789
OPENCLAW_TOKEN=your-gateway-token

# Database
DATABASE_PATH=./data/glance.db      # SQLite database location
```

## Service Installation (macOS)

```bash
# Create launchd plist
cat > ~/Library/LaunchAgents/com.glance.dashboard.plist << 'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>Label</key>
    <string>com.glance.dashboard</string>
    <key>ProgramArguments</key>
    <array>
        <string>/opt/homebrew/bin/npm</string>
        <string>run</string>
        <string>dev</string>
    </array>
    <key>WorkingDirectory</key>
    <string>~/.glance</string>
    <key>RunAtLoad</key>
    <true/>
    <key>KeepAlive</key>
    <true/>
    <key>StandardOutPath</key>
    <string>...

<p align="center">
  <img src="public/logo-text.png" alt="Glance" width="120" />
</p>

<p align="center">
  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" /></a>
  <a href="https://github.com/acfranzen/glance"><img src="https://img.shields.io/badge/Open%20Source-100%25-brightgreen.svg" alt="Open Source" /></a>
</p>

<p align="center">
  <strong>The Dashboard Skill for OpenClaw</strong><br/>
  Stop configuring dashboards. Just tell OpenClaw what you want to see.
</p>

---

Glance is a **free and open source** dashboard that OpenClaw builds and manages for you. Not another app to configure — a skill that gives OpenClaw a visual command center.

Tell OpenClaw _"show me my GitHub PRs"_ and watch it build the widget. Ask _"what needs my attention?"_ and OpenClaw reads your dashboard and tells you. No manual setup. No YAML files. No `.env` hell.

![Glance Dashboard](glance.png)

---

## 🤖 AI Agents: Start Here

If you're an AI agent (OpenClaw, Cursor, Claude, etc.), read these files:

| File                                         | Purpose                                                                    |
| -------------------------------------------- | -------------------------------------------------------------------------- |
| **[SKILL.md](SKILL.md)**                     | Quick reference (~200 lines) — API workflow, code patterns, essential info |
| **[docs/widget-sdk.md](docs/widget-sdk.md)** | Full documentation — components, hooks, examples, error handling           |

**TL;DR workflow:**

1. `POST /api/credentials` — Store API keys (provider, name, value)
2. `POST /api/widgets` — Create widget definition (source_code, server_code)
3. `POST /api/widgets/instances` — Add widget instance to dashboard

---

## 🚀 Quick Start with OpenClaw

### 1. Install Glance

#### Option A: One-Line Install (Recommended)

```bash
curl -fsSL https://openglance.dev/install.sh | bash
```

This will:...