SourceAnt
DEENES

Premiers pas

SourceAnt vous aide à comprendre votre code, la façon dont vos systèmes s'articulent et les connaissances que votre équipe accumule au fil du travail. Cette compréhension fait des revues un point de contrôle qualité pour les changements, y compris ceux qui affectent d'autres dépôts du même système.

Démarrer sur le cloud

Vous avez besoin d'un dépôt GitHub, de l'autorisation d'y installer l'application GitHub SourceAnt et d'une clé API pour le modèle que vous souhaitez utiliser. Vous n'avez pas besoin d'installer le CLI.

  1. Connectez-vous à SourceAnt et choisissez un espace de travail personnel ou d'équipe. C'est là que vous connecterez le dépôt et conserverez ses connaissances.
  2. Installez l'application GitHub SourceAnt sur le compte ou l'organisation propriétaire du dépôt, en lui accordant l'accès à ce dépôt.
  3. Sélectionnez le dépôt dans SourceAnt et cliquez sur Connecter et continuer.
  4. Choisissez un fournisseur de modèle et un modèle, saisissez votre clé API et enregistrez-les.
  5. Cliquez sur Lancer l'analyse pour lire le dépôt en arrière-plan. Examinez les connaissances et la structure du système obtenues dans le tableau de bord.
  6. Ouvrez une pull request sur le dépôt connecté et consultez GitHub pour la revue.

Pour les captures d'écran, les étapes facultatives et les vérifications de configuration, suivez Configuration cloud.

Travailler localement avec le CLI

Utilisez SourceAnt localement pour explorer votre code et vos connaissances, gérer les compétences et vérifier les changements par rapport à celles-ci avant de partager votre travail. 

curl -fsSL https://raw.githubusercontent.com/sourceant/cli/main/scripts/install.sh | sh
sourceant setup
sourceant ui

Ajoutez un dépôt depuis le panneau. Pour l'utiliser depuis votre éditeur, connectez un client MCP à http://127.0.0.1:8930/mcp. MCP est le protocole que votre assistant de codage utilise pour appeler les outils de SourceAnt.

Voir Configuration locale pour l'installation, la configuration du modèle et l'accès depuis l'éditeur.

Héberger votre propre serveur

Pour héberger l'API de revue sur votre propre serveur à l'aide d'images Docker, suivez le guide de configuration de l'application GitHub pour recevoir les événements de pull request sur votre serveur. Cela est distinct de l'installation de l'application SourceAnt hébergée sur GitHub.

Vérifiez ce que SourceAnt a appris

Ouvrir Knowledge pour examiner les décisions et contraintes qu'il a identifiées. Ouvrez Systèmes pour vérifier comment les dépôts sont regroupés et connectés. Corrigez ces enregistrements avant de vous appuyer dessus comme contexte pour des revues ultérieures.

Utilisez le bouton de recherche dans la navigation du tableau de bord, ou appuyez sur Ctrl+K (Command+K sur macOS). La recherche propose des pages à ouvrir et, sur les pages compatibles, des enregistrements de la vue actuelle. Elle recherche parmi les enregistrements chargés par cette page, et non parmi tous les enregistrements de l'espace de travail. Utilisez les touches fléchées et Entrée pour choisir un résultat, ou Échap pour fermer.

Next steps

  • Revue de code: comprenez le résultat de la revue.
  • Knowledge management: organisez le contexte utilisé par vos outils.
  • Systèmes: regroupez les dépôts liés et découvrez leurs connexions.
  • Inspection de l'architecture: explorez la structure du code et comparez les instantanés locaux.
  • Compétences: partagez des instructions réutilisables avec les outils connectés.
  • Exigences: organisez le travail et suivez les liens entre implémentation et tests.
  • Analytique: inspectez l'activité et les dépenses liées aux modèles.