Installation et utilisation du CLI

Ce guide couvre l’installation du CLI Remy sur macOS, la connexion, l’exécution de tâches dans des projets locaux, la reprise de conversations, la mise à jour du CLI et l’envoi de retours.

flowchart LR
    A["Configurer Node.js et npm"] --> B["Installer le CLI Remy"]
    B --> C["Se connecter"]
    C --> D["Accéder au projet"]
    D --> E["Lancer une tâche"]
    E --> F["Examiner et poursuivre"]

1. Avant de commencer

1.1 Configuration système et environnement d’exécution

Le CLI nécessite Node.js et npm. L’installation standard du CLI Remy avec npm ne nécessite pas d’installation distincte de Python ou Rust. Votre projet et ses tests ont toujours besoin de leur propre environnement et de leurs dépendances.

Vérifiez votre configuration dans le terminal :

node --version
npm --version

Les deux commandes doivent afficher un numéro de version. Si l’une manque, obtenez le programme d’installation adapté à votre Mac sur le site de Node.js, terminez l’installation et ouvrez un nouveau terminal. Choisissez la version LTS actuelle avant d’installer Remy.

1.2 Accès aux modèles

Connectez-vous avec votre compte Remy pour utiliser les modèles auxquels il donne accès. Le processus standard ne nécessite pas de compte distinct auprès d’un fournisseur de modèles ni de clé API.

Connectez-vous séparément à l’application de bureau et au CLI. Même si vous êtes connecté à Remy Desktop, vous devez encore vous connecter lors de la première utilisation du CLI.

2. Installer et vérifier le CLI

2.1 Installer le CLI Remy

Exécutez ceci dans votre terminal :

npm install -g @corepassinc/remy

Attendez la fin de l’installation. Le programme d’installation sélectionne les composants adaptés à votre système d’exploitation et à l’architecture de votre environnement Node.js. Vous n’avez pas besoin de choisir un paquet CLI Apple silicon ou Intel distinct.

2.2 Vérifier que la commande est disponible

Après l’installation, exécutez :

remy --version
remy --help

Si votre terminal ne trouve pas remy, ouvrez un nouveau terminal et consultez les indications sur l’installation et le chemin des commandes à la section 7.

3. Se connecter et vérifier votre compte

3.1 Se connecter

Exécutez ceci dans votre terminal :

remy login

1. Terminez la connexion dans le navigateur qui s’ouvre.
2. Revenez au terminal et attendez le résultat.
3. Lorsque vous voyez Connecté en tant que …, passez à l’étape suivante.

En cas d’échec de connexion, suivez le message du terminal pour vérifier votre connexion réseau ou relancer la connexion.

3.2 Vérifier le compte actif

remy whoami

Utilisez cette commande pour vérifier le compte connecté, son périmètre de compte actuel et le répertoire de travail. Si vous utilisez un compte d’équipe, confirmez que l’équipe voulue est sélectionnée.

3.3 Vérifier l’environnement d’exécution

remy doctor

Utilisez les résultats pour déterminer les points à traiter :

La réussite des contrôles d’environnement ne vérifie pas une tâche complète. Exécutez une vraie tâche pour confirmer que l’accès aux modèles, l’accès au projet et les résultats fonctionnent comme prévu.

Pour vous déconnecter du CLI :

remy logout

4. Démarrer une tâche interactive dans votre projet

4.1 Accéder au dossier du projet

Dans votre terminal, accédez au projet sur lequel travailler, puis démarrez Remy :

cd "/path/to/project"
remy

Remplacez /path/to/project par le chemin réel de votre projet local.

Vous pouvez aussi indiquer le dossier du projet au démarrage de Remy :

remy --workspace "/path/to/project"

Vérifiez le dossier avant de commencer. Le CLI travaille depuis le répertoire de travail actuel. Pour travailler sur un autre projet, quittez la session interactive, puis accédez à l’autre dossier ou démarrez Remy avec --workspace.

