Skip to content

Latest commit

 

History

History
79 lines (48 loc) · 8.68 KB

desktop-guide.zh-CN.md

File metadata and controls

79 lines (48 loc) · 8.68 KB

WebCodex Desktop 使用指南

English | 简体中文

Desktop 负责准备本机项目和管理连接;你在 ChatGPT 等 AI 客户端中发起工作。首次安装、Tunnel 配置和系统权限请看安装与连接指南。

第一次使用

  1. 在欢迎页选择 在此电脑使用 WebCodex。这是普通个人使用的推荐入口。
  2. 点击 选择文件夹,选择真正要交给 AI 使用的项目。页面首先展示项目路径;确认无误后点击 配置 WebCodex。
  3. Tunnel 配置检测位于 可选:检查 ChatGPT 安全隧道配置 中。在此填写 Tunnel ID 和 API key 后点击“保存配置”,即可优先使用本机配置文件,无需重启。没有 Tunnel 配置也可以先准备本机项目;配置齐全时,可勾选配置后连接 ChatGPT。
  4. 回到首页,确认当前项目路径与实际工作目录一致。首页的三个步骤依次是 准备项目 → 连接 AI 客户端 → 开始使用。
  5. 点击侧栏的 连接。选择 OpenAI Secure Tunnel 后,再点击 启动安全隧道。仅选择连接方式不会启动进程。
  6. 隧道就绪后,按照连接页指引在 ChatGPT 中填入 Tunnel ID,再执行一次真实项目读取。

本地隧道就绪不等于 ChatGPT 已连接。 首页会保留等待验证的状态;只有观察到当前项目的真实调用,才显示使用已验证。

如果已有远程 Server,欢迎页选择 连接现有 Server,填写地址和配对码,再选择本机项目。Desktop 连接页会显示远程 Server 信息,外部连接由 Server 管理者负责。

如果只想临时使用一个项目,选择 快速共享项目,再选择连接提供方。Quick Share 是独立的临时使用方式;首页提供连接交接信息和停止入口。

每天从首页开始

首页优先显示整体状态、下一步操作和当前工作项目。运行环境停止时可点击 启动;本机项目已就绪且 Tunnel 配置齐全时可点击 启动安全隧道。

  • 当前工作项目:展示项目名和完整路径。本机 Full Runtime 已配置时,点击 选择其他项目 或 添加项目 会直接打开目录选择器,并立即应用这个精确项目,不再需要第二次点击“配置 WebCodex”。
  • 三个步骤:区分项目就绪、连接准备和实际使用验证;完成后默认折叠。
  • 查看运行诊断:按需展开 Service、Runner、项目和连接的详细状态及运行控制。
  • 侧栏导航:进入项目、连接、扩展、活动和设置页面;首页也提供连接和扩展的直接入口。
  • 项目 → 此 Runner 保存的目录:显示同一 Runner 下之前选择的精确项目根目录。可以切换或添加文件夹,无需另配 MCP 应用;选择一个项目不会撤销其他项目。列表按保存的 Runner 配置隔离。

切换项目无需先手工停止 Runtime,也无需断开 OpenAI Secure Tunnel。Desktop 会把所选项目的精确根目录加入 Runner policy,在兼容 Runner 上热激活并持久化当前选择,同时保留现有 Service 和 Tunnel;只有旧版或不兼容 Runner 才可能刷新 Desktop 自己管理的 Runner。不要通过扩大允许目录来解决项目加载失败。

连接与故障恢复

连接页靠前位置始终显示 Tunnel 连接配置。普通 Tunnel 运行中或停止后均可编辑 ID 与只写 API key。保存后,仅替换本应用正在管理的普通 Tunnel,Server 和 Runner 保持运行;原先停止的 Tunnel 不会因保存而自动启动。API key 留空保留已保存密钥,密钥不会回传到界面。

保存和重新连接是两个结果。替换失败时明确提示 配置已保存,但 Tunnel 尚未恢复:应重试连接,无需重复输入已保存密钥。旧进程清理未确认时保留所有权及重试能力,不会虚报已停止。Quick Share 仍是独立的临时连接,新凭据在其下次启动时使用。

观察到真实项目调用,只能验证曾经使用过,不能证明宿主此刻在线。尚未观察到调用或无法观测时显示“未验证”,不据此断言 ChatGPT 已断开。

