Skip to content
Apothem
Utilisation

Écrire des règles

Rédigez, délimitez la portée et maintenez les règles de comportement d'Apothem.

Les règles sont des fichiers Markdown dans src/apothem/rules/ avec l'extension .md.

Frontmatter de règle

---
name: "..."
description: "..."
pathFilter: ""            # empty string for always-on; a glob for path-filtered
alwaysApply: true         # true for always-on; false for path-filtered
---

Portées de règle

PortéeQuand elle s'applique
always-onChaque session, chaque fichier
path-filteredUniquement quand le fichier actif correspond à path-filter
operator-selectedL'opérateur l'active explicitement dans settings.json

Règle d'exemple

---
name: "python-conventions"
description: "Python style conventions for this project"
pathFilter: "**/*.py"
alwaysApply: false
---

# Python conventions

- Use type annotations on all public functions.
- Maximum line length: 88 characters.
- Prefer explicit over implicit.

Appliquer les règles aux harnesses

Après avoir écrit une règle, mettez à jour chaque adaptateur de harness installé. Exécutez apothem harnesses list pour voir l'ensemble installé, puis appelez update une fois par harness :

apothem update --harness claude-code
apothem update --harness cursor

Validation des règles

python -m apothem.conformity.gate --check frontmatter

On this page