À l’attention de l’agent IA
Tout ce qui suit s’adresse à toi. Lis l’intégralité avant de commencer.Ta mission
Guide l’utilisateur dans l’installation et l’intégration de Linkly AI. Ta mission est accomplie lorsque :- l’application de bureau Linkly AI est installée, initialisée et indexe — les seuls exemples fournis suffisent ; les propres documents de l’utilisateur sont un plus ; et
- toi — ou un autre outil IA dont dispose l’utilisateur — peux réellement appeler les outils de recherche de Linkly AI et trouver un vrai document.
Tes limites et règles
Certaines choses, tu peux les faire toi-même ; d’autres doivent être confiées à l’utilisateur. N’outrepasse pas tes limites et ne présume jamais d’un résultat à la place de l’utilisateur :- Ce que tu peux faire toi-même : exécuter les commandes de diagnostic, installer le CLI, configurer MCP, installer les Skills, exécuter les commandes de vérification, interpréter les erreurs, rendre compte. Pour tout ce qui installe un logiciel, montre d’abord la commande et obtiens l’accord.
- Ce que l’utilisateur doit faire : télécharger et exécuter le programme d’installation, compléter l’assistant de configuration, ajouter des dossiers de documents dans l’application, accorder les permissions système. Ce sont des actions dans l’interface graphique — tu ne peux pas les réaliser.
- Diagnostique avant d’agir. L’utilisateur a peut-être déjà réalisé une partie de l’installation, ou effectue une réinstallation — ne déroule pas aveuglément toutes les étapes depuis le début.
- Vérifie chaque étape. Chaque étape précise son critère d’acceptation. Si le critère n’est pas rempli, ne passe pas à la suite.
- Lorsque l’utilisateur doit intervenir, dis-lui tout d’un coup, puis arrête-toi et attends une réponse unique. Ne découpe pas une même tâche en plusieurs allers-retours de confirmation.
- Montre les commandes d’installation et obtiens l’accord avant de les exécuter — en particulier tout ce qui télécharge et exécute un script depuis le réseau.
- N’exagère jamais l’avancement. Ce qui n’est pas vérifié n’est pas fait. Indique exactement où tu es bloqué et ce que tu as essayé.
- Ne contourne pas les exigences de permission, de sécurité ou de vérification. Lorsque la section Dépannage ne couvre pas un problème, exécute d’abord
linkly doctoret consulte le guide officiel pertinent ; si tu emploies une approche non mentionnée ici, explique ta raison et revérifie.
D’abord, vérifie si tu peux exécuter des commandes
Ce guide suppose que tu disposes d’un accès shell — Claude Code, Codex, Cursor, Gemini CLI, et similaires. Si tu es une application en ligne sans shell, comme ChatGPT ou Claude.ai sur le web, tu ne peux pas exécuter les commandes de diagnostic ci-dessous ni installer le CLI — la seule chose qui s’applique encore, c’est que l’application de bureau doit être installée (transmets l’intégralité de l’Étape 1 à l’utilisateur). La façon dont tu te connectes (MCP distant, téléversement des Skills, etc.) varie beaucoup d’une application à l’autre ; lis donchttps://linkly.ai/docs/llms.txt, trouve le guide d’intégration correspondant à l’application dans laquelle tu t’exécutes (par exemple « Using Linkly AI in ChatGPT »), et suis cette page pour guider l’utilisateur — ne généralise pas à partir de celle-ci.
Étape 0 : Diagnostiquer l’état actuel
Exécute d’abord ce lot de commandes, puis utilise le résultat pour décider par où commencer. macOS / Linux (bash / zsh) :Comment interpréter les résultats
/health est de loin le diagnostic le plus fiable. Lorsque le service tourne, il renvoie un code HTTP 200 et un corps JSON :
- Ne code jamais le port 60606 en dur. Ce n’est que la valeur par défaut ; si le port est occupé, l’application l’incrémente. Lis toujours le port réel dans
~/.linkly/port, dont le contenu est un JSON compact :{"port":60606}. - La présence du fichier de port ne signifie pas que le service tourne. Le fichier subsiste lorsque l’application est tuée de force ou qu’elle plante. Juge de l’état de santé uniquement selon que
/healthrenvoie 200. - Un
mcp_endpointànullsignifie que l’interrupteur MCP est désactivé (/healthrenvoie tout de même 200). Ne te lance pas dans un débogage du port — fais activer l’option par l’utilisateur dans Paramètres → MCP. - Valeurs de
index_status:watching(terminé — le CLI afficheUp to date),scanning,indexing,idle,error. doc_countest le nombre de documents indexés — sers-t’en pour évaluer l’avancement de l’indexation, pas comme preuve formelle que les fichiers de l’utilisateur ont bien été pris en compte : ce n’est qu’un total, et 151 contre 150 se distingue à peine lorsqu’un ou deux fichiers seulement ont été ajoutés.
Tableau des états
Parcours de haut en bas et applique la première ligne qui correspond (le tableau s’oriente selon l’état de la chaîne sur un seul axe, si bien que les lignes sont mutuellement exclusives) :
À noter : quelle que soit l’étape où tu entres, si
doc_count reste au niveau des exemples (~150), suggère — dans ton rapport final — que l’utilisateur ajoute ses propres dossiers dans Paramètres → Dossiers. Ce n’est pas un blocage ; poursuis.
Étape 1 : Installer et initialiser
Cette étape est entièrement manuelle — tu ne peux en réaliser aucune partie. Donne à l’utilisateur la séquence complète ci-dessous en un seul message, puis arrête-toi et attends une réponse unique du type « c’est fait ». Ne la déroule pas point par point sur plusieurs tours. Voici ce qu’il faut transmettre à l’utilisateur (reformule-le à ta manière si tu veux, mais couvre les cinq parties) :1. Télécharger et installer
Rendez-vous sur https://linkly.ai/#download et récupérez la version correspondant à votre système d’exploitation.- macOS : double-cliquez sur le fichier
.dmgpour le monter, faites glisser l’icône LinklyAI dans Applications, puis lancez-la depuis le Launchpad. - Windows : double-cliquez sur le fichier
.exeet suivez l’assistant (installation dans le répertoire utilisateur par défaut), puis lancez l’application depuis le menu Démarrer. - Linux : AppImage —
chmod +x LinklyAI-*.AppImage && ./LinklyAI-*.AppImage; ou deb —sudo dpkg -i linkly-ai-*.deb.
2. Compléter l’assistant du premier lancement
Le premier lancement ouvre une fenêtre guidée : écran d’accueil → connexion → préparation → panneau de découverte (le compteur d’étapes en bas à droite ne compte que les deux écrans du milieu, affichant 1/2 puis 2/2).- Écran d’accueil : choisissez la langue de l’interface et le thème. Vous devez cocher « J’ai lu et j’accepte la Politique de confidentialité » pour continuer. Le même écran comporte un interrupteur de télémétrie « Aider à améliorer Linkly AI », activé par défaut, que vous pouvez désactiver.
- Connexion (1/2) : cliquer sur « Se connecter / S’inscrire » ouvre le navigateur pour l’authentification OAuth. Cette étape peut être ignorée — le point d’entrée pour l’ignorer est un lien « ignorer la connexion » dans une ligne en petits caractères en bas. Indiquez à l’utilisateur : se connecter sert uniquement à obtenir rapidement le quota d’essai des modèles d’IA officiels et les fonctionnalités de bibliothèque de connaissances cloud, ce qui facilite la prise en main ; l’indexation locale, la recherche locale et le service MCP ne nécessitent aucune connexion réseau.
- Préparation (2/2) : l’application décompresse un jeu d’exemples de documents fournis et les indexe, généralement en quelques minutes. Attendez que le bouton « Commencer » s’active.
- Panneau de découverte : six cartes de fonctionnalités. Cliquez sur n’importe quelle carte pour essayer la fonctionnalité principale ; cliquez sur le × dans le coin supérieur droit pour terminer l’assistant.
3. Ajouter vos propres dossiers de documents (facultatif)
À la fin de l’assistant, seuls les exemples de documents fournis sont indexés — les fichiers de l’utilisateur ne le sont pas. Cela vaut la peine d’être suggéré, mais ce n’est pas obligatoire : les exemples suffisent pour essayer Linkly AI, et les dossiers peuvent être ajoutés à tout moment par la suite. Les deux méthodes fonctionnent :- Ouvrez Paramètres → Dossiers et ajoutez les répertoires à indexer (Documents, Téléchargements, un répertoire de projet, etc.) ;
- Ou déposez des fichiers dans le dossier
~/LinklyAI— il est surveillé par défaut, donc tout ce qui y est placé est indexé automatiquement.
4. Sache que les modèles se téléchargent en arrière-plan (aucune action requise, mais préviens l’utilisateur)
Après le premier lancement, l’application télécharge en arrière-plan environ 710 Mo de fichiers de modèles (environ 639 Mo pour la recherche sémantique, environ 70 Mo pour l’OCR). Selon la connexion, cela peut prendre de quelques minutes à plus d’une heure. Pendant ce laps de temps :- La recherche par mots-clés fonctionne immédiatement et n’est absolument pas affectée ;
- La recherche sémantique attend la fin du téléchargement et de l’indexation. D’ici là,
searchse rabat automatiquement sur la recherche par mots-clés seule (plein texte) — la pertinence baisse légèrement. C’est un comportement attendu, pas un défaut.
5. Répondre une seule fois, une fois tout terminé
Une fois tout ce qui précède accompli, réponds une seule fois à l’utilisateur sur un ton reconnaissant — tu prendras le relais pour la suite.Critère d’acceptation :
/health renvoie 200 et doc_count est supérieur à 0. Si tu viens de terminer l’assistant et que doc_count reste à 0 alors que index_status vaut scanning/indexing, les exemples sont encore en cours d’ingestion — réessaie toutes les 10 secondes, jusqu’à 6 fois ; s’il reste à 0, traite-le comme le cas error de la section Dépannage. Si l’utilisateur a ajouté ses propres dossiers, doc_count sera nettement supérieur au niveau des exemples ; s’il ne l’a pas fait, ce n’est pas une raison pour bloquer la suite.
Étape 2 : Connecter le chemin d’accès aux outils
Deux voies sont possibles, et elles ne sont pas mutuellement exclusives. Installe le CLI en premier : il fonctionne dès qu’il est installé, tu peux donc l’appeler et boucler la vérification dans la session en cours ; MCP, lui, exige un redémarrage de session avant de fonctionner, tu ne peux donc pas le vérifier sur-le-champ. Ce n’est qu’une priorité du type « puis-je m’auto-vérifier dans cette session » — cela ne veut pas dire que le CLI est un meilleur produit que MCP. Si l’utilisateur souhaite aussi disposer de Linkly AI dans un autre outil IA, tu peux configurer les deux. Ne code le port en dur dans aucune des commandes ci-dessous. Au début de cette étape, récupère le port réel dans une variable et référence-la ensuite :$port de l’Étape 0 : $mcpUrl = "http://127.0.0.1:$port/mcp".
Option A : Installer le CLI (recommandé)
Montre la commande à l’utilisateur, explique qu’elle télécharge et exécute un script d’installation depuis le réseau, et obtiens son accord avant de l’exécuter : macOS / Linux :linkly reste introuvable ensuite, demande à l’utilisateur d’ouvrir une nouvelle fenêtre de terminal (les modifications du PATH ne s’appliquent pas aux fenêtres déjà ouvertes), ou d’invoquer directement le chemin complet :
- macOS / Linux : installé dans
~/.linkly/bin/linkly, avec le PATH ajouté dans.zshrc/.bashrc/.profile; - Windows : installé dans
%LOCALAPPDATA%\linkly\bin\linkly.exe, en modifiant le PATH au niveau de l’utilisateur.
linkly --version affiche une version, et linkly status --json renvoie un JSON contenant app_version et doc_count. (Dans la sortie lisible de linkly status, ce champ est étiqueté Docs: et comporte des séparateurs de milliers ; pour les vérifications automatisées, utilise toujours --json.)
Option B : Configurer MCP
Utilise cette voie lorsque le CLI est difficile à installer dans l’environnement de l’utilisateur, ou lorsque celui-ci souhaite disposer de Linkly AI dans plusieurs outils IA. Utilise le$MCP_URL défini au début de l’Étape 2 (c’est-à-dire http://127.0.0.1:$PORT/mcp) — ne code pas 60606 en dur.
Clients courants :
- Claude Code :
claude mcp add --transport http linkly-ai "$MCP_URL" - Codex :
codex mcp add linkly-ai --url "$MCP_URL" - Cursor : Settings → MCP Servers → Add Server ; Name
linkly-ai, TypeStreamableHTTP, l’URL est la valeur résolue de$MCP_URL.
$MCP_URL par la valeur résolue) :
"serverInfo":{"name":"linkly-ai" signifie que le service MCP fonctionne correctement ; un 403 signifie que l’interrupteur MCP est désactivé — fais activer l’option par l’utilisateur dans Paramètres → MCP.
Étape 3 : Installer les Skills
Les Skills t’apprennent à bien utiliser les outils de Linkly AI — d’abord rechercher, puis consulter le sommaire, puis lire les passages qui comptent —, ce qui améliore sensiblement la qualité de la recherche. Fortement recommandé. Là encore, montre la commande et obtiens l’accord avant de l’exécuter :npx n’est pas disponible, clone manuellement :
-a claude-code / -a codex) ou d’autres méthodes, consulte Utiliser les Skills. Si le répertoire cible existe déjà, c’est qu’il est déjà installé — passe-le (pour le mettre à jour, place-toi dedans avec cd et fais git pull).
Les Skills nécessitent également un redémarrage de session pour être chargés. Le critère d’acceptation est que les fichiers soient bien arrivés dans le bon répertoire — et non que la session en cours puisse déjà les invoquer. Rappelle à l’utilisateur de redémarrer ensuite.
Critère d’acceptation : un fichier SKILL.md est présent dans l’un de ces chemins — ~/.claude/skills/linkly-ai/SKILL.md (Claude Code, niveau utilisateur), .claude/skills/linkly-ai/SKILL.md (niveau projet), ~/.agents/skills/linkly-ai/SKILL.md (Codex). npx skills add en choisit un automatiquement selon le client détecté ; il suffit donc de vérifier ces trois chemins ensuite.
Étape 4 : Vérification de bout en bout
Si tu as installé le CLI (Option A) : effectue une vraie recherche pour confirmer que toute la chaîne fonctionne. Vérifie d’aborddoc_count — au niveau des exemples (~150), recherche un mot de la bibliothèque d’exemples (par ex. Holmes) ; nettement au-dessus du niveau des exemples signifie que l’utilisateur a ajouté ses propres dossiers, alors utilise un mot susceptible d’apparaître dans ses documents :
Après avoir rechargé/démarré une nouvelle session, demande-moi « recherche Holmes avec linkly-ai » — si des entrées de documents sont renvoyées, toute la chaîne fonctionne.Si une recherche CLI revient vide, ne va pas accuser d’emblée le modèle — tant que le modèle n’est pas prêt,
search se contente de se rabattre sur les mots-clés seuls et ne renvoie pas de résultat vide. Vérifie dans l’ordre : la requête est-elle raisonnable → doc_count vaut-il 0 (exemples encore en cours d’ingestion, voir le critère d’acceptation de l’Étape 1) → l’utilisateur a-t-il ajouté des dossiers → le format est-il pris en charge. Utilise linkly status --json pour lire index_status : indexing signifie qu’il construit encore l’index ou télécharge des modèles — patiente simplement ; error → voir Dépannage.
À noter : dans le bref intervalle entre la fin de l’analyse et le début de l’extraction du contenu, index_status affiche watching (c’est-à-dire Up to date) prématurément. Ne juge pas de l’état de préparation sur un seul relevé — revérifie quelques secondes plus tard, ou observe si doc_count continue de grimper.
Dépannage
Rends compte une fois terminé
Termine par un bref récapitulatif à l’intention de l’utilisateur, couvrant :- les étapes que tu as réalisées, et par quelle voie (CLI ou MCP) ;
- si un redémarrage de session est nécessaire pour que quelque chose prenne effet ;
- l’état actuel de l’indexation et le nombre de documents ;
- comment l’utiliser concrètement — par exemple en ajoutant
use linkly-aià la fin de n’importe quel prompt, ou en appuyant surCMD/Ctrl + Shift + Lpour ouvrir le lanceur de recherche.
Termine par quatre exemples de questions
Termine ton rapport par quatre questions que l’utilisateur peut copier et essayer immédiatement. Adapte-les autant que possible à ses documents réels : Prends un moment pour voir ce qu’il a indexé — lance l’outilexplore (linkly explore en CLI) pour saisir la composition de la collection, et search sur quelques thèmes si tu as besoin de plus de détails. Rédige ensuite quatre questions qu’il poserait vraiment : ancrées dans ses propres documents et préoccupations, pas des banalités du type « résume mes documents ». Une bonne question doit lui faire penser « ça parle clairement de mes fichiers ».
Si l’utilisateur n’a pas encore ajouté ses propres documents (doc_count est encore au niveau des seuls exemples), utilise ces quatre questions, qui portent sur la bibliothèque d’exemples intégrée :
- Lisez A Life in 10 Years et analysez les schémas de vie récurrents dans les dix années de journal de Samuel Pepys — ainsi que les angles morts qu’il n’a peut-être jamais vus lui-même.
- Qu’est-ce qui fait vraiment gagner Sherlock Holmes ? Lisez les 12 affaires de Detectives Library, dégagez sa formule de résolution, puis transformez la méthode de Holmes en checklist pour diagnostiquer des problèmes business complexes.
- De quoi les fondateurs de l’Amérique avaient-ils vraiment peur ? Lisez l’intégralité des Federalist Papers et donnez-moi une réponse. Expliquez comment ils ont conçu un système où l’ambition contrebalance l’ambition et où les factions s’équilibrent — puis traduisez cette logique en principes de gouvernance pour les entreprises d’IA ou les plateformes internet d’aujourd’hui.
- Après avoir lu les souvenirs racontés par des centaines d’anciens esclaves, qu’est-ce que les manuels d’histoire américains osent le moins détailler ? Répondez à partir des WPA Slave Narratives.
Pour aller plus loin
- Démarrage rapide — le guide complet d’installation et de prise en main, rédigé pour les humains
- Utiliser le CLI — toutes les sous-commandes et tous les paramètres du CLI
- Utiliser MCP — les trois modes d’accès et la configuration par client
- Utiliser les Skills — comment les Skills s’installent et comment ils fonctionnent

