Get started/Quickstart

Quickstart

Get Luframe Claude Analytics running in under 5 minutes. Track your Claude Code sessions automatically with our CLI.

Install the CLI

Install the Luframe CLI globally on your system:

npm install -g luframe-cli

Verify the installation:

luframe --version

Create your account

1

Sign up

Create an account at luframe.com/register using your email or OAuth provider (GitHub, Google).

2

Verify your email

Check your inbox for a verification email and click the confirmation link.

Authenticate

Navigate to your project directory and authenticate with Luframe:

cd your-project
luframe auth login

The CLI will open your browser to complete authentication. Once authenticated, your credentials are securely stored locally.

Your authentication token is stored in your system's secure credential store and expires after 7 days. You can refresh it anytime with luframe auth login.

Verify your setup

Check that everything is configured correctly:

luframe status
Authenticated user
Claude Desktop installed and detected
Project detected
Ready to sync sessions

Start coding

That's it! The Luframe CLI runs in the background and automatically syncs your Claude Code sessions. Just start working on your project:

npm run dev

Open Claude Code in your project, have conversations, and watch your dashboard populate with session data in real-time.

What gets tracked?

  • ✓ All Claude Code conversations in your project
  • ✓ Message history and content
  • ✓ Token usage (input, output, cache)
  • ✓ Session metadata and timestamps

Troubleshooting

“No sessions found”

This is normal if you haven't used Claude Code in this project yet. Open the project in Claude Code and have a conversation - sessions will sync automatically.

“Claude Desktop not found”

Install Claude Desktop from claude.ai/download and use it at least once to create the data directory.

“Authentication failed”

Run luframe auth logout and then luframe auth login again to re-authenticate.

Need more help?

Check out the CLI Reference for detailed command documentation.