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

# 安装 Codex 插件

> 使用网站离线包或已授权的 GitHub 仓库安装 Skill 与远程 MCP 连接。

把 Open Study 插件装进 Codex，再连接你的网站账号，就能在新对话里整理链接和查找资料。不需要在电脑上再部署 Open Study 服务。

## 安装前先检查

这篇适用于支持插件的 **Codex 桌面端或 Codex CLI**，不是 IDE 扩展里的通用安装教程。插件使用与“安装后新建任务”的通用说明可查看 [OpenAI 官方插件文档](https://learn.chatgpt.com/docs/plugins)。

下面的安装器需要你在终端运行命令。**安装了桌面应用，不一定代表终端里的 Codex 命令已经可用。**

<Tabs>
  <Tab title="macOS / Linux">
    在终端依次运行：

    ```bash theme={null}
    codex --version
    codex plugin --help
    python3 --version
    ```

    前两条应显示 Codex 版本和插件帮助，第三条应显示 Python 3 版本。
  </Tab>

  <Tab title="Windows">
    在 PowerShell 依次运行：

    ```powershell theme={null}
    codex --version
    codex plugin --help
    ```

    应显示 Codex 版本和插件帮助。Windows 安装器不要求额外运行 Python。
  </Tab>
</Tabs>

如果提示 `command not found`、不是可识别的命令，或不认识 `plugin`，先按 [Codex CLI 官方说明](https://developers.openai.com/codex/cli)安装或更新 CLI，然后重新打开终端。macOS / Linux 缺少 Python 3 时，先按 [Python 官方下载说明](https://www.python.org/downloads/)准备工具。检查没通过前，不必反复运行插件安装器。

## 推荐：从网站下载离线包

当前 GitHub 插件仓库处于私有预览，普通用户优先使用网站提供的离线包。

<Steps>
  <Step title="下载并完整解压">
    登录 Open Study，进入 **连接 AI**，展开 **无法访问 GitHub？使用离线包**，下载页面当前提供的版本。把压缩包完整解压到一个准备长期保留的目录。
  </Step>

  <Step title="运行离线安装器">
    打开包含 `install.sh`、`install.ps1` 和 `plugins` 文件夹的那一层目录，再运行本节下面对应系统的命令。不是在压缩包里运行，也不是只取出单个脚本运行。

    macOS 可以在终端输入 `cd` 和一个空格，把完整解压文件夹拖进终端，按回车；Windows 可以在该文件夹的资源管理器地址栏输入 `powershell`，按回车。
  </Step>

  <Step title="新建 Codex 任务">
    安装器明确显示成功后，新建一个 Codex 任务。旧任务不用删除，但它不会自动加载新插件。
  </Step>

  <Step title="完成 Open Study 登录">
    让 Codex 使用 Open Study。需要登录时，在打开的网页使用**与网站相同的账号**登录，再选择 **允许连接**。授权可能发生在安装时，也可能发生在首次调用时。
  </Step>
</Steps>

<Tabs>
  <Tab title="macOS / Linux">
    ```bash theme={null}
    sh ./install.sh --offline
    ```
  </Tab>

  <Tab title="Windows">
    ```powershell theme={null}
    powershell -ExecutionPolicy Bypass -File .\install.ps1 -Offline
    ```
  </Tab>
</Tabs>

<Warning>
  “离线包”只表示安装来源是下载的文件，**使用时仍需要联网**。解压目录是本地插件来源，安装后也请保留，不要移动或删除。更新前先阅读[更新说明](/connect-ai/update-troubleshoot)，不要把它当作能自动更新的 GitHub 安装。
</Warning>

## 从 GitHub 安装

如果你的 GitHub 账号已获得插件仓库访问权限，可以改用 GitHub 来源；没有权限就继续用离线包，不需要反复尝试登录。

<Accordion title="已有仓库权限：GitHub 安装命令">
  正式来源为：

  ```text theme={null}
  moonlight-code-space/open-study-codex-plugin
  ```

  在**完整解压的发布包根目录**运行以下命令。不要混用产品源码中的 `scripts/` 路径：

  <Tabs>
    <Tab title="macOS / Linux">
      ```bash theme={null}
      sh ./install.sh moonlight-code-space/open-study-codex-plugin
      ```
    </Tab>

    <Tab title="Windows">
      ```powershell theme={null}
      powershell -ExecutionPolicy Bypass -File .\install.ps1 moonlight-code-space/open-study-codex-plugin
      ```
    </Tab>
  </Tabs>

  已有离线来源时，安装器会停止并保留旧配置，不会自动迁移。请先看[来源冲突说明](/connect-ai/update-troubleshoot)。
</Accordion>

## 安装完成后的检查

在新任务里复制这句话：

<Prompt description="请检查 Open Study 是否已连接，并查询我的资料库。如果资料库为空，直接告诉我为空，不要创建新任务。" actions={["copy"]}>
  请检查 Open Study 是否已连接，并查询我的资料库。如果资料库为空，直接告诉我为空，不要创建新任务。
</Prompt>

确认 Codex **实际调用了 Open Study 的连接检查和资料库查询，并成功收到结果**。返回已有资料或真实的空列表，都是正常结果；只口头回复“已连接／资料库为空”，但没有成功调用，不算完成检查。

只看到“插件安装成功”还不代表网站已经连接。需要检查新视频的整理时，再按下一篇发送一条你要处理的真实链接。

没有出现插件、网页没有完成连接、或安装器报错时，直接看[按症状排查连接](/connect-ai/update-troubleshoot)。不要把密码、Cookie 或密钥发进聊天。

<Card title="发送第一个真实请求" icon="message-square" href="/connect-ai/use-codex">
  学会什么时候发送链接会创建任务，以及怎样确认最终结果真的保存成功。
</Card>