> ## Documentation Index
> Fetch the complete documentation index at: https://linkly.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 快速开始

> 跟随本文档，几分钟完成 Linkly AI 的安装和集成

本快速开始指南，将在几分钟内让您使用 Linkly AI 构建您的第一个AI-ready 的本地知识库，将了解基本的使用方法。

## 开始前

Linkly AI包含了以下核心应用和能力：

<CardGroup cols={2}>
  <Card title="Linkly AI Desktop" icon="desktop" iconType="duotone">
    桌面应用程序（简称 Linkly
    AI），安装后自动创建索引文档，并提供检索、大纲、读取等工具。
  </Card>

  <Card title="Linkly AI CLI" icon="terminal" iconType="duotone">
    命令行工具，可在 Bash 中连接你的 Linkly AI 应用并调用其工具，适合 AI Agent
    使用。
  </Card>

  <Card title="MCP Server" icon="plug" iconType="duotone">
    Agent 获取上下文的开放协议。安装 Linkly AI 后自动启动 MCP 服务，适合 AI
    Agent 调用。
  </Card>

  <Card title="linkly-ai-skills" icon="wand-magic-sparkles" iconType="duotone">
    官方提供的 Agent Skills，指导 Agent 如何连接和使用 Linkly AI
    的工具服务，强烈建议安装。
  </Card>
</CardGroup>

## 步骤 1：安装Linkly AI

前往官网下载页面，根据您的操作系统，选择对应版本：

<Card title="下载 Linkly AI" icon="download" href="https://linkly.ai/#download">
  选择适合你操作系统的版本
</Card>

然后双击安装包安装，不同平台的安装步骤如下：

<Tabs>
  <Tab title="macOS" icon="apple">
    <Steps>
      <Step title="打开安装包">双击下载的 `.dmg` 文件，挂载磁盘映像</Step>

      <Step title="拖入应用程序">
        将 **LinklyAI** 图标拖入 **Applications** 文件夹
      </Step>

      <Step title="启动应用">
        在 Launchpad 或 Finder 的 Applications 文件夹中找到
        **LinklyAI**，双击启动
      </Step>
    </Steps>
  </Tab>

  <Tab title="Windows" icon="windows">
    <Steps>
      <Step title="运行安装程序">双击下载的 `.exe` 安装文件</Step>
      <Step title="完成安装">按照安装向导提示完成安装，默认安装到用户目录</Step>
      <Step title="启动应用">从开始菜单或桌面快捷方式启动 **LinklyAI**</Step>
    </Steps>
  </Tab>

  <Tab title="Linux" icon="linux">
    <Steps>
      <Step title="AppImage 方式">
        `bash chmod +x LinklyAI-*.AppImage ./LinklyAI-*.AppImage `
      </Step>

      <Step title="或 DEB 包方式">
        `bash sudo dpkg -i linkly-ai-*.deb `
      </Step>
    </Steps>
  </Tab>
</Tabs>

## 步骤 2：初始化 Linkly AI

首次启动 Linkly AI 时，会出现引导向导，帮助您完成 3 步初始化配置：

<Steps>
  <Step title="选择要索引的目录">
    选择你希望 Linkly AI 索引的文档目录：

    * **我的文档**：仅索引 `~/Documents`或者`我的文档` 目录下的所有文档
    * **整台电脑**：扫描所有可访问的文档，覆盖范围最广，需要授权
    * **自定义文件夹**：手动选择一个指定的文件夹
  </Step>

  <Step title="检查访问权限">
    系统会自动检查所选文件夹的访问权限。如果权限不足（常见于 macOS），需要前往 **系统设置 → 隐私与安全性 → 完全磁盘访问权限**，添加 Linkly AI，然后重启应用。
  </Step>

  <Step title="连接你的 AI 工具">
    将 Linkly AI 的 MCP 服务添加到你常用的 AI 工具中，实现智能文档搜索。

    <Card>
      我们建议您使用 Skills 来辅助集成，这是最简单的方式，只需复制以下 Prompt 到你的 AI 助理中，按提示操作即可同时完成工具和 Skills 的集成：

      <Prompt description="请帮我安装 Agent Skill linkly-ai-skills， 并...">
        请帮我安装 Agent Skill linkly-ai-skills， 并完成 LinklyAI 的工具集成，参考：[https://linkly.ai/docs/zh/use-skills](https://linkly.ai/docs/zh/use-skills)
      </Prompt>
    </Card>

    也可以选择手动集成 MCP 工具，但我们仍然建议您[安装 Skills](use-skills) 来获得更好的使用体验：

    <Tabs>
      <Tab title="Claude Code">
        在终端中运行：

        ```bash theme={null}
        claude mcp add --transport http linkly-ai http://127.0.0.1:60606/mcp
        ```
      </Tab>

      <Tab title="Cursor">
        1. 打开 Settings → MCP Servers → Add Server
        2. Name: `linkly-ai`
        3. Type: `StreamableHTTP`
        4. URL: `http://127.0.0.1:60606/mcp`
      </Tab>

      <Tab title="Codex">
        在终端中运行：

        ```bash theme={null}
        codex mcp add linkly-ai --url http://127.0.0.1:60606/mcp
        ```
      </Tab>

      <Tab title="Cherry Studio">
        1. 打开 Settings → MCP Servers → Add
        2. Name: `linkly-ai`
        3. Type: `StreamableHTTP`
        4. URL: `http://127.0.0.1:60606/mcp`
      </Tab>
    </Tabs>

    <Tip>其中 `60606` 为 Linkly AI 的 MCP 服务默认端口号，如果无法连接可在应用设置中查看实际端口号。</Tip>
  </Step>
</Steps>

## 步骤3：首次使用

应用启动后，Linkly AI 会立即开始索引你的文档并持续监控，在几分钟到几十分钟之间将完成全部索引（取决于文档数量和机器性能）。

<Note>
  首次启动需要下载一个 100M 左右的模型文件，可能需要几分钟到几十分钟不等，但不影响关键词检索功能的使用。

  下载完毕并完成全部索引后，即可使用自然语言检索功能。
</Note>

你有两种方式使用 LinklyAI：

<Card title="使用启动器检索文档" icon="keyboard">
  你可以在托盘中点击应用图标（L Logo），或者使用全局快捷键 `CMD/Crtl + Shift + L`，打开检索启动器窗口，输入关键词或者描述性语言，查找目标文档。

  还可以进一步预览、查看元信息、打开文档、复制链接等，更多使用帮助查看[全文检索启动器文档](use-launcher)。
</Card>

<Card title="借助 AI Agent 使用" icon="robot">
  这是我们更推荐的方式，你将获得前所未有的交互体验和研究效率。

  在完成与你的 AI 助理集成或安装 [Skills](use-skills) 后，在任意 Prompt 之后跟随 `use linkly-ai`，来主动使用 Linkly AI 强大的检索能力。
</Card>