Documentation

Bienvenue sur la documentation Herald. Cette page sera enrichie au fil du développement.

Démarrage rapide

1. Crée un compte sur Herald
2. Connecte ton repository GitHub
3. Lance ta première analyse
4. Lis le rapport et corrige les issues

API

L'API Herald est exposée sur https://herald-api.itsasync.fr.

Authentification

Authorization: Bearer <token>

Endpoints principaux

• POST /heralds/analyses — lancer une analyse
• GET /heralds/reports — lister mes rapports
• GET /heralds/reports/:id — détail d'un rapport
• GET /heralds/usage — quota restant

Règles

Herald applique des règles regroupées par catégorie :

• Style & lint
• Architecture & couplage
• Dépendances & vulnérabilités
• Sécurité (OWASP, secrets, CORS)
• Performance

Support

Une question ? Contacte-nous à [email protected].