> ## Documentation Index
> Fetch the complete documentation index at: https://orwel-22af1265.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# AI Skill

> An agent skill that installs and wires the Orwel SDK into any project, correctly, the first time.

Orwel ships an **agent skill** — a set of instructions your AI assistant (Claude Code) loads to install and wire the SDK correctly into any project: env-based key, a wrapper module, init once, and the full API.

## Install

Add the skill once; your assistant picks it up automatically.

```bash theme={null}
npx skills add hyperlabs-ai/hyper-skills/orwel
```

<Note>
  The skill is open source in [hyperlabs-ai/hyper-skills](https://github.com/hyperlabs-ai/hyper-skills/blob/main/orwel/SKILL.md). Once installed it lives in your skills directory and triggers automatically on Orwel-related requests.
</Note>

## Use it

Just ask. The skill handles the whole install — package, env var, wrapper, and the init call:

```text Prompt theme={null}
"Add Orwel tracking to this project. Key: orwel_pk_xxxxxxxxxxxxxxxx"
```

## What it guarantees

<Steps>
  <Step title="Detects your framework">
    Identifies the stack and installs the `orwel` package.
  </Step>

  <Step title="Creates a wrapper module">
    A small module that reads the key from the environment and re-exports the SDK.
  </Step>

  <Step title="Initializes once">
    Client-side, before any tracking call — never twice.
  </Step>

  <Step title="Knows the full API">
    Methods and validation rules, so calls are correct from the start.
  </Step>
</Steps>

## Rule 0 — key in env, never hardcoded

The skill always reads the key from an environment variable (it never pastes a literal key into code), using the right name per framework:

| Framework                   | Env variable            |
| --------------------------- | ----------------------- |
| Vite (React / Vue / Svelte) | `VITE_ORWEL_KEY`        |
| Next.js                     | `NEXT_PUBLIC_ORWEL_KEY` |
| SvelteKit / Astro           | `PUBLIC_ORWEL_KEY`      |
| Nuxt 3                      | `NUXT_PUBLIC_ORWEL_KEY` |
| Create React App            | `REACT_APP_ORWEL_KEY`   |

<Warning>
  The SDK key is an ingest-only public key (it can write events, not read data), so it's safe in the browser bundle. Still, read it from an environment variable so you can rotate it per environment without changing code.
</Warning>