# Using OpenReceive with coding agents

OpenReceive publishes machine-readable specifications and installable agent
skills, so a coding agent can add Bitcoin Lightning checkout to your
application — or debug one — without guessing.

## Building an integration?

Install the **integrate-openreceive** skill (it detects your stack and carries
the full quickstart), or paste the one-prompt agent directions.

**Claude Code:** run these two commands in Claude Code, one at a time.

```text
/plugin marketplace add OpenReceive/openreceive
```

```text
/plugin install openreceive
```

**Skills CLI** (Codex, Cursor, GitHub Copilot, and other SKILL.md-compatible
tools): run this from your application's directory.

```sh
npx skills add OpenReceive/openreceive
```

Run it in **your application**, or use the package command below: agents such
as GitHub Copilot look for skills in the application's own `.agents/skills/`.
The OpenReceive repository's own `.agents/skills/` is only discovered when that
repository is the workspace.

**No installer?** Copy the agent directions for your stack and paste them into
your agent: [Node (Express)](https://openreceive.org/agent-directions/node/full.md) ·
[Fastify](https://openreceive.org/agent-directions/fastify/full.md) ·
[Next.js](https://openreceive.org/agent-directions/next/full.md) ·
[NestJS](https://openreceive.org/agent-directions/nestjs/full.md) ·
[Rails](https://openreceive.org/agent-directions/rails/full.md) ·
[PHP](https://openreceive.org/agent-directions/php/full.md) ·
[Laravel](https://openreceive.org/agent-directions/laravel/full.md) ·
[Django](https://openreceive.org/agent-directions/django/full.md) ·
[FastAPI](https://openreceive.org/agent-directions/fastapi/full.md) ·
[Flask](https://openreceive.org/agent-directions/flask/full.md) ·
[WordPress + WooCommerce](https://openreceive.org/agent-directions/woocommerce/full.md) ·
[Easy Digital Downloads](https://openreceive.org/agent-directions/edd/full.md) ·
[Paymenter](https://openreceive.org/agent-directions/paymenter/full.md) ·
[FOSSBilling](https://openreceive.org/agent-directions/fossbilling/full.md) ·
[PrestaShop](https://openreceive.org/agent-directions/prestashop/full.md) ·
[Odoo](https://openreceive.org/agent-directions/odoo/full.md) ·
[Medusa](https://openreceive.org/agent-directions/medusa/full.md) ·
[Vendure](https://openreceive.org/agent-directions/vendure/full.md) ·
[Lovable](https://openreceive.org/agent-directions/lovable/full.md) ·
[Bolt](https://openreceive.org/agent-directions/bolt/full.md) ·
[SvelteKit](https://openreceive.org/agent-directions/sveltekit/full.md) ·
[Nuxt](https://openreceive.org/agent-directions/nuxt/full.md) ·
[Astro](https://openreceive.org/agent-directions/astro/full.md) ·
[React Router](https://openreceive.org/agent-directions/react-router/full.md) ·
[TanStack Start](https://openreceive.org/agent-directions/tanstack-start/full.md) ·
[BTCPay Server](https://openreceive.org/agent-directions/btcpay/full.md). Each
is self-contained, quickstart included. For a mobile app, use the
[mobile directions](https://openreceive.org/agent-directions/mobile/full.md):
they find the app's server, add OpenReceive there with that stack's
directions, and make the app open the checkout page. To hand an agent a link instead, drop
`/full` from the URL: that short page tells it to download the full file with
its shell.

One package per ecosystem bundles an offline copy: `@openreceive/node`, the
core `openreceive` gem, Python's `openreceive`, and Composer's
`openreceive/openreceive`. From your application's directory, install that copy
where your agent can discover it:

| Stack | Install bundled skills |
| --- | --- |
| Node | `npx openreceive skills install` |
| Python (Django, FastAPI or Flask) | `openreceive skills install` |
| Rails | `bin/rails openreceive:skills` |
| Laravel | `php artisan openreceive:skills` |

These commands write both skills to `.agents/skills/`; add
`--dir .claude/skills` for Claude Code. Re-running replaces only the two
OpenReceive skill folders, removing obsolete files and leaving other skills
alone. Plain PHP, non-Rails Ruby, and WordPress projects can use
`npx skills add OpenReceive/openreceive`. Installing a library alone does not
make its bundled skills discoverable.

A **debug-openreceive-payment** skill ships alongside: boot failures,
403/404/409 semantics, settlement timing, swap refunds, each with its fix.

## Working on OpenReceive itself?

Read
[AGENTS.md](https://github.com/OpenReceive/openreceive/blob/master/AGENTS.md)
in the repository — the architectural invariants a change must not violate.

## Generating an HTTP client, or verifying routes?

Use the normative OpenAPI contract:
[https://openreceive.org/openapi.yaml](https://openreceive.org/openapi.yaml).
It is the exact `spec/openapi/openreceive-http.v1.yaml` file from the
repository — the same contract the shipped adapters and the Rails engine are
tested against.

## Giving an agent documentation context?

Start from [https://openreceive.org/llms.txt](https://openreceive.org/llms.txt)
— every guide as raw markdown, one fetch away. Any guide page is also
available as markdown by appending `.md` to its URL.

Questions, or a problem with the library itself:
[https://openreceive.org/contact](https://openreceive.org/contact)