Install from an AI agent

Pulse is designed to be installed by your AI coding agent. Point it at the docs and give it your key — it installs @pulse-circle/web and wires up init / track.

The one prompt

Paste this to Claude Code, Cursor, or any coding agent:

Install Pulse analytics in this project.
Read the docs first: https://raw.githubusercontent.com/Pulse-Circle-Studio/pulse-sdk/main/llms.txt
Use the @pulse-circle/web package with API key YOUR_PULSE_API_KEY.
Initialize Pulse with the key and send a "signup_completed" test event.

Get an API key by creating an app at app.pulse.pulsecircle.studio. The key is a publishable client key — it’s meant to live in your app’s bundle, like a Google Analytics id.

What the agent actually needs

The install is deliberately self-contained. The published package bundles everything (zero runtime dependencies), the default endpoint is baked in, and the docs are reachable through channels that agent sandboxes normally allow:

• npm — npm i @pulse-circle/web. The package README carries the full quickstart, so an agent with only npm access already knows how to use it.
• GitHub (raw) — the machine-readable guide lives at raw.githubusercontent.com/Pulse-Circle-Studio/pulse-sdk/main/llms.txt, reachable even where the main site isn’t.
• In-package guide — after install, the same llms.txt ships inside the package, so it’s readable from node_modules/@pulse-circle/web/ with no network at all.

Cloud sandboxes & network policy

Some agents run in a restricted cloud sandbox (for example Claude Code on the web), where outbound traffic follows a network allow-list. In that case requests to pulse.pulsecircle.studio or the MCP server may be blocked (HTTP 403) — but this only affects the agent’s environment, not your users:

• Installing still works. Package registries are allowed by default, so npm i @pulse-circle/web succeeds and the README/in-package guide tell the agent how to use it.
• Your users are unaffected. Events are sent from your end-users’ browsers at runtime, not from the agent’s sandbox, so delivery to the ingestion API never depends on the sandbox’s policy.
• Want live docs or the MCP server from a sandboxed agent? Add pulse.pulsecircle.studio and mcp.pulse.pulsecircle.studio to your environment’s allow-list. It’s optional — installation doesn’t require it.

Install it yourself

If you’d rather not use an agent, it’s two lines:

npm i @pulse-circle/web

import { Pulse } from '@pulse-circle/web';

Pulse.init('YOUR_PULSE_API_KEY');
Pulse.track('signup_completed', { plan: 'pro' });
Pulse.identify('user_42'); // after login

See the Quickstart for the script-tag build and the raw ingestion API, and MCP server for the agent tool that generates platform-specific snippets.