跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://openyida.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Codex 是 OpenAI 推出的 AI 编程环境。OpenYida 对 Codex 做了原生插件级集成 — 安装后自动注册为 Codex 本地插件，在 @ 菜单中直接出现「宜搭」入口，同时内置 MCP Server 提供工具调用能力。这是所有支持的 IDE 中集成最深的一个。

​
一次性准备

1

安装 OpenYida

确保已有 Node.js ≥ 18，然后运行：
npm install -g openyida
安装完成后会自动：
  • 将 OpenYida 注册为 Codex 本地插件（出现在 @ 菜单中）
  • 配置 MCP Server（AI 可直接调用宜搭工具）
  • 注入完整技能包
2

告诉 AI 登录宜搭

打开 Codex，直接说：
帮我登录宜搭
AI 会打开本地浏览器完成登录。如果你属于多个组织，Codex 会弹出原生选择控件让你选。
安装完就能用了。OpenYida 在 Codex 中是「插件级公民」—— 你甚至不需要知道 CLI 的存在。

​
使用方式

​
方式一：@ 菜单（推荐）

在 Codex 对话框中输入 @，会看到「宜搭」选项。点击后 AI 自动进入宜搭开发模式： 
@宜搭 帮我创建一个项目管理系统

​
方式二：直接对话

不用 @ 也可以，只要提及「宜搭」相关关键词，AI 就会自动使用 OpenYida 插件： 
在宜搭上搭建一个员工培训管理系统，包含课程表、报名表和考核成绩表

​
模型说明

Codex 使用 OpenAI 内置模型，无需手动配置。模型对工具调用和代码生成都有很好的支持。

​
开始构建

一些示例对话： 
帮我创建一个 CRM 客户关系管理系统：
- 线索管理：姓名、公司、电话、来源、跟进状态
- 客户档案：关联线索、行业、年收入、客户经理
- 商机跟踪：关联客户、金额、阶段、预计成交日期

给我的应用添加一个数据统计看板，展示本月商机总金额和成交率

帮我配置一个审批流程：请假超过 3 天需要部门经理审批

​
实际对话示例

你：@宜搭 做一个差旅报销系统 AI：好的，我来创建差旅报销系统。 ✓ 已创建应用「差旅报销管理」 ✓ 已创建「出差申请」表单：申请人、目的地、出发日期、返回日期、事由 ✓ 已创建「费用报销」表单：关联出差申请、费用类型（子表单）、总金额、附件 ✓ 已配置审批流程：部门经理 → 财务 应用链接：https://www.aliwork.com/APP_XXXXX/… 需要我再做一个报销统计看板吗？

​
Codex 独有能力

相比其他 IDE，OpenYida 在 Codex 中有几个独有优势：

原生插件

注册在 Codex 插件系统中，而非仅仅是技能文件。AI 对 OpenYida 的理解更深入。

MCP 内置

自动配置 MCP Server，AI 可以通过结构化工具调用与宜搭交互，而不只是执行命令。

@ 菜单入口

在 @ 菜单中直接选择「宜搭」，一键进入应用开发模式。

原生组织选择

多组织场景下，通过 Codex 原生 UI 控件选择目标组织，体验更流畅。

​
常见问题

确认 OpenYida 已正确安装：openyida --version。如果安装后仍不显示，重启 Codex 让它重新扫描插件。也可以手动检查插件目录：
ls ~/.openyida/codex-plugin/plugins/openyida/.codex-plugin/plugin.json
如果你只属于一个宜搭组织，会自动选中。多组织时才会弹出选择控件。
告诉 AI「宜搭登录好像过期了」，它会自动重新触发登录流程。
npm install -g openyida@latest
更新后 Codex 插件也会自动更新。