Passer au contenu principal

​
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

Exécutez dans le terminal :
curl -sSL https://updater.linkly.ai/cli/install.sh | sh
Après l’installation, vérifiez : 
linkly --version
Le CLI nécessite que l’application Linkly AI Desktop soit lancée au préalable. Le CLI découvre et se connecte automatiquement au service MCP de l’application de bureau via le fichier ~/.linkly/port.

​
Méthodes d’utilisation

Le CLI suit le flux de travail progressif search → outline → read : d’abord rechercher pour trouver les documents cibles, puis consulter le sommaire pour comprendre la structure, et enfin lire le contenu spécifique.

​
Vérifier l’état de la connexion

linkly status
Retourne l’état de fonctionnement de Linkly AI Desktop, le numéro de version, le nombre de documents indexés et l’état de l’indexation.

​
Rechercher des documents

linkly search "mots-clés ou expression"
Recherche dans vos documents locaux et retourne la liste des résultats les plus pertinents, incluant le titre, le chemin, la pertinence et un extrait du contenu. Paramètres courants : 
# Limiter le nombre de résultats (par défaut 20, maximum 50)
linkly search "conception API" --limit 5

# Filtrer par type de document
linkly search "compte-rendu de réunion" --type pdf,docx

# Sortie au format JSON (adapté au traitement par script)
linkly search "rapport budgétaire" --json

​
Consulter le sommaire d’un document

linkly outline <DOC_ID>
Obtient le sommaire structuré et les métadonnées d’un document. Le DOC_ID est récupéré depuis les résultats de recherche. Vous pouvez consulter plusieurs documents à la fois : 
linkly outline id1 id2 id3
La fonctionnalité de sommaire est optimale pour les documents Markdown et DOCX, dont la structure de titres peut être analysée. Pour le texte brut ou les PDF sans signets, il est recommandé d’utiliser directement la commande read.

​
Lire le contenu d’un document

linkly read <DOC_ID>
Lit le contenu complet d’un document, avec des numéros de ligne. Pour les documents longs, vous pouvez lire par pages : 
# À partir de la ligne 50, lire 100 lignes
linkly read <DOC_ID> --offset 50 --limit 100
Stratégie de pagination : Par défaut, chaque lecture récupère 200 lignes (maximum 500). Pour les documents longs, ajustez --offset pour lire progressivement : 
linkly read <DOC_ID> --offset 1 --limit 200    # Lignes 1-200
linkly read <DOC_ID> --offset 201 --limit 200  # Lignes 201-400
linkly read <DOC_ID> --offset 401 --limit 200  # Lignes 401-600

​
Mode MCP

linkly mcp
Fonctionne en mode serveur MCP stdio, exposant les outils de Linkly AI aux clients IA compatibles MCP. Configurer Claude Desktop et d’autres applications IA locales : Ajoutez le contenu suivant au fichier de configuration de Claude Desktop ou d’autres applications :
Éditez ~/.config/Claude/claude_desktop_config.json :
{
  "mcpServers": {
    "linkly-ai": {
      "command": "linkly",
      "args": ["mcp"]
    }
  }
}
Configurer Cursor : Dans Cursor, ouvrez Settings → MCP Servers → Add Server, et ajoutez :
  • Name: linkly-ai
  • Command: linkly mcp

​
Mettre à jour le CLI

linkly self-update
Vérifie et met à jour automatiquement vers la dernière version. Le CLI vérifie également les mises à jour en arrière-plan à chaque démarrage ; si une nouvelle version est disponible, il vous invitera à exécuter cette commande.

​
Description des paramètres

​
Options globales

OptionDescription
--endpoint <URL>Spécifier le point de terminaison MCP (par défaut, découverte automatique via ~/.linkly/port)
--jsonSortie au format JSON (adapté aux scripts et à l’automatisation)
-V, --versionAfficher la version du CLI
-h, --helpAfficher l’aide
ParamètreDescriptionValeur par défaut
<QUERY>Mots-clés ou expression de recherche (obligatoire)—
--limit <N>Nombre maximum de résultats retournés20
--type <TYPES>Filtrer par type de document (séparés par des virgules)Tous

​
Paramètres de outline

ParamètreDescriptionValeur par défaut
<ID...>ID du document (obligatoire, plusieurs possibles)—

​
Paramètres de read

ParamètreDescriptionValeur par défaut
<ID>ID du document (obligatoire)—
--offset <N>Numéro de ligne de départ (à partir de 1)1
--limit <N>Nombre de lignes à lire (maximum 500)200