Verb-first LLM interaction for the shell, with optional punctuation shortcuts.
Project description
Sigil
Natural-language shell assistant.
Sigil turns short terminal intents into explicit, inspectable shell interactions. Ask from local context, hand one agent step to Zeta, or run one command with captured output without leaving your prompt. Sigil is inspired by IRC-style bot commands: lightweight punctuation prefixes that let you address an assistant inline without leaving the conversation.
, what changed in this repo?
,, run the relevant tests
,,, update the docs and run checks
+ cargo test
?
Sigil is alpha software. It is ready for early shell users who are comfortable with local LLM tooling, editable command handoffs, and occasional interface changes.
Why Sigil?
Most shell assistants blur together three very different operations: suggesting, executing, and explaining. Sigil keeps those routes separate.
| Need | Glyph | What happens |
|---|---|---|
| "Answer from context." | , |
Read-only answer with local inspection tools. No shell is exposed. |
| "Do one agent turn." | ,, |
Confirms, then runs tool calls until no more are needed. |
| "Do a routine edit step." | ,,, |
Runs one auto-approved Zeta step; exact replacements are applied directly. |
| "Run and capture this command." | + |
Runs one explicit command, streams output, and records stdout/stderr snippets. |
| "Check Sigil status." | ? |
Shows the current session status without calling a model. |
The result is a shell workflow with small blast radius, durable state, and a plain CLI underneath the punctuation.
Install
Install the Python command, then install the shell binding:
uv tool install sigil-sh
sigil install zsh
sigil doctor
For Bash:
uv tool install sigil-sh
sigil install bash
sigil doctor --shell bash
You can also install with pipx:
pipx install sigil-sh
To try the current main branch before a tagged release:
uv tool install git+https://github.com/rlouf/sigil
The Python package is named sigil-sh because sigil was not available as a
distribution name. The installed command is still sigil.
sigil install copies the bundled binding to ~/.sigil/shell/<shell>/ and
adds an idempotent source block to .zshrc or .bashrc. Running it again
updates the binding without duplicating the rc block.
Requirements
- Python 3.11+
- zsh or Bash for shell bindings
- A local OpenAI-compatible chat completions endpoint for command generation
and Zeta-backed answer/agent routes (default
http://127.0.0.1:8080/v1/chat/completions) - The bundled
zetaruntime entrypoint installed with Sigil.sigil doctorchecks that bothsigiland its runtime service are visible on PATH. glowfor Markdown rendering, optional but recommended
Useful environment variables:
ZETA_MODEL_URL=http://127.0.0.1:8080/v1/chat/completions
ZETA_MODEL_NAME=local-model
ZETA_MODEL_PATH=/path/to/model.gguf
SIGIL_STATE_DIR=$HOME/.sigil
SIGIL_RUN_CAPTURE_BYTES=6000
SIGIL_GLOW_STYLE=notty
SIGIL_GLOW_WIDTH=88
# Optional override used by sigil doctor/runtime service discovery.
ZETA_BIN=/path/to/zeta
Changing Models Mid-Session
Sigil can switch Zeta model profiles for the current terminal session without
changing global environment variables. Define profiles in ~/.zeta/models.toml:
[[models]]
name = "fast"
model = "qwen2.5-coder"
url = "http://127.0.0.1:8080/v1/chat/completions"
[[models]]
name = "deep"
model = "qwen3-coder"
url = "http://127.0.0.1:8081/v1/chat/completions"
Then select a profile for the active shell session:
sigil model list
sigil model use fast
, why did the last command fail?
sigil model use deep
,, refactor the failing path and run the focused tests
sigil model show
sigil model clear
The selected profile is scoped to the current SIGIL_SESSION_ID, so another
terminal keeps its own model selection. Clearing the profile returns the session
to ZETA_MODEL_NAME and ZETA_MODEL_URL.
Quick Start
Once the shell binding is installed, use the glyphs directly:
# Ask from read-only context.
, why did the last command fail?
# Run one shell-owned Zeta step.
,, run the relevant tests
# Run one command through Sigil's explicit capture path.
+ cargo test
# Check current Sigil status.
?
Use stdin as context:
git diff | , review risky changes
git diff --name-only | , what should I test?
Read-only comma uses piped input directly because it has no execute path. Agent-step routes are driven by the prompt text and the current shell session.
A Typical Flow
# 1. Ask what changed.
, summarize this repo state
# 2. Ask Zeta to pick the next shell step.
,, run the focused tests for this change
# 3. Edit or run the staged shell command normally.
uv run pytest tests/test_shell_bindings.py
# 4. Resume the Zeta turn with the recorded shell result.
,,
Sigil keeps session state under ~/.sigil/ so Zeta can resume from recent
answer turns, handoff transcripts, and command results recorded through + or a
Zeta handoff capture window.
Glyph Reference
Installed zsh and Bash bindings expose these shortcuts:
| Glyph | Name | Behavior |
|---|---|---|
, |
read | Answer from read-only context. |
,, |
confirmed loop | Confirm, then run tool calls until no more are needed. |
,,, |
auto loop | Run auto-approved tool calls until no more are needed. |
+ |
run | Run one explicit command and capture stdout/stderr snippets. |
? |
status | Show the current session status. |
Examples:
, summarize this repo state
,, run the relevant tests
,,, fix the failing parser test
+ cargo test
?
, prints a read-only answer. It does not stage commands or write to shell
history.
,, gives the objective to the confirmed Zeta loop. The loop may call local
tools such as read, ls, grep, bash, edit, and write until the model
returns a final answer. Tool calls are shown as muted trace lines, and tool
results are summarized compactly. The full JSON result stays in the Zeta
transcript for the model.
,,, is the same tool loop without the confirmation step.
Read-only routes do not expose Bash. If an answer recommends a command, it is plain answer text, not a tool call or terminal handoff.
+ runs the command you provide through sigil run, streams stdout/stderr live,
preserves the exit status, and records bounded stdout/stderr snippets for later
failure context. It does not use a shell parser; use sh -c for pipelines,
redirection, and shell-only syntax.
To install the CLI without punctuation shortcuts:
sigil install zsh --no-glyphs
Route Model
Each route has a fixed effect on your system:
| Route | Effect | Rule |
|---|---|---|
, |
read-only | Local answer route with no Bash tool. |
,, |
read/write/execute | Confirmed Zeta loop; read-only tools, Bash, edit, and write run directly. |
,,, |
read/write/execute | Auto-approved Zeta step; read-only tools, Bash, edit, and write run directly. |
+ |
execute | Explicit local command execution with stdout/stderr capture. |
Sigil stores audit/debug events and per-shell continuity under ~/.sigil/.
Inspect the global event log with:
sigil events
CLI
The glyphs are thin shell functions over a regular CLI:
sigil ask [--follow-up] [--json] [QUESTION]
sigil run COMMAND [ARGS...]
sigil act [show|resume|abort] [--json]
sigil status [--json]
sigil events [--limit N] [--json] [--raw]
sigil session [show|path|list|clear] [--json]
sigil install {zsh|bash} [--install-dir DIR] [--rc FILE] [--glyphs|--no-glyphs]
sigil doctor [--shell auto|zsh|bash] [--json]
Sigil also installs a bundled zeta entrypoint. It is a service API used by
the shell bindings and Sigil routes, not the primary user interface:
zeta tools list --json
zeta tool {read|ls|grep|bash|edit|write}
zeta transcript {append|tail}
Copy-pasteable examples:
sigil ask "what changed in this repo?"
sigil run cargo test
sigil events
State
Sigil writes event-sourced state under ~/.sigil/ by default. Set
SIGIL_STATE_DIR to move it.
Installed Bash and zsh bindings set SIGIL_SESSION_ID once when the shell
starts, so separate terminal windows keep separate continuity. Override the
boundary with SIGIL_SESSION_ID or SIGIL_SESSION_DIR.
Inspect state without calling a model:
sigil session show
sigil session list
sigil session clear
sigil events
Project Scope
Sigil is:
- A command-line tool and optional shell binding.
- A shell-owned Zeta loop for one-step read/search/edit/write workflows.
- An evented state layer for shell continuity and audit history.
Sigil is not:
- A public Python library. The Python package does not expose a supported API.
- A background autonomous agent.
- A replacement for reviewing commands and model output.
Roadmap
sigil sh is the likely next shell-shaped surface once explicit command
execution proves itself. The shell hooks are intentionally lightweight: they can
record command metadata, but they should not invisibly interpose on every
program's terminal output. A future shell frontend would own the prompt and
transcript boundary, delegate command semantics to the user's real shell, and
decide deliberately when a command runs as structured captured output versus an
interactive terminal session.
Development
Set up the repo:
uv sync --group dev
Run the checks used by CI:
uv run pre-commit run --all-files
uv run pytest
License
Apache-2.0. See LICENSE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sigil_sh-0.3.0.tar.gz.
File metadata
- Download URL: sigil_sh-0.3.0.tar.gz
- Upload date:
- Size: 134.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ba78528aa0b10d387e0eacc4b57956f2d2dcba631ffe564314c3fe818495497
|
|
| MD5 |
6141fd3a1a13ad84331a06fac504612c
|
|
| BLAKE2b-256 |
fa46c816e5d262f2030090c314756dd245785f037dd085122198de5b6a39eb5c
|
Provenance
The following attestation bundles were made for sigil_sh-0.3.0.tar.gz:
Publisher:
release.yml on rlouf/sigil
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sigil_sh-0.3.0.tar.gz -
Subject digest:
5ba78528aa0b10d387e0eacc4b57956f2d2dcba631ffe564314c3fe818495497 - Sigstore transparency entry: 1739270977
- Sigstore integration time:
-
Permalink:
rlouf/sigil@4c52e920036e08cf914a64762661d970c0c09239 -
Branch / Tag:
refs/tags/v0.3.0 - Owner: https://github.com/rlouf
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@4c52e920036e08cf914a64762661d970c0c09239 -
Trigger Event:
push
-
Statement type:
File details
Details for the file sigil_sh-0.3.0-py3-none-any.whl.
File metadata
- Download URL: sigil_sh-0.3.0-py3-none-any.whl
- Upload date:
- Size: 89.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
83f9dcd46c7b756f60db972792521bd51974cc7afc56d192933f50f23baa87a6
|
|
| MD5 |
c0618522fd0e2904365ee543143a8951
|
|
| BLAKE2b-256 |
4c966288f6b864834353291c3f43bd8dc2e6a20a67ee3858daf1ccae9aa70c74
|
Provenance
The following attestation bundles were made for sigil_sh-0.3.0-py3-none-any.whl:
Publisher:
release.yml on rlouf/sigil
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sigil_sh-0.3.0-py3-none-any.whl -
Subject digest:
83f9dcd46c7b756f60db972792521bd51974cc7afc56d192933f50f23baa87a6 - Sigstore transparency entry: 1739270981
- Sigstore integration time:
-
Permalink:
rlouf/sigil@4c52e920036e08cf914a64762661d970c0c09239 -
Branch / Tag:
refs/tags/v0.3.0 - Owner: https://github.com/rlouf
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@4c52e920036e08cf914a64762661d970c0c09239 -
Trigger Event:
push
-
Statement type: