Documentation

Everything you need to set up BuildTrace and start logging commits with AI summaries.

Quick Start

Get up and running in under 60 seconds. Three steps, zero config.

01

Create an account

Sign up at BuildTrace and grab your API key from Settings > API Key.

02

Initialize in your repo

Run the init command inside any git repository:

$ npx buildtrace init

You'll be asked for your project name and API key. This installs a silent post-commit git hook.

03

Commit and check your dashboard

Make a commit like you normally would. BuildTrace captures it automatically and generates an AI summary (on paid plans). Open your dashboard to see it.

CLI Reference

The BuildTrace CLI installs a git hook that silently logs commits to your dashboard. It never blocks or slows your workflow.

npx buildtrace init

Interactive setup wizard. Run this inside any git repo to connect it to BuildTrace.

# What it does:

  • - Asks for your project name (or creates a new one)
  • - Asks for your API key
  • - Installs a .git/hooks/post-commit hook
  • - Saves config to .buildtrace in your repo root

npx buildtrace status

Check the current BuildTrace configuration for this repo. Displays project name, API key status, and hook installation status.

npx buildtrace uninstall

Remove the BuildTrace git hook and config from this repo. Your dashboard data is not deleted — you can re-init anytime.

npx buildtrace export

Export your commit logs to a BUILDLOG.md file in your repo root. Logs are grouped by date with commit details, AI summaries, and next steps included.

# What it does:

  • - Fetches all commit logs for this project from the API
  • - Groups entries by date, newest first
  • - Writes a formatted BUILDLOG.md to your repo root
  • - Includes AI summaries and next steps (paid plans only)

What gets sent on each commit?

{
  "project": "my-app",
  "hash": "a3f8b2c",
  "message": "Fix login bug",
  "branch": "main",
  "files_changed": ["src/auth.ts", "src/login.tsx"],
  "lines_added": 47,
  "lines_removed": 12,
  "diff": "..."
}

The diff is used by Claude AI to generate plain-English summaries (Builder and Pro plans).

Dashboard Guide

The dashboard is where you view all your projects, read AI summaries, and manage your account.

Projects View

Your main dashboard shows a grid of all connected projects. Each card displays the project name, last commit timestamp, and total commit count. Click a project to see its full commit timeline.

Commit Timeline

Inside a project, commits are listed chronologically with the most recent at the top. Each entry shows the commit hash, branch, message, files changed, and lines added/removed. On paid plans, you'll also see the AI-generated summary.

AI Summaries

Available on Builder ($9/mo) and Pro ($19/mo) plans. Claude AI reads your commit diff and generates a plain-English summary of what changed and why. It also suggests next steps so you always know where to pick up.

Settings

Access your API key, manage your subscription, configure Slack/Discord webhook notifications, connect Slack slash commands, and set up Notion integration (Pro plan). You can regenerate your API key anytime — just update it in your repos with npx buildtrace init.

Integrations

Connect BuildTrace to Slack and Discord for real-time commit notifications and slash commands. Available on Builder and Pro plans.

Slack Notifications (Webhook)

Get a Slack message every time you commit. BuildTrace sends a rich notification with the commit message, branch, files changed, and AI summary.

# Setup:

  1. 1. Go to api.slack.com/apps and create a new app (or select an existing one)
  2. 2. Enable Incoming Webhooks in the sidebar
  3. 3. Click Add New Webhook to Workspace and pick a channel
  4. 4. Copy the webhook URL (starts with https://hooks.slack.com/services/...)
  5. 5. Paste it in Settings > Integrations and enable notifications

Discord Notifications (Webhook)

Get a Discord embed every time you commit with the same rich information as the Slack integration.

# Setup:

  1. 1. Open your Discord server and go to the target channel
  2. 2. Click the gear icon > Integrations > Webhooks > New Webhook
  3. 3. Name it (e.g. "BuildTrace") and click Copy Webhook URL
  4. 4. Paste it in Settings > Integrations and enable notifications

Slack Slash Commands

Query BuildTrace directly from Slack. Connect your workspace in Settings > Slack Commands and use these commands in any channel:

/buildtrace status

Your latest 5 commits across all projects

/buildtrace streak

Current streak, total commits, lines changed, and activity insights

/buildtrace summary

AI-generated recap of what you worked on in the past week

/buildtrace help

Show all available commands

Slash commands require a one-time OAuth connection from your Settings page. Responses are ephemeral (only visible to you).

Plans & Features

All plans include commit logging. Upgrade for AI summaries and integrations.

FeatureFreeBuilder $9/moPro $19/mo
Projects1UnlimitedUnlimited
Commit history30 daysForeverForever
Commit loggingYesYesYes
AI summariesNoYesYes
Next step suggestionsNoYesYes
Slack/Discord webhooksNoYesYes
Slack slash commandsNoYesYes
Notion exportNoNoYes
Team sharingNoNoUp to 3
Public changelogsNoNoYes

Troubleshooting & FAQ

My commits aren't showing up in the dashboard

Run "npx buildtrace status" in your repo to verify the hook is installed and your API key is valid. Make sure you're committing (not just saving files). The hook runs on git commit, not on file save.

Can I use BuildTrace with Cursor / Lovable / Replit?

Yes. BuildTrace works with any tool that uses git under the hood. If your tool makes git commits, BuildTrace will capture them automatically.

Does the hook slow down my commits?

No. The post-commit hook sends data asynchronously in the background. Your commit completes instantly — the API call happens after.

I switched machines. How do I reconnect?

Run "npx buildtrace init" again in your repo on the new machine. Use the same API key and project name. Your existing history is preserved.

How do I change my API key?

Go to Settings > API Key in the dashboard and click "Regenerate". Then run "npx buildtrace init" again in each repo to update the key.

What happens if I uninstall?

Running "npx buildtrace uninstall" removes the git hook and local config. Your commit history on the dashboard is preserved. You can re-init anytime.

Is my code sent to your servers?

BuildTrace sends the commit diff (not your full codebase) to generate AI summaries. Diffs are processed by Claude AI and are not stored beyond generating the summary. You can use the Free plan (no AI) if you prefer not to send diffs.

Can I delete my commit history?

Yes. You can delete individual commit logs from the dashboard. Deleting a project removes all its associated logs.

Ready to start?

Set up in 30 seconds. Free forever for 1 project.

Get Started Free$ npx buildtrace init