> ## Documentation Index
> Fetch the complete documentation index at: https://docs.helpalive.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Install HelpAlive with an AI coding agent prompt
> Paste one prompt into Claude Code, Codex, Cursor or GitHub Copilot to install HelpAlive, and a second one to verify your users.
The HelpAlive coding agent prompts are two prompts from the dashboard that you paste into an AI coding agent such as Claude Code, Codex, Cursor or GitHub Copilot: one installs HelpAlive, the other verifies your users. This page gives your developer both. Each prompt carries every instruction itself, so the agent needs nothing else.
## Coding agent prompts at a glance
* You copy each prompt from **Settings → Setup & API Key**. The install prompt there already has your project key.
* The install prompt adds the tag, the `identify()` call and the `reset()` call, and adds our hosts to your Content Security Policy if your app has one.
* The verify prompt makes a user token on your server and passes it to `identify()`.
* Neither prompt contains your signing secret. You set `HELPALIVE_SIGNING_SECRET` on your server yourself.
* When the agent is done, it lists the files it changed, so you can review them.
## Prerequisites
* Your app's code open in Claude Code, Codex, Cursor, GitHub Copilot or a similar coding agent.
* Your project key, from **Settings → Setup & API Key**. The setup page puts it into the prompt for you.
* For the second prompt: HelpAlive already installed, and your signing secret created.
## Install HelpAlive
Open **Settings → Setup & API Key**, step **Add HelpAlive to your app**, and choose **With an AI coding agent**. Copy the prompt there: it already has your project key. The prompt below is the same, with `YOUR_PROJECT_KEY` in place of your key.
The agent adds the tag, the `identify()` call and the `reset()` call. It adds our hosts to your Content Security Policy if your app has one, and lists the files it changed.
Check that `reset()` sits in your logout code, apart from `identify()`.
```text Install prompt theme={null}
Add HelpAlive (an in-app AI agent) to this web app. Make only the changes below.
1. Load the HelpAlive script on every page, except pages that show data the app's owner says HelpAlive must not receive (ask them which), and only after cookie consent if this app asks for it. Put this tag in the HTML of the layout or template every page uses (for example index.html, the root layout in Next.js, or the base template in Rails, Django or Laravel):
2. Tell HelpAlive who is signed in. Wherever the app already knows the signed-in user (right after login, and on every page load while they stay signed in), run this, filled in with the app's own user and company objects:
// Lets the calls below run before our script has finished loading. Keep it first.
window.HelpAlive = window.HelpAlive || { q: [] };
["identify", "reset", "setConsent", "track"].forEach((m) => {
if (!HelpAlive[m]) HelpAlive[m] = (...args) => HelpAlive.q.push([m, args]);
});
// On every page while someone is logged in, starting right after login
HelpAlive.identify({
userId: String(user.id), // required: your own id for this person
tenantId: String(company.id), // required: their company or workspace
tenantName: company.name, // required: the company's name, shown in your dashboard
displayName: user.name, // required: the person's name (or their email), shown in your dashboard
email: user.email, // optional
role: user.role, // recommended, helps the agent
plan: company.plan, // recommended, helps the agent
createdAt: user.createdAt, // optional: signup date, Unix time in seconds
})
userId and displayName are required: userId a stable id for the person (not their email if it can change), passed as a string, and displayName their name. If this app is B2B, with customer companies, workspaces or organizations as tenants, tenantId (that id, as a string) and tenantName (its name) are required too; if it is B2C, where people sign up on their own with no company, leave both out (in an app with both, leave them out only for the individuals). role and plan are recommended, because the agent reads both; fill them if the app has them. email and createdAt are optional (createdAt is the signup date in Unix seconds).
If that code is in a TypeScript file, add this declaration to a .d.ts file the project includes:
// In a .d.ts file your project includes, for example helpalive.d.ts
declare var HelpAlive: any
and type the queue line's rest argument:
if (!HelpAlive[m]) HelpAlive[m] = (...args: unknown[]) => HelpAlive.q.push([m, args]);
3. Where the app logs the person out, and wherever it ends a session, run this. Keep it apart from the code in step 2, never right after identify():
// In your logout code, and wherever your app ends a session. Until this runs,
// the browser keeps the person, and the next visitor's events count as theirs.
HelpAlive.reset()
4. If this app sends a Content-Security-Policy, add these sources to it without removing anything. If its script-src uses a nonce, put the page's nonce on the HelpAlive script tag the same way the app's other scripts get theirs:
script-src https://cdn.helpalive.com;
connect-src https://api.helpalive.com https://chat.helpalive.com;
Use the app's existing way of reading the current user. Don't add packages or change anything else. When you're done, list the files you changed, and tell me to sign in to the app and look for the HelpAlive agent.
The full guide, if you need more detail: https://docs.helpalive.com/installation
```
## Verify your users
This prompt makes a user token on your server and passes it to `identify()`. A user token refers to the token your server makes for the signed-in person, which tells HelpAlive who they are. The prompt never contains your signing secret. The agent adds `HELPALIVE_SIGNING_SECRET` to your list of environment variables with no value, and you set the value yourself.
On **Settings → Setup & API Key**, step **Verify your users**, click **Create your signing secret**. Keep it to yourself.
In the same step, choose **With an AI coding agent** and copy the prompt. It is the same as the one below.
When the agent is done, put your secret in `HELPALIVE_SIGNING_SECRET` on your server yourself. Never paste the secret into a prompt.
```text Verify users prompt theme={null}
Add HelpAlive user verification to this app. HelpAlive is already installed: the page calls HelpAlive.identify() for the signed-in person. Make only the changes below.
1. On the server, wherever the app knows the signed-in user, create a "user token": a JWT signed with HS256, keyed on the text of the environment variable HELPALIVE_SIGNING_SECRET, with these claims:
- sub: the same user id the page passes to identify() as userId, as a string
- tenant: the same id the page passes as tenantId, as a string. Leave it out if the page passes no tenantId.
Use the usual JWT library for this language. Don't add exp, kid or any other claim.
2. Get the token to the browser for the signed-in person only. Use whichever fits the app: print it into the page from the server template, or add it to an endpoint the app already has that returns the current user. Send it with Cache-Control: no-store. The secret itself must never reach the browser.
3. Change the identify() call to pass the token. The token says who the person is, so userId and tenantId are no longer passed:
// Lets the calls below run before our script has finished loading. Keep it first.
window.HelpAlive = window.HelpAlive || { q: [] };
["identify", "reset", "setConsent", "track"].forEach((m) => {
if (!HelpAlive[m]) HelpAlive[m] = (...args) => HelpAlive.q.push([m, args]);
});
// In place of your identify() call from step 1.
// The token already says who the person is and which company they belong to.
HelpAlive.identify({
userToken, // the token your server made for this person
tenantName: company.name, // optional: the company's name, shown in your dashboard
displayName: user.name, // optional
email: user.email, // optional
role: user.role, // recommended, helps the agent
plan: company.plan, // recommended, helps the agent
createdAt: user.createdAt, // optional: signup date, Unix time in seconds
})
4. Add HELPALIVE_SIGNING_SECRET to the app's list of environment variables (for example .env.example) with no value. I will set the real value myself.
When you're done, list the files you changed.
The full guide, if you need more detail: https://docs.helpalive.com/sdk/verify-users
```
## Check it works
1. Deploy the change, sign in to your app and open a page.
2. Open your app, sign in and click around, then come back to **Settings → Setup & API Key**. Step **Add HelpAlive to your app** gets a check and says "Recognized a signed-in person 3 minutes ago."
3. After the second prompt, open the agent in your app. Then press refresh on **Check your setup**, in step **Verify your users**.
## What if the agent put reset() next to identify()?
Move `reset()` into your logout code. Run straight after `identify()`, it forgets the user at once, which is why the agent never appears.
## Why does step 1 stay on Waiting for someone to sign in?
**Waiting for someone to sign in** means that `identify()` isn't running. Check that the queue lines come before `identify()`, and that `userId` is not empty. [Install the script](/installation) lists every rule.
## Should I give the coding agent the signing secret?
No, don't give it, because the prompt only needs the variable's name. Set the value on your server yourself.
## Give your coding agent these docs
The prompts above are complete on their own. If your agent should read more, point it at:
| What | Address |
| - | - |
| Any page as Markdown | Add `.md` to the page address, such as `https://docs.helpalive.com/installation.md` |
| Every page in one file | `https://docs.helpalive.com/llms-full.txt` |
| A list of every page | `https://docs.helpalive.com/llms.txt` |
| A skill file for agents that use skills | `https://docs.helpalive.com/skill.md` |
| A search server for agents that use MCP | `https://docs.helpalive.com/mcp` |
The menu at the top of every page can also copy the page as Markdown, open it in ChatGPT, Claude or Perplexity, or add the search server to Cursor or VS Code.
## Next
The same install, by hand, with every rule.
The server code for each language.
The failures that show no error.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.