Forge — Référence API et CLI

Accueil Retour

Cette section décrit l'API publique actuelle de Forge 1.0.0b8. Elle est organisée par thème pour faciliter la navigation.

Pour les flux guidés, voir aussi le guide de démarrage, le CRUD explicite et l'architecture des entités. Pour les décisions d'architecture, voir ADR-001, ADR-002 et les ADR suivants. Pour ce qui est garanti stable, voir le contrat de stabilité.

Schéma complet

Voir le schéma complet

flowchart LR
    CLI["CLI forge"] --> Project["Projet Forge"]
    CLI --> EntityGen["Génération entités"]
    CLI --> CrudGen["Génération CRUD"]
    CLI --> DbTools["db:init / db:apply"]
    CLI --> Starters["starter:list / starter:build"]

    Project --> CoreConfig["core.forge"]
    Project --> Router["core.http.router"]
    Project --> App["core.application"]
    Project --> Templates["core.templating + integrations.jinja2"]
    Project --> Controllers["core.mvc.controller"]
    Project --> Forms["core.forms"]
    Project --> Security["core.security"]
    Project --> Database["core.database"]
    Project --> Uploads["core.uploads"]
    Project --> Entities["mvc/entities"]

    App --> Router
    App --> Security
    Router --> Request["core.http.request"]
    Router --> Response["core.http.response"]
    Controllers --> Response
    Controllers --> Templates
    Controllers --> Forms
    Controllers --> Security
    Controllers --> Database
    Forms --> Validation["core.validation"]
    EntityGen --> Entities
    Entities --> GeneratedSql["*.sql / relations.sql"]
    Entities --> GeneratedBase["*_base.py"]
    Entities --> ManualClass["classe métier manuelle"]
    Database --> MariaDB["MariaDB"]
    DbTools --> MariaDB
    Uploads --> Storage["storage/uploads"]

---

Index thématique

API et CLI

• API Forge complète — fonctions, classes, contrats, helpers
• CRUD enrichi et relations — relations avancées entre entités
• Pages publiques — génération de pages génériques

Modules officiels

• Workflow — statuts et transitions (forge-mvc-workflow)
• Statistiques — tracking d'événements (forge-mvc-stats)
• Modules Forge — système de modules, cycle de vie, routes
• Auth — Challenge MFA — flux MFA à la connexion (forge-mvc-mfa)

Sécurité et sessions

• Audit Auth — journalisation, cookies, headers, uploads
• Sessions — concurrence et garanties

Outils et infrastructure

• Profils de projet — environnements et endpoint de santé
• Tests E2E — HTTP, MariaDB, CSRF

---

Modules officiels

Les modules suivants sont distribués séparément du core :

Module	Paquet PyPI	README
MFA	forge-mvc-mfa	packages/forge-mvc-mfa/README.md
RBAC	forge-mvc-rbac	packages/forge-mvc-rbac/README.md
Workflow	forge-mvc-workflow	packages/forge-mvc-workflow/README.md
Statistiques	forge-mvc-stats	packages/forge-mvc-stats/README.md

Les pages de référence ci-dessus documentent l'API publique de ces modules pour mémoire. Pour l'installation, l'usage applicatif et les exemples, voir le README de chaque module.

---

Note : cette page est un index. Le contenu détaillé vit dans docs/reference/. Si un lien est cassé ou un sujet manque, voir le CHANGELOG et la roadmap.