Getting Started

Getting Started with PromptPulse

PromptPulse is a command-line tool and web dashboard for tracking Claude Code usage analytics. This guide will help you get up and running quickly.

Installation

Install PromptPulse globally using npm:

1

npm install -g promptpulse

Quick Start

1. Create Account and Login

Create a new account or login with your API key:

1
2
3
4
5

# Interactive account creation
promptpulse login

# Or login with an existing API key
promptpulse login --api-key your-api-key-here

2. Verify Your Setup

Check your login status:

1

promptpulse whoami

3. Collect Your First Data

Start collecting Claude Code usage data:

1
2
3
4
5

# Collect all available data
promptpulse collect

# Or collect specific granularity
promptpulse collect --granularity daily

4. Set Up Automatic Collection

Configure automatic data collection:

1
2
3
4
5
6
7
8

# Set up 15-minute collection (default)
promptpulse setup

# Set up hourly collection
promptpulse setup --interval 60

# Set up daily collection
promptpulse setup --interval daily

5. View Your Dashboard

Open your web dashboard:

1

promptpulse dashboard

Next Steps

• CLI Reference - Complete command documentation
• Dashboard Guide - Web interface walkthrough
• Teams - Team collaboration features
• Privacy - Understanding data collection

Quick Commands Reference