4.2 Choisir un modèle et envoyer une tâche

Dans l’interface interactive de Remy :

1. Appuyez sur F2 ou saisissez /model pour voir les modèles disponibles.
2. Choisissez un modèle. Pour les modèles proposant des paramètres de raisonnement, utilisez Ctrl+U pour les ajuster.
3. Décrivez votre tâche dans le champ de saisie et appuyez sur Entrée pour l’envoyer.

Dans un terminal macOS, Option+Entrée ajoute une nouvelle ligne. Appuyez sur Ctrl+G pour voir les raccourcis clavier et les options disponibles.

Choisissez un modèle avant de lancer la tâche. La liste affichée dans le CLI reflète les modèles disponibles pour votre compte actuel.

4.3 Effectuer une petite modification

Choisissez un vrai problème dans un projet existant. L’exemple ci-dessous utilise le filtrage et la pagination d’une liste de commandes ; adaptez la fonctionnalité et le comportement à votre projet.

Commencez par comprendre le code concerné :

Lis la documentation et les instructions pertinentes de ce projet.
Repère les fichiers, la logique de filtrage, la logique de pagination et les tests de la liste de commandes.

Analyse uniquement. Ne modifie pas de fichiers, n’installe pas de dépendances et ne fais ni commit ni push.

Après avoir vérifié que Remy comprend la tâche, poursuivez dans la même conversation :

Lorsque je change le filtre de statut à la page 3 de la liste de commandes, la liste semble vide.
Les résultats n’apparaissent qu’après mon retour à la page 1.

Trouve et corrige le problème pour qu’un changement de filtre réinitialise le numéro de page.
Modifie uniquement la logique concernée et ajoute et exécute les tests pertinents.
À la fin, résume les fichiers modifiés, les résultats des vérifications et les vérifications que tu n’as pas pu terminer.

Ne fais pas encore de commit ni de push.

Si Remy demande des informations ou une confirmation, lisez sa demande avant de répondre. Utilisez /permissions pour voir les autorisations d’action de la conversation actuelle et suivez les invites de l’interface pour choisir un paramètre.

4.4 Examiner les résultats et poursuivre

Si votre projet utilise Git, ouvrez une autre fenêtre de terminal dans le même projet pour examiner les modifications non commitées :

git status --short
git diff

Par défaut, git diff affiche les modifications non indexées des fichiers suivis. Il n’affiche pas le contenu des nouveaux fichiers ni les modifications indexées. Utilisez git diff --cached pour les modifications indexées et ouvrez directement les nouveaux fichiers pour les examiner. Les modifications visibles peuvent aussi inclure du travail antérieur au début de la tâche.

Pour affiner le résultat, décrivez ce qui s’est passé, ce que vous attendiez et ce qui doit changer dans la conversation d’origine :

Le numéro de page se réinitialise maintenant, mais la liste ne s’actualise pas.
Elle devrait demander de nouvelles données dès que le filtre change.

Corrige uniquement ce problème, ajoute et exécute les tests pertinents,
puis résume la modification et les résultats des vérifications. Ne fais pas encore de commit ni de push.

4.5 Raccourcis clavier courants

5. Commandes et poursuite des conversations

5.1 Savoir où saisir une commande

Exécutez les commandes d’installation comme npm install dans le terminal du système plutôt que de les envoyer à Remy comme des demandes de tâches.

5.2 Commandes interactives courantes

Avant de démarrer ou de reprendre une conversation, terminez la tâche actuelle et vérifiez les fichiers tels qu’ils existent réellement dans votre projet.

5.3 Lister les conversations passées

Exécutez ceci dans le terminal du système :

remy history list

Cette commande liste les conversations du projet actuel dans le périmètre de compte actif. Dans l’interface interactive, utilisez /resume ou Ctrl+R pour choisir une conversation et la poursuivre.

Les conversations visibles dépendent du compte connecté, du périmètre d’équipe et du dossier du projet. L’accès à l’historique local ne signifie pas que tous les appareils sont automatiquement synchronisés.

