> For the complete documentation index, see [llms.txt](https://docs.bunny.com/guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bunny.com/guide/tour/bunny-ai/skills-bunny-ai-toolkit.md).

# Skills (Bunny AI Toolkit)

The Bunny AI Toolkit connects your AI coding assistant — Claude Code, Cursor, Gemini CLI, OpenAI Codex, VS Code, and other compatible tools — directly to Bunny. It bundles a set of **Agent Skills**: focused, task-specific guides that teach your assistant how to work with Bunny's GraphQL API, official SDKs, React components, webhooks, customer portal, and the full subscription, quote, and invoice lifecycle.

In practice, that means when you ask your assistant to "track signup subscriptions," "accept a payment," or "drop the customer portal into this page," it already knows the correct endpoints, auth patterns, components, and lifecycle steps — instead of guessing or relying on potentially outdated training data.

The toolkit is open source and maintained by the Bunny team: [github.com/bunnyapp/skills](https://github.com/bunnyapp/skills). For broader API reference, see [docs.bunny.com/developer](https://docs.bunny.com/developer).

### What are skills?

[Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills) are packaged instructions that an AI coding assistant loads on demand. Each skill covers one area of Bunny — the GraphQL API, the React component library, webhooks, and so on — and gives the assistant the right patterns, examples, and guardrails for that area. Your assistant pulls in the relevant skill automatically based on what you're working on, so guidance stays accurate and you don't have to paste in documentation by hand.

### Installing

Install the whole toolkit as a plugin, or pull in individual skills à la carte.

#### Claude Code

Run these two commands in a chat:

```
/plugin marketplace add bunnyapp/skills
/plugin install bunny-plugin@bunny-ai-toolkit
```

#### Cursor

Install from the Cursor Marketplace.

#### Gemini CLI

Run this in your terminal:

```
gemini extensions install https://github.com/bunnyapp/skills
```

#### OpenAI Codex

In the Codex CLI, run `/plugins`, search for **Bunny**, and select **Add to Codex**.

#### VS Code

Open the Command Palette (`CMD+SHIFT+P`), run **Chat: Install Plugin From Source**, then paste:

```
https://github.com/bunnyapp/skills
```

#### Any agentskills.io-compatible tool

Install individual skills by name:

```
npx skills add bunnyapp/skills --skill <skill-name>
```

### What you get

Once installed, your assistant gains:

* **Docs- and schema-aware help** — search Bunny's developer documentation and GraphQL schema from inside your editor.
* **SDK-guided integration** — correct setup and usage patterns for the Node (`@bunnyapp/api-client`) and Ruby (`bunny_app`) SDKs.
* **React components** — guided integration of `@bunnyapp/components` (BillingDetails, Invoice, Signup, Subscriptions, Quote, Quotes, Transactions).
* **Webhook handlers** — correct patterns for platform and workflow webhooks.
* **Lifecycle flows** — quote → apply → subscription; renewals, upgrades, and cancellation; invoices, payments, and credit notes.

### Common integration goals

If you're integrating Bunny, here's where to start depending on what you're building.

#### Track signups and subscriptions

To capture new signups and manage the subscriptions they create, the **`bunny-subscriptions`** skill covers the subscription lifecycle — renewals, upgrades, cancellation, and usage — while **`bunny-quoting`** covers the quote-to-subscription flow (create → share → accept → apply) that underpins how subscriptions are created. If you'd rather embed a ready-made signup experience, the **`bunny-components`** Signup component and the **`bunny-customer-portal`** signup variant handle this for you.

#### Accept payments

The **`bunny-billing`** skill covers invoices, payments, credit notes, and reconciliation — the core of taking money and keeping your records straight. Pair it with **`bunny-webhooks`** so your application reacts correctly to payment and billing events as they happen.

#### Implement the customer portal

The **`bunny-customer-portal`** skill covers the portal's popup, standalone, and signup variants, guiding your assistant on which to use and how to wire it up so customers can manage their own billing, subscriptions, and invoices.

#### Use the React components

The **`bunny-components`** skill guides integration of the `@bunnyapp/components` library, including BillingDetails, Invoice, Signup, Subscriptions, Quote, Quotes, and Transactions — pre-built React building blocks for billing UIs.

### All available skills

| Skill                   | Covers                                                            |
| ----------------------- | ----------------------------------------------------------------- |
| `bunny-graphql`         | Direct GraphQL API: endpoint, auth, pagination, common operations |
| `bunny-node-sdk`        | `@bunnyapp/api-client` (Node / TypeScript)                        |
| `bunny-ruby-sdk`        | `bunny_app` gem (Ruby / Rails)                                    |
| `bunny-components`      | `@bunnyapp/components` React library                              |
| `bunny-webhooks`        | Platform and workflow webhook handling                            |
| `bunny-customer-portal` | Popup, standalone, and signup portal variants                     |
| `bunny-catalog`         | Products, plans, features, price lists, coupons                   |
| `bunny-quoting`         | Quote lifecycle (create → share → accept → apply)                 |
| `bunny-subscriptions`   | Subscription lifecycle: renewals, upgrades, cancellation, usage   |
| `bunny-billing`         | Invoices, payments, credit notes, reconciliation                  |
| `bunny-analytics`       | MRR / ARR / churn, RevRec schedules, reporting exports            |

### Credential safety

Every code sample in the toolkit reads tokens from environment variables. When integrating Bunny:

* **Never** hardcode, log, or commit access tokens.
* Rotate tokens regularly.
* Scope each token to the minimum set of permissions you need.

### Feedback and contributing

The toolkit is maintained by the Bunny team. To report a problem or request a skill, open an issue in the [skills repository](https://github.com/bunnyapp/skills). The repo's [CONTRIBUTING.md](https://github.com/bunnyapp/skills/blob/main/CONTRIBUTING.md) documents the authoring rubric and skill structure; external pull requests are considered case by case, so please open an issue to discuss first.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.bunny.com/guide/tour/bunny-ai/skills-bunny-ai-toolkit.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
