Présentation du Linkly AI CLI
Le Linkly AI CLI est un outil en ligne de commande qui se connecte au service MCP de Linkly AI Desktop, vous permettant de rechercher, parcourir et lire vos documents locaux depuis le terminal. Il sert également de passerelle entre les AI Agents (comme Claude Desktop, Cursor) et Linkly AI.Recherche en terminal
Recherchez directement vos documents depuis la ligne de commande, idéal pour les développeurs et les utilisateurs avancés
Passerelle MCP
Fonctionne en mode MCP stdio, permettant à Claude Desktop, Cursor et d’autres outils IA d’appeler Linkly AI
Installation
- macOS / Linux
- Windows
- Cargo
Exécutez dans le terminal :Ou installez via Homebrew :
Par défaut, le CLI découvre et se connecte à l’application Linkly AI Desktop locale via le fichier
~/.linkly/port. Vous pouvez également vous connecter à un appareil distant via le réseau local ou le tunnel cloud — voir Modes de connexion ci-dessous.Méthodes d’utilisation
Le CLI suit le flux de travail progressif search → grep ou outline → read : d’abord rechercher pour trouver les documents cibles, puis utiliser grep pour localiser des motifs ou consulter le sommaire pour comprendre la structure, et enfin lire le contenu spécifique. Lorsque l’utilisateur évoque un conteneur (“dans mes notes Notion”, “dans mon dossier Dropbox”) dont le chemin réel est inconnu, appelezfind-paths avant search pour le localiser.
Chaque sortie de commande réussie se termine par une ligne d’horodatage UTC
[meta] now=2026-05-08T...Z (ou un champ _meta.now au niveau supérieur en mode JSON). Il s’agit de métadonnées que Desktop fournit aux assistants IA pour calculer des dates relatives comme « le mois dernier ». Les utilisateurs humains peuvent l’ignorer ; pour le scriptage, il est recommandé de filtrer la dernière ligne avant l’analyse ultérieure.Vérifier l’état de la connexion
Rechercher des documents
--scope notes restreint les résultats à vos notes et ignore --library et --path-glob — ces filtres sont silencieusement écartés plutôt que rejetés.Consulter le sommaire d’un document
DOC_ID est récupéré depuis les résultats de recherche. Vous pouvez consulter plusieurs documents à la fois, ou transmettre les ID via un pipe avec - :
--expand pour indiquer les ID des nœuds à déplier, séparés par des virgules (les autres restent repliés) ; sans cette option, le choix des nœuds dépliés est automatique :
Rechercher des motifs dans les documents
Lire le contenu d’un document
--offset pour lire progressivement :
Localisation de chemins (find-paths)
search : lorsque l’utilisateur nomme un conteneur (“dans mes notes Notion”, “dans mon dossier Dropbox”) sans en connaître le chemin sur le disque, appelez d’abord find-paths, puis transmettez un segment distinctif du chemin retourné comme --path-glob à search. Lorsqu’un nom de dossier contient des métacaractères glob (* ? [), utilisez directement le champ path_glob retourné — il est déjà échappé pour correspondre littéralement à ce dossier.
Flux de travail typique en deux étapes :
--patterns prend une liste de mots-clés séparés par des virgules, combinés en interne par OR contre le chemin. Passez plusieurs variantes en un seul appel (paires de traduction, casse, identifiants réels d’application) pour maximiser le rappel au premier coup :
Bibliothèques et vue d’ensemble (list-libraries, explore)
--library des autres commandes.
--library accepte un nom de bibliothèque ou local://<id> ; avec --remote, vous pouvez aussi passer cloud://<owner>/<slug>.
Notes
Linkly AI conserve de courtes notes Markdown dans le dossier de votre bibliothèque. Ce sont des fichiers locaux ordinaires — jamais téléversés — et ils sont indexés comme n’importe quel autre document.note_id et sa version actuelle, tous deux retournés par linkly list --scope notes :
Diagnostiquer la connexion (doctor)
--remote, --lan ou --endpoint / --token, seule cette connexion est vérifiée, et le code de sortie ne dépend que d’elle :
Gérer les Skills (skills)
install installe les Skills dans ~/.agents/skills/linkly-ai et crée un lien vers ce dossier dans ~/.claude/skills/linkly-ai. Voir Utiliser les Skills.
Quand une nouvelle version des Skills est disponible, la sortie des commandes se termine par une ligne d’information, au plus une fois toutes les 4 heures. Définissez la variable d’environnement LINKLY_NO_SKILLS_HINT=1 pour la désactiver. Si vous la définissez dans la configuration de votre client MCP, le pont linkly mcp n’affiche plus non plus cette information.
Complétion du shell
bash, zsh, fish, powershell ou elvish.
- zsh
- bash
- fish
- PowerShell
Mode MCP
La passerelle ne peut pas se connecter à une application de bureau située sur un autre appareil du réseau local. Les clients IA du réseau local doivent se connecter directement à l’application de bureau en HTTP (voir Accès réseau local) ; les clients qui ne prennent en charge que stdio peuvent utiliser
linkly mcp --remote à la place.--client <nom> indique le nom de l’application dans le journal d’accès de l’application de bureau, comme dans les exemples ci-dessous. Avec --remote, ce nom est également envoyé à la passerelle cloud.
Configurer Claude Desktop et d’autres applications IA locales :
Ajoutez le contenu suivant au fichier de configuration de Claude Desktop ou d’autres applications :
- macOS
- Windows
Éditez
~/Library/Application Support/Claude/claude_desktop_config.json :- Name:
linkly-ai - Command:
linkly mcp --client cursor
Mettre à jour le CLI
Modes de connexion
Le CLI prend en charge trois façons de se connecter à votre base de connaissances Linkly AI :
Sans
--lan ni --remote, le CLI se connecte uniquement à l’application de bureau de cette machine.
Mode local (par défaut)
Aucune option supplémentaire n’est nécessaire. Le CLI lit~/.linkly/port pour trouver l’application de bureau en cours d’exécution :
Mode réseau local
Connectez-vous à une instance de Linkly AI qui s’exécute sur un autre appareil de votre réseau local. L’adresse et le jeton se récupèrent sur cet appareil : dans son application de bureau, ouvrez la page « Utilisation par les agents », activez « Autoriser l’accès LAN » dans la zone « Gestion », puis cliquez sur « Voir la configuration de connexion MCP » dans la zone « Intégration » et copiez-les depuis la section « LAN » (voir Accès réseau local). Enregistrez-les ensuite une fois sur cette machine, vous-même, dans votre propre terminal :--lan avec n’importe quelle commande :
auth set-key --lan avec le nouveau jeton. Lorsque vous n’en avez plus besoin, supprimez la configuration réseau local enregistrée avec linkly auth logout --lan.
L’enregistrement d’une connexion réseau local et l’option
--lan nécessitent le CLI 1.0.0 ou plus récent. Le CLI ne peut enregistrer qu’une seule connexion réseau local : exécuter à nouveau auth set-key --lan écrase l’adresse et le jeton enregistrés. Pour vous connecter ponctuellement à un autre appareil, utilisez --endpoint et --token.Mode distant
Connectez-vous à votre base de connaissances depuis n’importe où via le tunnel cloud. Commencez par vous identifier une fois :XXXX-XXXX), et ouvre le navigateur quand il le peut. Ouvrez le lien sur n’importe quel appareil (votre téléphone convient si le CLI tourne sur un serveur), connectez-vous, vérifiez que le code correspond à celui affiché dans le terminal, puis cliquez sur Autoriser. Le CLI enregistre alors une API Key nouvellement émise. Le lien est valable 10 minutes ; la page indique le compte que vous autorisez, le code de confirmation, l’appareil qui demande l’accès (tel qu’il se déclare lui-même) et les autorisations accordées. Si vous ne voulez pas que le CLI tente d’ouvrir le navigateur, ajoutez --no-browser : il se contente alors d’afficher le lien.
Utilisez ensuite --remote avec n’importe quelle commande :
--wait abandonne au bout de 300 secondes (modifiable avec --timeout) avec le code timeout ; relancez-le tant que le lien est encore valable. En mode --json, les échecs portent un code : timeout, expired, denied, no_pending_login, login_in_progress (utilisez --wait, ou --restart pour recommencer), already_logged_in (exécutez d’abord linkly auth logout) et network. Chaque message indique la commande à exécuter ensuite.
Chaque connexion crée une nouvelle API Key nommée cli-<hostname>-xxxx, visible et révocable dans le tableau de bord. Un compte peut détenir jusqu’à 10 API Keys ; si la limite est atteinte, la page d’autorisation le signale. Se connecter prouve seulement de quel compte il s’agit : cela ne garantit pas que vos bibliothèques cloud ou votre application de bureau sont joignables.
Vous préférez coller une clé ? Créez-en une dans le tableau de bord et enregistrez-la vous-même, dans votre propre terminal :
logout révoque aussi une clé émise par auth login : elle cesse de fonctionner en 90 secondes environ. Une clé enregistrée avec set-key est seulement supprimée de cette machine, car elle peut servir ailleurs ; révoquez-la dans le tableau de bord si nécessaire.
Les identifiants, ainsi qu’une connexion encore en attente d’autorisation, se trouvent par défaut dans ~/.linkly. Définissez LINKLY_CONFIG_DIR pour les placer ailleurs, par exemple un répertoire par utilisateur lorsqu’un agent sert plusieurs personnes depuis le même compte système. Chaque répertoire contient un seul compte. La détection de l’application de bureau locale (~/.linkly/port) n’est pas affectée.
Description des paramètres
Options globales
Codes de sortie
Par défaut, le CLI utilise les deux valeurs conventionnelles : 0 en cas de succès, 1 en cas d’échec. Notez qu’un « succès » inclut le fait de ne rien trouver — une recherche sans résultat sort tout de même avec le code 0. Les erreurs d’arguments (argument obligatoire manquant, valeur invalide, etc.) sortent toujours avec le code 2, avec ou sans--exit-code.
Passez --exit-code pour distinguer les deux cas :
Cette option est facultative car elle change la signification de
1. Sans elle, 1 signifie « échec » — ce que testent les scripts existants.
