---
title: Editor Rules for AI Assistants
description: Project rules for AI coding assistants like Cursor, Windsurf, Claude Code, and AGENTS.md, tuned for Capacitor and Capawesome.
---

# Editor Rules

Editor rules are project files that AI coding assistants read on every interaction — standing conventions that keep generated code consistent. Unlike [skills](skills/index.md) (which an agent runs on demand), rules are always-on context.

Most assistants support a project rules file:

- **AGENTS.md** — a cross-tool convention read by many agents.
- **Cursor** — `.cursor/rules/*.mdc`.
- **Windsurf** — `.windsurfrules`.
- **Claude Code** — `CLAUDE.md`.

## Starter rules

Add a file like the following (e.g. `AGENTS.md`) to your project root and adapt it:

```markdown
# Project rules

- This is a Capacitor app. Prefer Capacitor APIs and Capawesome plugins.
- Use the Capawesome CLI (`@capawesome/cli`) for Capawesome Cloud tasks.
- For OTA updates, use `@capawesome/capacitor-live-update` and publish via
  `apps:liveupdates:upload`. Keep web bundles binary-compatible with the
  installed native version.
- Never commit secrets, signing keys, or API tokens.
```

## Skills vs. rules

- **Rules** are standing conventions the agent always reads.
- **[Skills](skills/index.md)** are on-demand procedures the agent runs for a specific task.

Use both: rules to set the baseline, skills to execute complex tasks like migrations or Cloud setup.