Documentation
Find the guide for the work.
Sigil keeps the product entrypoint narrow and splits operational detail into focused guides. Use this page as the stable map for user-facing docs.
User guides
Start with a task path, then keep the reference nearby.
Start here
Install and update
Install with npm, Homebrew, Cargo git tags, source checkout, or release archives; update or uninstall an existing binary when needed.
First runComplete your first task
Launch Sigil in a workspace, complete Quick Setup, run doctor, and make the first safe edit.
Daily workWork in the TUI
Use the composer, plans, verification evidence, checkpoint recovery, context controls, sessions, and transcript controls in everyday repository work.
Work with Sigil
Common workflows
Practical prompts for exploring a repo, making changes, planning tasks, debugging failures, reviewing diffs, and resuming work.
PromptsCookbook
Copyable prompt patterns for repository exploration, docs edits, reviews, debugging, planning, MCP, and terminal issues.
PreviewVisual tour
See the main session, approval, configuration, verification, checkpoint recovery, and compaction preview surfaces before your first task.
ControlSafety and permissions
What can run, what needs approval, how to review diffs, and how workspace/MCP trust boundaries work.
EnvironmentConfiguration
Config resolution, permissions, appearance, agents, skills, plugins, verification, code intelligence, terminal integration, and examples.
ModelsProvider guide
Choose and configure DeepSeek, OpenAI-compatible, OpenAI Responses, Anthropic, or Gemini providers with key priority and troubleshooting.
IntegrationsMCP guide
Configure local stdio or user-root Streamable HTTP MCP servers, understand trust levels, and keep external data and secrets under explicit policy.
Reference and support
Documentation map
Find the shortest path from first use to daily workflows, configuration, troubleshooting, integrations, and reference material.
DataPrivacy
Provider context, MCP egress, API keys, local session logs, doctor output, and sharing guidance.
FixTroubleshooting guide
Diagnose setup, auth, workspace, approval, terminal, session, MCP, and code-intelligence issues.
LookupReference
Commands, keys, config resolution, important paths, environment variables, approvals, and recovery facts.
RuntimeTerminal compatibility
Checklist for rendering, mouse behavior, clipboard support, alternate screen behavior, and local smoke testing.
SupportSupported today
What users can rely on now, what is limited or advanced, and what remains future packaging work.
Release notesUser changelog
User-facing capability and documentation changes without implementation-only detail.
FeedbackReport a bug
Open the GitHub issue chooser to report a bug, request a feature, or flag a documentation problem.