Getting Started

Connect your CLI, install the GitHub App, and start seeing metrics in under five minutes.

1

Sign in to the dashboard

Sign in with GitHub to create your account. AX requests read-only access to your profile and email — no repository access is granted through OAuth.

2

Copy your API key

After signing in, you'll be guided through onboarding where your API key is displayed. Copy it — it's only shown once. You can rotate it later from Account Settings.

3

Install and connect the CLI

Install AX via Homebrew:

brew install acroos/tap/ax

Then connect it to your account:

ax init --api-key YOUR_API_KEY

This validates your key, writes a config file to ~/.ax/config.json, and installs a Claude Code SessionEnd hook that automatically pushes session data when you finish working.

4

Push your first data

Push session data from any git repository:

ax push --repo .

Or push data for all discovered repos at once:

ax push --all
5

Install the GitHub App

Navigate to Org Settings in the dashboard and click Install GitHub App. This grants AX access to webhook events (PRs opened, merged, closed) and triggers a 90-day historical backfill of your existing PRs.

This is a one-time step per GitHub organization. Only an org admin needs to do it.

6

View your metrics

Once data flows in, your dashboard populates automatically. Explore:

  • Overview — Aggregate metrics at a glance
  • Pull Requests — Per-PR metric breakdown
  • Metric Drill-Down — Trends and distributions for each metric
7

Invite your teamOptional

From Org Settings, generate invite links for your team. Each link is single-use. Invited members sign in with GitHub and are automatically added to your organization.

The free plan supports 1 member. Upgrade to Pro for unlimited team members.

Troubleshooting

CLI says 401 Unauthorized

Your API key may have been rotated. Generate a new one from Account Settings and run ax init again.

PRs aren't showing up

Make sure the GitHub App is installed on the correct org and the repo is connected. PRs must be in a terminal state (merged or closed) for metrics to compute.

Session data not appearing after push

Confirm your CLI is configured with ax init. Session data is matched to PRs by branch name — make sure you're working on a branch that has (or will have) an associated PR.

GitHub App installation failed

You need admin permissions on the GitHub organization. Ask an org admin to complete the installation from the Org Settings page.