Getting Started with Code2Prompt

Présentation du Tutoriel

Bienvenue dans Code2Prompt ! Ce tutoriel fournit une introduction complète à l’utilisation de Code2Prompt pour générer des invites prêtes à être utilisées par l’IA à partir de vos bases de code. Nous explorerons sa fonctionnalité principale et démontrerons son utilisation à travers différentes méthodes d’intégration : Interface de Ligne de Commande (CLI), Kit de Développement de Logiciels (SDK) et Protocole de Contexte de Modèle (MCP).

Qu’est-ce que Code2Prompt ?

Code2Prompt est un outil polyvalent conçu pour combler le fossé entre votre base de code et les Modèles de Langage à Grande Échelle (LLM). Il extrait intelligemment des extraits de code pertinents, applique un filtrage puissant et formate les informations en invites structurées optimisées pour la consommation LLM. Cela simplifie des tâches telles que la documentation de code, la détection de bogues, la refactorisation, etc.

Code2Prompt offre différents points d’intégration :

Une bibliothèque Rust de base qui fournit les fondations pour l’ingestion de code et la génération d’invites.

📥 Installation

Pour des instructions d’installation détaillées pour toutes les méthodes (CLI, SDK, MCP), veuillez vous référer au Guide d’Installation.

🏁 Génération d’Invites : Un Exemple de CLI

Commençons par un exemple simple en utilisant la CLI. Créez un projet échantillon :

mkdir -p my_project/{src,tests}
touch my_project/src/main.rs my_project/tests/test_1.rs
echo 'fn main() { println!("Hello, world!"); }' > my_project/src/main.rs

Maintenant, générez une invite :

code2prompt my_project

Cela copie une invite dans votre presse-papiers. Vous pouvez personnaliser cela :

Filtrage : code2prompt my_project --include="*.rs" --exclude="tests/*" (inclut uniquement les fichiers .rs, exclut le répertoire tests)
Fichier de sortie : code2prompt my_project --output-file=my_prompt.txt
Sortie JSON : code2prompt my_project -O json (sortie JSON structurée)
Modèles personnalisés : code2prompt my_project -t my_template.hbs (nécessite la création de my_template.hbs)

Voir les tutoriels Apprendre le filtrage de contexte et Apprendre les modèles Handlebar pour en savoir plus sur les utilisations avancées.

🐍 Intégration SDK (Python)

Pour un contrôle programmatique, utilisez le SDK Python :

from code2prompt_rs import Code2Prompt

config = {
    "path": "my_project",
    "include_patterns": ["*.rs"],
    "exclude_patterns": ["tests/*"],
}

c2p = Code2Prompt(**config)
prompt = c2p.generate_prompt()
print(prompt)

Cela nécessite l’installation du SDK (pip install code2prompt_rs). Référez-vous à la documentation du SDK pour plus de détails.

🤖 Intégration du Serveur MCP (Avancé)

Pour une intégration avancée avec les agents LLM, exécutez le serveur MCP code2prompt (voir le guide d’installation pour les détails). Cela permet aux agents de demander du contexte de code de manière dynamique. Il s’agit d’une fonctionnalité avancée, et une documentation supplémentaire est disponible sur le site Web du projet.

Étapes suivantes

Explorez les tutoriels avancés et la documentation pour maîtriser les capacités de Code2Prompt et l’intégrer dans vos workflows.

Cette page a été traduite automatiquement pour votre commodité. Veuillez vous référer à la version anglaise pour le contenu original.