5.4 Exécuter une tâche ponctuelle

Pour une tâche claire ne nécessitant pas de conversation continue, utilisez :

remy exec "Lis le README de ce projet et résume comment exécuter le projet et ses tests. Analyse uniquement ; ne modifie pas de fichiers."

La commande exécute cette tâche et affiche le résultat. Pour un travail nécessitant des instructions de suivi, démarrez le mode interactif avec remy.

Pour fournir des références locales, joignez un fichier :

remy exec --attach "./requirements.md" "Lis ces exigences et identifie les modules concernés et les étapes d’implémentation dans ce projet. Ne modifie pas encore de fichiers."

Remplacez le chemin par celui d’un fichier existant sur votre ordinateur. Pour plus d’options, exécutez :

remy exec --help

6. Mettre à jour le CLI Remy

6.1 Vérifier votre version

remy --version

6.2 Mettre à jour la version par défaut

Terminez la tâche actuelle et quittez l’interface interactive de Remy, puis exécutez :

npm install -g @corepassinc/remy

Une fois l’installation terminée, vérifiez à nouveau :

remy --version
remy --help

Si le CLI indique toujours une ancienne version, vérifiez quelle commande le terminal trouve :

command -v remy
npm prefix -g

Si vous utilisez un gestionnaire de versions Node.js, chaque environnement Node.js peut avoir son propre répertoire d’installation globale. Après un changement d’environnement, vérifiez l’installation de Remy et le chemin de la commande dans l’environnement actif.

7. Dépannage et limites connues

7.1 Problèmes d’installation et d’environnement d’exécution

7.2 Périmètre et limites

• Ce guide couvre macOS sur Apple silicon et Intel.
• Les tâches locales dépendent de votre ordinateur, de la session de terminal et de l’environnement du projet. Gardez l’environnement requis disponible.
• L’accès aux outils diffère selon les clients. Les outils CLI facultatifs dépendent des résultats du diagnostic et de la configuration réelle.
• Le CLI ne prend pas actuellement en charge les évaluations pouce vers le haut/bas pour chaque réponse. Utilisez la commande de retour de la section suivante pour les problèmes produit.
• Reprendre une conversation ne restaure pas les fichiers. Vérifiez l’état actuel des fichiers avant de poursuivre.

8. Obtenir de l’aide et envoyer un retour

8.1 Consulter l’aide des commandes

remy --help
remy doctor --help
remy feedback send --help

Dans Remy, utilisez /help pour les commandes et Ctrl+G pour les raccourcis clavier.

8.2 Décrire le problème

Enregistrez votre description du problème dans un fichier texte UTF-8, par exemple feedback.txt. Incluez les étapes de reproduction, le résultat attendu, ce qui s’est passé, ainsi que les messages d’erreur et détails de version.

8.3 Prévisualiser et envoyer

Prévisualisez d’abord votre rapport :

remy feedback send --type bug --impact moderate --description-file "./feedback.txt" --dry-run

--dry-run affiche l’aperçu sans envoyer de rapport. Après avoir vérifié la description et les options de retour, retirez cet indicateur et relancez la commande :

remy feedback send --type bug --impact moderate --description-file "./feedback.txt"

Le CLI affiche un aperçu, puis vous demande de saisir send pour confirmer. Saisissez autre chose pour annuler.

Choisissez le type et l’impact correspondant à votre problème ; les valeurs bug et moderate de l’exemple ne sont que des exemples.

Ne considérez le rapport comme envoyé que lorsque la commande confirme explicitement sa réussite et renvoie un identifiant de retour. Résultat inconnu signifie que le CLI n’a pas reçu de résultat d’envoi fiable. Consultez l’assistance avant de renvoyer le rapport pour éviter un doublon.

Si vous ne pouvez pas démarrer le CLI, vous connecter ou utiliser la commande de retour, contactez l’assistance à support@corepass.com.

8.4 Poursuivre la découverte