Install Hud with your coding agent

Sign up, copy your keys and the install prompt, and let your coding agent add the Hud SDK to a service and check that data arrives.

The fastest way to install Hud is to let your coding agent do it. When you sign up, Hud opens an install page with your API keys and a prompt. You paste the prompt into your coding agent, in the repository of the service you want to cover. The agent adds the Hud SDK, runs the service and checks that data reaches Hud.

You can also install by hand. See Quick start.

Before you start

  • A service written in Node.js, Python or Java that you can run on your machine. Where Hud runs lists the supported versions and frameworks.
  • A coding agent that can read your repository and run commands, such as Claude Code, Cursor or Codex.
  • An email address. Signing up with an email on your company's domain puts you in your company's account.

Install in five steps

  1. Sign up. Go to app.hud.io and sign in with your email. The first screen asks for an account name, which is the only required field, then your role and what you want to do with Hud. The last two are optional.

  2. Choose Hud managed. The install page has two tabs. Hud managed is the standard setup: Hud stores and analyzes your data. If your data has to stay in your own OpenSearch stack, choose Self-hosted instead and follow Hud self-hosted.

  3. Get your keys. The page shows three API keys: local, staging and production. Each one sends data to its own environment. Use Copy for one key, or Download for a text file with all three. For your first install, use the local key. Set it in the terminal where you start your agent:

    export HUD_KEY=<your local key>

    The prompt has no secrets in it. It reads HUD_KEY from the environment.

  4. Paste the prompt into your agent. Copy the prompt from the install page and paste it into your coding agent, in the repository of the service. If the repository holds more than one service, the agent asks which to install first. It adds the SDK, runs the service and calls a few endpoints to check that data arrives. If it can't get data in, it asks you to call the endpoints yourself.

  5. Watch the progress page. The install page moves to a progress page that follows the SDK as it reports in:

    • Recognized your service: the SDK started and contacted Hud.
    • Mapping your code: Hud received your service's functions.
    • Receiving data: metrics are arriving.
    • Preparing your app: Hud is getting the web app ready, so you don't land on empty pages.

    If a step takes too long, it shows a message with what to try. With several services, each step moves forward as soon as any one service reaches it.

When the install is complete, Hud opens your service page. To see what Hud would have told you about your own pull requests, choose Continue in your agent under See which of your PRs could auto-merge. Your agent then writes a report from your recent pull requests. To skip it, choose Skip to production.

Go to production

Data from the local key lands in your local environment. Until production data arrives, a Go to production banner shows at the top of the web app. To send production data, install the SDK in your deployed service with your production key. Quick start and the install guide for your language show how.

The free plan

Your account starts on the free plan. It covers up to 10 services or pods running at once and 10 seats, and it has no other limits. The bar at the top of the web app shows that you're on the free plan and how many services are running. Upgrade opens a chat with our support team.

When your account is at the limit, Hud doesn't track any more sessions or pods.

A seat is one email address with access to the Hud web app. When your account has 10 seats, no more emails can be added to it.

If something doesn't work

  • The progress page stays on the first step. The SDK hasn't started or can't reach Hud. Check that HUD_KEY is set in the terminal where the service runs, and that the service is running.
  • It stops at Receiving data. Hud knows your service but has no metrics yet. Call a few of its endpoints.
  • Anything else. Chat with our support team or email [email protected].

Did this page help you?