看到的情况 下一步
本机运行环境未就绪 回首页恢复运行环境;需要时重新配置同一个项目
Tunnel ID 或 API key 未检测到 在配置区填写并保存 Tunnel ID 和 API key;仅使用环境变量时才需退出重开
启动失败且没有活动隧道 保留当前选择,修复配置或网络后再次点击启动
已有隧道报错 点击停止,成功后重新启动;停止失败会保留错误和重试入口
隧道就绪但剪贴板交接失败 在连接页重试“复制 Tunnel ID”,或选中 ID 手动复制,无需重启
隧道就绪,等待 ChatGPT 在 ChatGPT 配置 Tunnel,并列出所选项目的顶层文件(空目录也可作为结果)

设置 → OpenAI Tunnel 网络 管理自动、直连和自定义 HTTP 代理。更改运行中隧道的代理前先停止隧道,保存后再启动。

指令、Skills 与原生 Tool Plugins

扩展 显示所选项目约定的 AGENTS.md 路径、全局指令文件、Skill 根目录,以及配置中保存的原生 Plugin ID。显示路径不表示文件一定存在;请用项目编辑器修改 AGENTS.md 内容。全局指令文件和 Skill 根目录各支持最多 16 个绝对路径。保存绑定到读到的精确 Runner 配置,拒绝过期编辑,保留其他配置、注释、凭据及已有插件设置。

添加原生 Tool Plugin 可填写新插件 ID、名称、可执行程序、字符串数组形式的参数,以及可选的绝对工作目录。不会覆盖已有 ID;参数仅写入,提交后清空。凭据请使用配置中的 profile。注册列表不代表实时连接状态;已有插件的编辑、移除及高级字段仍通过页面展示的 Runner 配置文件管理。

保存设置不会启动插件或偷偷重启 Runner。重启本应用管理的 Runner 是显式操作,会中断该 Runner 当前工作,但保留 Server 和普通 Tunnel。独立运行的 Runner 必须由其实际管理者重启。

macOS 权限引导

首次前台启动且 Desktop 权限不全时,会显示权限说明,提供请求辅助功能、请求屏幕录制和稍后继续入口。后台登录启动不会弹出对话框抢占其他应用焦点。系统权限请求必须由按钮触发;拒绝或跳过不影响普通项目操作。授权后可在设置页重新检测。

Desktop 的授权结果不等于独立 Runner 已获授权。Computer Use 实际在 Runner 中执行,应为 macOS 显示的实际进程授权,并按系统提示重启。未观测到的 Runner 授权状态不会被显示为已授权。Windows 不显示 macOS 专属权限按钮。

活动、设置和后台运行

本机 Server 在启动期间退出时,可展开错误提示中的 详情。Desktop 会显示可用的退出码;识别到 HTTP 监听绑定失败时,还会显示监听地址和系统错误码,例如 127.0.0.1:54611 和 os error 10013。诊断从有大小上限的进程输出中提取,不展示任意原始日志,也不改变端口选择或恢复行为。

活动 按最新在前显示操作记录。可搜索内容或来源,也可选择 只看警告和错误;筛选不会删除记录。

设置 包含语言、登录时启动、macOS Computer Use 权限、Tunnel 网络和诊断信息。语言也可以在左下角直接切换。支持简体中文、English、日本語、한국어、Deutsch、Français;选择会保存,重开后恢复,活动时间按所选语言格式显示。系统托盘菜单和原始后端诊断仍使用英文,系统文件选择器的语言由操作系统决定。

关闭窗口只是隐藏到菜单栏或系统托盘,已启动的运行环境仍在后台工作。托盘中的 退出 WebCodex 才会结束 Desktop 及其管理的进程。首页的 停止 Desktop 管理的运行环境 会停止运行环境并更新保存的启动偏好;这些操作不会终止其他自行启动的 WebCodex 进程。

macOS 使用 ⌘ + 1–6,Windows 使用 Ctrl + 1–6,依次切换首页、项目、连接、扩展、活动和设置。这些导航快捷键在输入框和语言选择框内同样生效,普通输入及复制、粘贴等文本编辑快捷键不受影响。可用 Tab 聚焦按钮,用 Enter 激活;诊断折叠项也支持键盘操作。

首页的运行控制和设置页的技术诊断默认折叠。主动停止后显示“已停止”,点击“启动”继续。活动页优先显示操作结果,勾选“显示进程详情”查看常规进程事件。Tunnel ID 和密钥在连接页配置;API key 不回显。