OpenSquilla 文档

本目录是面向用户的产品文档集，配合根目录的发版 README，提供以任务为导向的使用指南。

优先阅读

1. quickstart.md —— 安装、配置、运行，并打开 Web UI。
2. use-cases.md —— 针对常见目标的任务式用法食谱。
3. gateway.md —— gateway 的生命周期、host/port、安全与状态。
4. configuration.md —— provider、router、search、channel、 memory、权限等的配置说明。
5. cli.md —— 命令分组与常用 CLI 工作流。
6. web-ui.md —— 本地控制台与对话 UI。
7. sessions.md —— 会话连续性、导出、恢复、终止与清理。
8. glossary.md —— 面向用户的术语表。

功能指南

• features.md —— 能力目录。
• features/squilla-router.md —— 模型路由。
• features/tui-frontend.md —— 终端流式输出、 插件槽位、Router HUD 与 TUI 后端评估。
• features/tool-compression.md —— 工具结果 与句柄的紧凑压缩。
• features/meta-skills.md —— 可复用工作流 MetaSkill。
• features/meta-skill-user-guide.md —— 面向用户的 MetaSkill 使用指南。
• authoring/meta-skills.md —— MetaSkill 编写指南。
• features/memory.md —— 持久记忆与召回。
• features/skills.md —— Skill 发现、安装与编写。
• features/compaction-and-cache.md —— 长会话 compaction 与 prompt-cache 连续性。

接入面与运维

• releases/0.4.0.md —— OpenSquilla 0.4.0 发版说明。
• releases/0.3.0.md —— OpenSquilla 0.3.0 发版说明。
• channels.md —— 支持的消息 channel 及接入流程。
• providers-and-models.md —— LLM provider 目录、 模型选择、以及基于 runtime 的模型查看方式。
• search.md —— Web 搜索 provider 与查询工作流。
• artifacts-and-media.md —— artifact、生成文件、 图片、PDF 与 TTS。
• tools-and-sandbox.md —— 内置工具、审批、沙箱姿态 与写入策略。
• approvals-and-permissions.md —— 权限模板、 审批命令、工作区隔离与沙箱姿态。
• agents.md —— 命名持久 Agent 与工作区默认设置。
• scheduling.md —— 周期性与一次性任务调度。
• mcp-server.md —— 面向 MCP 客户端的 MCP server 桥接。
• usage-and-cost.md —— Token 用量、估算成本与成本排查 工作流。
• diagnostics-and-replay.md —— 诊断、原始抓取 指南与只读 turn 回放。
• tui-real-terminal-harness.md —— 真实终端 TUI 的启动、回放与证据采集。
• operations.md —— sessions、cron、用量、诊断、迁移、 MCP server 与安装清单等命令。
• troubleshooting.md —— 常见安装/运行问题。
• glossary.md —— 产品名词的简短定义。

改进这套文档

欢迎贡献文档改进。先看 contributing-docs.md 里的文档专属指南，然后对着 main 提一个小 PR。在分支切换期间，已有的 dev PR 仍可继续。

快捷通道：

• 用文档 issue 模板 报告过期命令、断链或令人困惑的页面。
• 在 GitHub 上直接编辑相关 Markdown 页面，并对 main 提一个聚焦的 PR。
• 新功能文档请把独立的功能放进 docs/features/ 下的独立页面。

设计原则

OpenSquilla 文档首先要让用户跑通产品，其次再讲清产品的特别之处。重机制的 runtime 细节应放在开发者设计笔记或源码注释里，而不是首次上手路径上。

产品指南 · 改进这套文档 · 报告文档问题 · 贡献指南