跳转到主要内容

​
Linkly AI CLI 介绍

Linkly AI CLI 是一个命令行工具，通过连接 Linkly AI Desktop 的 MCP 服务，让你在终端中搜索、浏览和阅读本地文档。它同时也是 AI Agent（如 Claude Desktop、Cursor）与 Linkly AI 之间的桥梁。

终端搜索

在命令行中直接搜索你的文档，适合开发者和极客用户

MCP 桥接

以 stdio MCP 模式运行，让 Claude Desktop、Cursor 等 AI 工具调用 Linkly AI

​
安装

在终端中运行：
curl -sSL https://updater.linkly.ai/cli/install.sh | sh
安装完成后，验证安装： 
linkly --version
CLI 运行前需要先启动 Linkly AI Desktop 应用，CLI 会通过 ~/.linkly/port 文件自动发现并连接桌面应用的 MCP 服务。

​
使用方法

CLI 遵循 search → outline → read 的渐进式工作流：先搜索找到目标文档，再查看大纲了解结构，最后阅读具体内容。

​
检查连接状态

linkly status
返回 Linkly AI Desktop 的运行状态、版本号、已索引文档数量和索引状态。

​
搜索文档

linkly search "关键词或短语"
搜索你的本地文档，返回最相关的结果列表，包含标题、路径、匹配度和内容摘要。 常用参数： 
# 限制返回数量（默认 20，最多 50）
linkly search "API 设计" --limit 5

# 按文档类型过滤
linkly search "会议纪要" --type pdf,docx

# 输出 JSON 格式（适合脚本处理）
linkly search "预算报告" --json

​
查看文档大纲

linkly outline <DOC_ID>
获取文档的结构化大纲和元数据。DOC_ID 从搜索结果中获取。支持一次查看多个文档： 
linkly outline id1 id2 id3
大纲功能对 Markdown 和 DOCX 文档效果最好，这些格式的标题结构可以被解析。对于纯文本或无书签的 PDF，建议直接使用 read 命令。

​
阅读文档内容

linkly read <DOC_ID>
阅读文档的完整内容，输出带有行号的文本。对于长文档，可以分页阅读： 
# 从第 50 行开始，读取 100 行
linkly read <DOC_ID> --offset 50 --limit 100
分页策略： 默认每次读取 200 行（最多 500 行）。对于长文档，通过调整 --offset 逐步读取： 
linkly read <DOC_ID> --offset 1 --limit 200    # 第 1-200 行
linkly read <DOC_ID> --offset 201 --limit 200  # 第 201-400 行
linkly read <DOC_ID> --offset 401 --limit 200  # 第 401-600 行

​
MCP 模式

linkly mcp
以 stdio MCP 服务器模式运行，将 Linkly AI 的工具暴露给 MCP 兼容的 AI 客户端。 配置 Claude Desktop 等本地 AI 应用： 将以下内容添加到 Claude Desktop 等应用的配置文件中：
编辑 ~/.config/Claude/claude_desktop_config.json：
{
  "mcpServers": {
    "linkly-ai": {
      "command": "linkly",
      "args": ["mcp"]
    }
  }
}
配置 Cursor： 在 Cursor 中打开 Settings → MCP Servers → Add Server，添加：
  • Name: linkly-ai
  • Command: linkly mcp

​
更新 CLI

linkly self-update
自动检查并更新到最新版本。CLI 在每次启动时也会在后台检查更新，如有新版本会提示你运行此命令。

​
参数说明

​
全局选项

选项说明
--endpoint <URL>指定 MCP 端点（默认自动从 ~/.linkly/port 发现）
--json以 JSON 格式输出（适合脚本和自动化）
-V, --version显示 CLI 版本号
-h, --help显示帮助信息

​
search 参数

参数说明默认值
<QUERY>搜索关键词或短语（必填）—
--limit <N>最大返回结果数20
--type <TYPES>按文档类型过滤（逗号分隔）全部

​
outline 参数

参数说明默认值
<ID...>文档 ID（必填，支持多个）—

​
read 参数

参数说明默认值
<ID>文档 ID（必填）—
--offset <N>起始行号（从 1 开始）1
--limit <N>读取行数（最多 500）200