> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbitflare.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Skills

> Drop-in skill packages that teach Claude Code, Cursor, and Codex how to build on OrbitFlare correctly.

OrbitFlare ships agent skills (instruction sets the model loads at the start of a session) so coding agents write OrbitFlare code correctly without you fetching docs first. The main skill covers HTTP RPC, WebSockets, Jetstream, Yellowstone gRPC, raw Shredstream, Dedicated Nodes (Solana + BNB Chain), `getTransactionsForAddress`, historical archive data, Metis Swap, Jito Bundle Simulation, the Customer API, the OrbitFlare CLI, and the `orbitflare-sdk-rs` Rust SDK.

<Tip>
  Skills are read-only context; they don't make API calls. Pair a skill with the [MCP server](/agents/mcp) when you want the agent to actually query OrbitFlare from chat.
</Tip>

## Install

One line, no clone required. Pick the host:

<Tabs>
  <Tab title="Claude Code (personal)">
    ```bash theme={null}
    npx @orbitflare/skills@latest
    ```

    Installs to `~/.claude/skills/orbitflare`. Available in every Claude Code session.
  </Tab>

  <Tab title="Claude Code (project)">
    ```bash theme={null}
    npx @orbitflare/skills@latest --project
    ```

    Installs to `./.claude/skills/orbitflare`. Only loaded when Claude Code runs in this directory, so commit it and your team picks it up automatically.
  </Tab>

  <Tab title="Cursor">
    ```bash theme={null}
    npx @orbitflare/skills@latest --cursor
    ```

    Installs to `~/.cursor/skills-cursor/orbitflare`.
  </Tab>

  <Tab title="Codex CLI">
    ```bash theme={null}
    npx @orbitflare/skills@latest --codex
    ```

    Installs to `~/.codex/skills/orbitflare`.
  </Tab>

  <Tab title="Custom path">
    ```bash theme={null}
    npx @orbitflare/skills@latest --path /your/custom/dir
    ```

    Installs to `/your/custom/dir/orbitflare`.
  </Tab>
</Tabs>

After install, **restart your agent** so it picks up the new skill.

<Tip>
  Updates are one command: `npx @orbitflare/skills@latest` again. The installer overwrites the skill files in place.
</Tip>

### From source

If you want to clone the repo (e.g. to modify the skill), the underlying installer is also exposed as a shell script:

```bash theme={null}
git clone https://github.com/orbitflare/orbitflare-skills
cd orbitflare-skills/orbitflare
./install.sh                 # same flags: --project, --cursor, --codex, --path
```

## What's in the skill

`SKILL.md` is the entry point. The model loads it at the start of every session and uses it to route to the right reference file. References cover:

| Reference            | Topic                                                 |
| -------------------- | ----------------------------------------------------- |
| `rpc.md`             | HTTP JSON-RPC: endpoint URLs, headers, common methods |
| `websockets.md`      | WebSocket subscriptions, reconnection patterns        |
| `jetstream.md`       | OrbitFlare's Shredstream-decoded gRPC stream          |
| `yellowstone.md`     | Yellowstone Geyser gRPC: accounts, txs, slots, blocks |
| `shredstream.md`     | Raw UDP Shredstream feed                              |
| `fetching-data.md`   | `getTransactionsForAddress`, historical archive       |
| `dedicated-nodes.md` | Solana + BNB Chain dedicated infrastructure           |
| `trading-apis.md`    | Metis Swap, Jito Bundle Simulation                    |
| `customer-api.md`    | Customer API v2: licenses, billing, top-up            |
| `cli-sdk.md`         | OrbitFlare CLI command surface + Rust SDK setup       |
| `onboarding.md`      | Auth keys, dashboard signup, first call               |
| `repos.md`           | Pointers to template repos and example projects       |

The skill instructs the agent to read the relevant reference **before** writing code, so you get correct endpoint URLs, gRPC filter shapes, and SDK feature flags on the first try.

## Try it

After installing the skill and restarting your agent:

> "Stream pump.fun trades using OrbitFlare Jetstream from Frankfurt"

> "Quote 1 SOL → USDC with Metis on OrbitFlare and write a Rust binary that polls every 30 seconds"

> "Build a Yellowstone gRPC subscription that streams Jupiter swap transactions, with retry on disconnect"

The agent will pull the relevant reference (`jetstream.md`, `trading-apis.md`, `yellowstone.md`) and produce code that uses the right endpoint URL, headers, and SDK patterns.

## Source

* Skills repo: [github.com/orbitflare/orbitflare-skills](https://github.com/orbitflare/orbitflare-skills)
* npm: [`@orbitflare/skills`](https://www.npmjs.com/package/@orbitflare/skills)
* Source of truth: [docs.orbitflare.com/llms.txt](https://docs.orbitflare.com/llms.txt)

Everything in the skill is derived from this documentation site. When in doubt, point the agent at the `llms.txt` index.