Instantané de la documentation · CLI 7.30.1 · SDK 2.6.53. Desktop utilise le runtime fourni avec sa propre version. Les commandes et exemples restent identiques à la source anglaise. Source anglaise

Créer et utiliser votre premier AX Wiki

Avant de commencer

AX Wiki transforme des sources sélectionnées du dépôt en pages d’architecture et de processus. Ces connaissances du dépôt sont distinctes de la documentation du site AX Code. Connectez un fournisseur et choisissez un modèle utilisable. La génération lui transmet les éléments sélectionnés et peut être facturée.

Exécutez depuis le dossier du projet. Les projets Git utilisent la racine du worktree le plus proche, même depuis un sous-dossier. Vérifiez le checkout et décidez si les fichiers générés doivent être versionnés.

Prévisualiser et générer

Le plan présente les fichiers et pages retenus sans appeler de modèle. Examinez-le avant de générer :

ax-code wiki plan

Générez ensuite avec le modèle configuré, validez le résultat et ouvrez le lecteur local :

ax-code wiki generate
ax-code wiki doctor
ax-code wiki viz --open

La sortie par défaut est .ax-wiki/, avec .ax-wiki/quickstart.md comme point d’entrée ; .ax-wiki/.manifest.json enregistre les sources et empreintes. La génération peut actualiser le bloc de liens Wiki dans AGENTS.md ; utilisez --skip-agents pour éviter cette étape. Examinez le diff obtenu.

Lire et poser des questions utiles

Commencez par la page de démarrage, suivez les fichiers cités et demandez où un processus est implémenté. Le lecteur montre les pages, citations et relations enregistrées. Arrêtez le lecteur CLI au premier plan avec Ctrl+C.

Utilisez le Wiki pour vous orienter, puis examinez le code et les tests actuels. Pour les symboles, appelants et références exacts, utilisez l’intelligence de code ou LSP. Une page à jour ne prouve ni l’exhaustivité, ni l’exactitude, ni les performances réelles.

Maintenir à jour

Après une modification des sources, actualisez les pages concernées et vérifiez leur état :

ax-code wiki update
ax-code wiki status
ax-code wiki doctor

La commande d’état peut réussir même si le Wiki est absent ; vérifiez l’existence et la santé signalées. Un état obsolète ou dégradé exige un examen. Le lecteur CLI montre un instantané fixe : rouvrez-le après actualisation.

Dans les versions actuelles du TUI, /wiki-viz ouvre le lecteur et demande une maintenance. La maintenance interactive à l’inactivité est activée par défaut ; le travail au premier plan reste prioritaire. Les exécutions sans interface n’activent pas ce planificateur.

Contrôler la génération

Intégrez ces paramètres facultatifs au fichier de projet ax-code.json. Remplacez l’identifiant par un modèle disponible via votre connexion. Cet exemple désactive la maintenance en arrière-plan tout en conservant les commandes explicites :

{
  "wiki": {
    "enabled": true,
    "auto": false,
    "model": "provider/model"
  }
}

Un --model provider/model explicite remplace le modèle Wiki pour cette invocation. Les modèles de raisonnement nécessitent une commande reconnue de raisonnement faible ou désactivé ; choisissez un autre modèle compatible si cette règle refuse la requête.

Placez les notes des mainteneurs dans des blocs protégés pour les conserver lors des actualisations :

<!-- AX-WIKI:PROTECTED:START project-note -->

Deployment requires maintainer review.

<!-- AX-WIKI:PROTECTED:END -->

Résoudre les problèmes

Modèle absent ou erreur d’authentification : vérifiez l’accès fournisseur et le modèle Wiki configuré. Un choix fonctionnel pour le chat ne garantit pas qu’un modèle Wiki distinct soit utilisable.
Délai dépassé ou compilation interrompue : examinez ax-code wiki doctor et .ax-wiki/.build-report.json, puis réessayez après correction. Les pages temporaires validées peuvent être réutilisées ; un échec ne signifie pas que toutes les pages ont été publiées.
Conflit de modification manuelle : conservez vos notes dans les blocs protégés et examinez les changements avant de réessayer. --force autorise le remplacement des modifications hors de ces blocs ; utilisez-le délibérément.

Étapes suivantes

Configuration Wiki, CI et dépannage · Lecteur et export hors ligne · Choix du modèle · Accueil de la documentation