Installation de Code2Prompt

Présentation du guide

Bienvenue dans le guide d’installation de Code2Prompt. Ce document fournit des instructions étape par étape pour l’installer sur différentes plateformes, notamment Windows, macOS et Linux.

TL;DR

# Cargo
$ cargo install code2prompt

# Homebrew
$ brew install code2prompt

Prérequis

Assurez-vous que Rust et cargo sont installés sur votre système.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

C’est la façon officielle d’installer la dernière version stable de Rust et Cargo. Assurez-vous de rafraîchir votre variable PATH après avoir installé Rust. Redémarrez votre terminal ou exécutez les instructions proposées par l’installateur.

source $HOME/.cargo/env

Vous pouvez vérifier que tout est installé correctement en exécutant :

cargo --version
git --version

Interface de ligne de commande (CLI) 👨‍💻

# Cargo
$ cargo install code2prompt

# Homebrew
$ brew install code2prompt

🧪 Installer la dernière version (non publiée) depuis GitHub

Si vous voulez les dernières fonctionnalités ou corrections avant leur publication sur crates.io :

cargo install --git https://github.com/mufeedvh/code2prompt

Construction à partir du code source

Idéal pour les développeurs qui veulent construire à partir du code source ou contribuer au projet.

🛠️ Installer les prérequis :
- Rust et Cargo
- Git

📥 Cloner le référentiel :

git clone https://github.com/mufeedvh/code2prompt.git
cd code2prompt

📦 Installer l’exécutable :

Pour construire et installer à partir du code source :
Fenêtre de terminal
```
cargo install --path crates/code2prompt
```
Pour construire l’exécutable sans l’installer :
Fenêtre de terminal
```
cargo build --release
```
L’exécutable sera disponible dans le répertoire target/release.
🚀 L’exécuter :
Fenêtre de terminal
```
code2prompt --help
```

Publications binaires

Le meilleur choix pour les utilisateurs qui veulent utiliser la dernière version sans construire à partir du code source.

Téléchargez la dernière version binaire pour votre système d’exploitation à partir de Releases.

⚠️ Les publications binaires peuvent être à la traîne par rapport à la dernière version GitHub. Pour des fonctionnalités de pointe, envisagez de construire à partir du code source.

AUR

Spécifiquement pour les utilisateurs d’Arch Linux, code2prompt est disponible dans l’AUR.

code2prompt est disponible dans l’AUR. Installez-le via n’importe quel assistant AUR.

paru/yay -S code2prompt

Nix

Si vous utilisez Nix, vous pouvez l’installer en utilisant soit nix-env, soit nix profile.

# sans flakes :
nix-env -iA nixpkgs.code2prompt
# avec flakes :
nix profile install nixpkgs#code2prompt

Kit de développement logiciel (SDK) 🐍

Pypi

Vous pouvez télécharger les liaisons Python à partir de Pypi

pip install code2prompt_rs

Construction à partir du code source

🛠️ Installer les prérequis :
- Rust et Cargo
- Git
- Rye

📥 Cloner le référentiel :

git clone https://github.com/mufeedvh/code2prompt.git
cd code2prompt/crates/code2prompt-python

📦 Installer les dépendances :

La commande rye créera un environnement virtuel et installera toutes les dépendances.
Fenêtre de terminal
```
rye sync
```
⚙️ Construire le paquet :

Vous développerez le paquet dans l’environnement virtuel situé dans le dossier .venv à la racine du projet.
Fenêtre de terminal
```
rye run maturin develop -r
```

Protocole de contexte de modèle (MCP) 🤖

Installation automatisée

Le serveur MCP code2prompt sera bientôt disponible dans les registres MCP.

Installation manuelle

Le serveur MCP code2prompt est encore un prototype et sera intégré au référentiel principal bientôt.

Pour exécuter le serveur MCP, localement pour l’utiliser avec Cline, Goose ou Aider :

🛠️ Installer les prérequis :
- Git
- Rye

📥 Cloner le référentiel :

git clone https://github.com/odancona/code2prompt-mcp.git
cd code2prompt-mcp

📦 Installer les dépendances :

La commande rye créera un environnement virtuel et installera toutes les dépendances dans le dossier .venv.
Fenêtre de terminal
```
rye sync
```
🚀 Exécuter le serveur :

Le serveur MCP est maintenant installé. Vous pouvez l’exécuter en utilisant :
Fenêtre de terminal
```
. .venv/bin/activate
python -m src/code2prompt_mcp/main.py
```

🔌 Intégrer avec les agents :

Par exemple, vous pouvez l’intégrer avec Cline, en utilisant une configuration similaire :

{
  "mcpServers": {
    "code2prompt": {
      "command": "bash",
      "args": [
        "-c",
        "cd /home/olivier/projet/code2prompt-mcp && rye run python /home/olivier/projet/code2prompt-mcp/src/code2prompt_mcp/main.py"
      ],
      "env": {}
    }
  }
}

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