wehub-resource-sync
69 lines
2.3 KiB
Markdown
69 lines
2.3 KiB
Markdown
# CopilotKit Intelligence Telemetry Setup
|
|
|
|
## What is CopilotKit Intelligence?
|
|
|
|
CopilotKit Intelligence is CopilotKit's hosted platform that provides:
|
|
|
|
- **Usage analytics** -- see how users interact with your AI features (message volume, tool usage, session duration)
|
|
- **Error monitoring** -- surface runtime errors and failed agent interactions
|
|
- **Premium features** -- access to hosted runtimes, advanced agent orchestration, and priority support (requires a paid plan)
|
|
|
|
The license key is a lightweight identifier that connects your local CopilotKit instance to CopilotKit Intelligence. It does not gate any open-source functionality -- CopilotKit works fully without it.
|
|
|
|
## The `npx copilotkit auth` flow
|
|
|
|
Running the CLI command starts an interactive authentication (verify the exact command with `npx copilotkit --help` as it may vary by version):
|
|
|
|
```bash
|
|
npx copilotkit auth
|
|
```
|
|
|
|
1. The CLI opens your default browser to the CopilotKit Intelligence login/signup page.
|
|
2. Sign in with GitHub, Google, or email.
|
|
3. Select or create a project in the CopilotKit Intelligence dashboard.
|
|
4. The CLI receives the license key and prints it to stdout:
|
|
```
|
|
Successfully authenticated!
|
|
Your license key: <your-license-key>
|
|
```
|
|
|
|
If the browser does not open automatically, the CLI prints a URL you can copy-paste manually.
|
|
|
|
## Where to put the license key
|
|
|
|
Store the key in an environment variable. Add it to your environment file:
|
|
|
|
**Next.js** (`.env.local`):
|
|
|
|
```
|
|
NEXT_PUBLIC_COPILOTKIT_LICENSE_KEY=<your-license-key>
|
|
```
|
|
|
|
**Vite** (`.env`):
|
|
|
|
```
|
|
VITE_COPILOTKIT_LICENSE_KEY=<your-license-key>
|
|
```
|
|
|
|
Then reference it in the provider:
|
|
|
|
```tsx
|
|
// Next.js
|
|
<CopilotKit
|
|
runtimeUrl="/api/copilotkit"
|
|
publicLicenseKey={process.env.NEXT_PUBLIC_COPILOTKIT_LICENSE_KEY}
|
|
>
|
|
|
|
// Vite
|
|
<CopilotKit
|
|
runtimeUrl="/api/copilotkit"
|
|
publicLicenseKey={import.meta.env.VITE_COPILOTKIT_LICENSE_KEY}
|
|
>
|
|
```
|
|
|
|
The `NEXT_PUBLIC_` or `VITE_` prefix is required because the license key is used on the client side. It is safe to expose -- the key is a project identifier, not a secret.
|
|
|
|
## Opting out
|
|
|
|
To disconnect from CopilotKit Intelligence, simply remove the `publicLicenseKey` prop from the `CopilotKit` provider (and delete the environment variable if you set one). No other changes are needed -- CopilotKit will continue to function normally without it.
|