> ## 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.

# 在 Codex 中使用 Linkly AI

> 将 Linkly AI 本地知识库集成到 OpenAI Codex CLI，为命令行 AI 助手提供文档支持

## 前置条件

* 已安装 [Codex CLI](https://github.com/openai/codex)
* Linkly AI Desktop 已启动，MCP 服务正在运行

## 配置步骤

<Tabs>
  <Tab title="MCP HTTP（推荐）" icon="globe">
    在终端中运行：

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

  <Tab title="MCP Stdio" icon="terminal">
    需要先[安装 Linkly AI CLI](/docs/zh/use-cli)，然后运行：

    ```bash theme={null}
    codex mcp add linkly-ai -- linkly mcp
    ```
  </Tab>

  <Tab title="CLI" icon="square-terminal">
    需要先[安装 Linkly AI CLI](/docs/zh/use-cli)。安装后，Codex 可以直接调用 CLI 命令来搜索和阅读你的文档：

    ```bash theme={null}
    linkly search "关键词"
    linkly read <document-id>
    ```
  </Tab>
</Tabs>

<Tip>
  建议同时安装 [Linkly AI Skills](/docs/zh/use-skills)，教会 AI 助手如何高效地使用
  Linkly AI 的工具，提升搜索和阅读效率。
</Tip>

## 验证连接

添加成功后，在 Codex 中发送以下提示词验证：

```
搜索我的文档中关于项目设计的内容
```

如果配置正确，Codex 会调用 Linkly AI 的工具并返回搜索结果。

## 常见问题

<AccordionGroup>
  <Accordion title="无法连接 MCP 服务">
    请检查 Linkly AI Desktop 是否已启动，MCP 服务是否正在运行。端口默认为
    60606，可在 Linkly AI 设置中确认。
  </Accordion>
</AccordionGroup>
