文档
按任务找到对应指南。
Sigil 保持 README 作为简洁入口,把操作细节拆到聚焦文档里。本页是用户文档的稳定入口。
用户文档
先按任务选择路径,再用参考文档查细节。
从这里开始
安装与更新
通过 npm、Homebrew、Cargo git tag、源码 checkout 或 release archive 安装,并在需要时更新或卸载已有 binary。
首次运行完成第一个任务
在 workspace 启动 Sigil,完成 Quick Setup,运行 doctor,并完成第一个安全编辑。
日常工作在 TUI 中工作
在日常仓库工作中使用 composer、计划、verification 证据、checkpoint recovery、context controls、session 和 transcript 控制。
使用 Sigil
常见工作流
探索仓库、做小改动、计划任务、调试失败、review diff 和恢复工作时可直接套用的提示词。
提示词Cookbook
用于仓库探索、文档编辑、review、调试、planning、MCP 和终端问题的可复制 prompt。
预览视觉导览
在第一个仓库任务前,了解主会话、approval、配置、verification、checkpoint recovery 和 compaction preview 界面。
控制权安全与权限
什么能运行、什么需要审批,如何 review diff,以及 workspace/MCP trust 边界如何工作。
运行环境配置
Config 解析、permissions、appearance、agents、skills、plugins、verification、code intelligence、terminal 集成和示例。
模型Provider 指南
选择并配置 DeepSeek、OpenAI-compatible、OpenAI Responses、Anthropic 或 Gemini provider,包含 key 优先级和排障路径。
集成MCP 接入指南
配置本地 stdio 或用户根 Streamable HTTP MCP server,理解 trust level,并用显式策略约束外部数据和 secret。
参考与支持
文档路径地图
按首次使用、日常工作流、配置、排障、集成和参考资料找到最短阅读路径。
数据隐私与数据
Provider context、MCP egress、API keys、本地 session logs、doctor output 和分享建议。
修复问题排障指南
诊断 setup、认证、workspace、approval、terminal、session、MCP 和 code-intelligence 问题。
查阅参考
集中查看命令、键位、config 解析、重要路径、环境变量、approval 和恢复事实。
终端行为Terminal 兼容性
渲染、鼠标、剪贴板、alternate screen 行为和本地 smoke test 检查清单。
支持状态当前支持
用户今天可以依赖什么、哪些属于有限或高级用法、哪些仍是未来 packaging work。
版本说明用户 Changelog
面向用户的能力和文档变化,不混入只对实现有意义的细节。
反馈提交问题
通过 GitHub issue chooser 提交 bug、功能建议或文档问题。