crllm

Crllm

Obtenez sans effort les avis de code à partir de modèles de grandes langues!

CRLLM est un puissant outil de ligne de commande qui permet aux développeurs d'obtenir des avis de code à partir de modèles de langue de grande partie de la technologie (LLM). Que vous souhaitiez utiliser OLLAMA pour les LLM en cours d'exécution localement ou que vous vous connectez à des services cloud comme Chatgpt, un visage étreint et Azure, CRLLM vous a couvert. Améliorez la qualité de votre code, captez les bogues potentiels et recevez des suggestions axées sur l'IA pour améliorer votre flux de travail de développement. Obtenez des recommandations sur les meilleures pratiques, les zones sujettes aux insectes et le refactorisation potentielle. Apprenez des suggestions sur la façon d'améliorer votre code, en obtenant de nouvelles idées et techniques. Réduisez le besoin de va-et-vient lors des revues de code humain en prenant plus de problèmes à l'avance.

Caractéristiques

• Options LLM flexibles : Utilisez Olllama pour exécuter des modèles localement ou tirer parti des API des fournisseurs de cloud comme Openai, Hugging Face et Azure.
• Revue complète du code : obtenez des commentaires de qualité sur le code, y compris les recommandations de lisibilité, d'efficacité et de meilleures pratiques.
• Productivité des développeurs : intégrer de manière transparente dans votre environnement de développement existant pour accélérer les processus d'examen du code.
• Contrôle de confidentialité : choisissez entre des solutions locales ou basées sur le cloud en fonction de vos besoins de confidentialité et de votre puissance de calcul.
• Prise en charge multi-langues : révision du code écrit dans divers langages de programmation (par exemple, Python, Javascript, Java, etc.).
• Support GIT : obtenez des avis sur vos changements GIT ou des différences entre les branches.

Installation

Pour commencer avec CRLLM, suivez ces étapes d'installation simples:

Condition préalable

• Python 3.8+ : assurez-vous que Python soit installé.
• pipx : https://pipx.pypa.io/stable/installation/
• Olllama : https://ollama.com/download Si vous souhaitez exécuter les modélins localement sinon vous aurez besoin des clés API correspondantes pour votre fournisseur

Installer à partir de github

pipx install git+https://github.com/lukasrump/crllm.git

Installer à partir de PYPI

pipx install crllm

Configuration

CRLLM prend en charge plusieurs backends pour les avis de code LLM. Vous pouvez le configurer en ajoutant un fichier de configuration crllm_config.toml dans la racine de votre projet. Pour initialiser votre projet, vous pouvez utiliser

crllm -i .

Cette commande vous guide à travers les paramètres les plus importants. Vous pouvez trouver plus d'informations sur les options de réglage du wiki.

Usage

CRLLM est conçu pour être facile à utiliser directement à partir de votre terminal. Vous trouverez ci-dessous quelques exemples de la façon dont vous pouvez tirer parti de l'outil.

Pour effectuer une revue de code pour un fichier ou un référentiel GIT RUN:

crllm path/to/your/codefile.py

Autorisation du support de chiffon

Pour améliorer les avis de code avec le contexte source, activez RAG (génération de récupération-augmentation) dans crllm_config.toml :

[ rag ]
enabled = true
embedding_model = " all-minilm "      # Specify the embedding model
src_path = " ./ "                     # Define the root path of your source code
src_glob = " **/*.py "                # Use glob patterns to match source files (e.g., Python files)

Ignorer les fichiers

CRLLM prend en charge un fichier .crllm_ignore pour exclure des fichiers et répertoires spécifiques des avis de code. Ceci est similaire à .gitignore mais spécifique au processus d'examen de code de CRLLM.