On this page
Sigil User Docs
Sigil is a TUI-first coding agent. This page is a compact map of the user documentation; it intentionally does not repeat release versions, install commands, or provider credentials. Follow the linked guide that owns each topic for current details.
These docs track main, while the packaged alpha is v0.0.1-alpha.4. Check Unreleased for features added after that release.
Start Here
If you are new to Sigil, read these guides in order:
- Quickstart: use the recommended npm alpha path, launch the TUI, complete Quick Setup, and run a first useful session.
- Installation: choose an install channel or find the authoritative update, uninstall, and release-archive instructions.
- Visual tour: see the main session, approval review, configuration, verification, checkpoint recovery, and compaction preview surfaces.
- TUI user guide: learn the screen layout, controls, image input, attention notifications, sessions, approvals, planning, verification, recovery, context controls, and code intelligence.
- Safety and permissions: understand what can run, what needs approval, and how to review risky actions.
- Troubleshooting: diagnose setup, authentication, terminal, MCP, code-intelligence, and recovery problems.
Choose By Task
| I want to... | Read |
|---|---|
| Try Sigil for the first time | Quickstart |
| Install, update, or uninstall Sigil | Installation |
| See what the product looks like | Visual tour |
| Learn the TUI and session workflow | TUI user guide |
| Follow practical coding-task patterns | Common workflows |
| Reuse copyable prompt patterns | Cookbook |
| Configure shared workspace, permission, task, terminal, or tool behavior | Configuration |
| Choose a provider or configure provider authentication | Provider guide |
| Understand approvals, workspace boundaries, and MCP trust | Safety and permissions |
| Understand privacy, provider context, session logs, and secrets | Privacy and data handling |
| Add external tools through MCP | MCP guide |
| Look up commands, keys, paths, and recovery facts | Reference |
| Validate attention notifications, image clipboard input, mouse capture, OSC52 copy, tmux, SSH, or WSL behavior | Terminal compatibility |
| Fix a problem or report a bug | Troubleshooting |
| Check current support commitments | Supported today and future work |
| Read user-facing release notes | User changelog |
Maintainer Documentation
These pages describe the user-facing product. Architecture, implementation, and contribution constraints live in the repository under dev/docs, dev/governance, and AGENTS.md.