SuperAPI AI 工具集

opentui

编程与开发

查看项目

更新于 10-15 16:49

技能介绍

用途:OpenTUI 是构建终端 UI 的参考技能,权威文档位于同级 docs//*.mdx 文件;在仓库中技能根目录为 packages/web/src/content/,从仓库根目录也可在 packages/web/src/content/docs//.mdx 下访问相同文件。终端布局默认:面向终端应用而非浏览器,高效利用可用列与行;相邻面板间不要留间隙;不要添加不必要的边距或内边距;优先紧凑、信息密集的布局,而非网站式卡片间距。路径规则:/docs 映射到 docs/getting-started.mdx;/docs/components 映射到 docs/components/overview.mdx;其余 /docs/<slug> 映射到相对技能根目录的 docs/<slug>.mdx;从仓库根目录访问时,在每个源路径前加 packages/web/src/content/;/docs/releases/<version> 映射到 docs/releases/<version>.md,即该版本的发布说明。版本:文档描述该技能所来自的发布或分支;每个发布说明文件列出该版本变更并链接受影响页面。若项目使用的 @opentui/core 比文档描述的更旧,使用 API 前先阅读更新的发布说明,并优先使用项目版本提供的能力。选择包:可直接使用 Core,或选择 React/Solid 绑定构建 UI;功能契合时可推荐配套包,但不要默认安装所有包。@opentui/core 使用命令式 renderable 与事件,配合 createCliRenderer()。@opentui/react 使用 React 组件、JSX 与 hooks,配合 createRoot()。@opentui/solid 使用 Solid 组件、JSX 与 signals,配合 render()。@opentui/keymap 可跨视图集中管理键盘绑定与具名命令,支持焦点作用域层、可配置快捷键与多键序列,从 @opentui/keymap/opentui 的 createDefaultOpenTuiKeymap() 开始,React/Solid 分别使用 @opentui/keymap/react 或 @opentui/keymap/solid 的 provider 与 hooks;简单本地输入可直接使用键盘事件或组件本地绑定。@opentui/ssh 无需本地安装应用即可向标准 SSH 客户端提供终端 UI,从包根导入 createServer(),将每个会话的 renderer 传给 Core、React 或 Solid;该包没有框架子路径,认证、中间件与会话清理见 SSH 指南。@opentui/qrcode 可编码 QR 矩阵、终端文本或 SVG,或显示 QRCodeRenderable;JSX 中使用 @opentui/qrcode/react 或 @opentui/qrcode/solid 的 registerQRCode()。@opentui/three 可用 ThreeRenderable 在终端渲染 Three.js WebGPU 场景,但仅支持 Bun,选用前需检查其运行时与依赖要求。公共导入完整列表见 Package entry points,包含测试、插件、宿主适配器与运行时模块映射;用 API 与 symbol 索引查找导出;使用公共包入口而非源码深层导入。阅读顺序按领域:入门从 /docs、/docs/getting-started/quickstart、/docs/getting-started/runtime-support 开始;框架见 /docs/bindings/react、/docs/bindings/solid;Core 见 /docs/core-concepts/renderer、layout、keyboard;组件见 /docs/components 及 text、input、image、embedded-terminal;应用 API 见 clipboard、audio、audio-streaming、audio-capture、animation;测试与调试见 testing、troubleshooting;扩展见 plugins/slots、extend/runtime-plugins;keymap 见 /docs/keymap/overview;集成见 reference/ssh、reference/three、reference/qr-encoder;原生见 native/overview;发布见 ship/deploy、reference/standalone-executables;参考见 reference/api-index、package-entrypoints、env-vars、native-image。按意图快速路由:入门、安装、运行时支持、React、Solid、renderer、layout、keyboard、components、text、input、image、embedded-terminal、clipboard、audio、audio-streaming、audio-capture、animation、testing、troubleshooting、plugins、runtime-plugins、keymap、ssh、three、qr、deploy、standalone、api、native、package-exports、env、native-image,均映射到对应 docs 页面。组件请求先读 docs/components/overview.mdx,再打开 docs/components/<name>.mdx;插件槽细节从 docs/plugins/slots.mdx 开始,再打开 Core、React 或 Solid 页面。原生应用按顺序读 docs/native/overview.mdx、docs/native/resources.mdx、docs/native/frames.mdx;docs/native/core.mdx 解释 Core 的 TypeScript 集成,非原生语言 API;Session 时钟、终端投递与原生文件操作读 docs/native/host-io-time.mdx,然后按需选 docs/native/c.mdx 或 docs/native/zig.mdx。工作规则:先读入口页,再读任务对应的更窄的权威页面;直接读取同级 docs/**/.mdx 文件,不要将其内容复制进本文件;文档页间引用使用规范 /docs URL,本文件内链接使用对应的相对 docs/**/*.mdx 路径。