Skip to content
Cirrus home
Sign in

Guide

Build with AI

Rules files for coding agents (Claude Code, Codex, Cursor, Copilot and more).

Coding agents write better integrations when they read the reference instead of guessing. Give yours the machine-readable docs and a rules file for your tool.

  1. Give the agent the reference: llms-full.txt for reading, openapi.json for exact schemas. Every docs section is also served as Markdown at /docs/<section>.md.
  2. Add the rules file for your tool (below) to your repository. Every file carries the same rules; only the file name and header differ.
  3. Keep your API key in an environment variable, and make the agent ask you before it places, modifies or cancels a live order.

Docs for your agent #

  • llms.txt: Index of the docs as Markdown pages, in the llmstxt.org format.
  • llms-full.txt: The whole reference in one Markdown file.
  • openapi.json: OpenAPI 3.1 spec: every endpoint, schema, enum value, stream message and webhook body. Live from the API: https://cirrus.pocketful.in/v1/openapi.json.

Rules files #

Add the file for your tool to your repository, or download them all.

ToolPath in your repositoryDownload
Claude CodeCLAUDE.mdCLAUDE.md
Claude Code.claude/skills/cirrus-api/SKILL.mdSKILL.md
Codex / AGENTS.mdAGENTS.mdAGENTS.md
Cursor.cursor/rules/cirrus-api.mdccirrus-api.mdc
GitHub Copilot.github/copilot-instructions.mdcopilot-instructions.md
Windsurf.windsurf/rules/cirrus-api.mdcirrus-api.md
Gemini CLIGEMINI.mdGEMINI.md
Cline / Roo.clinerules/cirrus-api.mdcirrus-api.md
AiderCONVENTIONS.mdCONVENTIONS.md
Aider.aider.conf.yml.aider.conf.yml
Continue.continue/rules/cirrus-api.mdcirrus-api.md
Kiro.kiro/steering/cirrus-api.mdcirrus-api.md