简体中文

On this page

Quickstart

This path installs Sigil, opens a real repository, and ends after one reviewed change. Other package, update, and uninstall paths belong in Installation.

Before You Begin

You need a modern terminal, Node.js with npm, a model-provider credential, and a repository where you can inspect git diff.

1. Install Sigil

npm install -g @sigil-ai/sigil@beta
sigil --version

If the command is missing, check the installer output and make sure npm's binary directory is on PATH.

2. Start In The Workspace You Want To Edit

cd /path/to/workspace
sigil

The launch directory becomes the normal active workspace when Quick Setup saves workspace.root = ".".

3. Complete Quick Setup

When configuration is missing, make at most three main choices: provider, credential source, and model. Review, trust folder, save and start confirms the route and allows the launch directory to be used as the workspace. Quick Setup writes a named V2 connection and the compound saved default. Remote model discovery is optional. If an endpoint has no model list or refresh fails, enter the exact model ID and continue saving the setup.

In Sigil Desktop, open a project first. A new computer or missing config opens the same three-step provider wizard before New conversation becomes available. The Settings page later shows every saved connection and can add another one without opening a conversation first.

For normal local use, choose the protected credential store; a pasted key is held only long enough to create a credential record, and sigil.toml stores a random reference. The default file policy writes owner-only ~/.sigil/credentials.json without system authentication prompts. Choose an allowlisted environment variable for CI or an already managed shell secret. See the provider guide.

Later, /model connection-id/model-id switches an idle current session to an exact ready route without losing its conversation history. In its selector, Enter switches the current session and D changes only the saved default. In /config, choosing a connection or model and saving applies it to both the current conversation and future sessions.

4. Run The First Checks

Run:

/doctor

Then ask a read-only question:

Explain this repository structure. Identify the main directories, tests, configuration files, and user documentation. Do not edit files.

You should see concrete files and read-only activity without a change approval.

5. Try A Small Safe Task

Start with a proposal:

Review the README for unclear user-facing wording. Suggest improvements first; do not edit files yet.

Then request one narrow edit:

Apply only the README wording changes you proposed.

Before allowing the change, check the summary, affected files, and diff. Finish by reviewing the repository yourself:

git diff

Run any project-specific formatter or test that the change needs. For multi-step work, continue with Common workflows; for daily controls, open the TUI user guide.

Next: Continue with the User Guide.