Skip to content

Quick Start

Jump to bottom
savvy773 edited this page May 26, 2026 · 2 revisions

Quick Start

Get the dashboard running in under 2 minutes.

Requirements

  • Windows (PowerShell 7+)
  • Node.js 20+
  • pnpm (npm install -g pnpm)
  • At least one of: Claude CLI, Codex CLI, Gemini CLI

One-Liner Install

irm https://raw.githubusercontent.com/savvy773/ai_usage/main/scripts/install.ps1 | iex

Clones the repo, installs dependencies, and optionally opens the dashboard.

Manual Install

git clone https://github.com/savvy773/ai_usage.git
cd ai_usage
pnpm install
.\scripts\start-server.ps1 -Open

Dashboard runs at http://127.0.0.1:5173

Server Script Options

.\scripts\start-server.ps1             # start (default port 5173)
.\scripts\start-server.ps1 -Open       # start + open browser
.\scripts\start-server.ps1 -Port 5174  # custom port
.\scripts\start-server.ps1 -Mode preview  # production preview build
.\scripts\start-server.ps1 -Status     # check if server is running
.\scripts\start-server.ps1 -Help       # show all options

Uses --strictPort. Only restarts a server it previously started — will not kill unrelated processes on the same port.

Development Mode

pnpm dev          # hot-reload dev server
pnpm check        # TypeScript + Svelte type check
pnpm build        # production build
pnpm lint         # ESLint + Prettier check

Enable verbose collector output:

$env:AI_USAGE_DEBUG_LOGS=1; .\scripts\start-server.ps1

First Refresh

After the server starts:

  1. Open http://127.0.0.1:5173
  2. Click Refresh — or wait for the auto-refresh
  3. Each provider runs its CLI, collects data, and updates the dashboard

If a provider shows partial on the first run, click Refresh again — CLI startup timing can cause one failed attempt.

See Also

Clone this wiki locally