Skip to main content

Verb-first LLM interaction for the shell, with optional punctuation shortcuts.

Project description

Sigil

CI PyPI Python License

Natural-language shell assistant.

Sigil turns short terminal intents into explicit, inspectable shell interactions. Ask from local context, propose one reviewed agent step, do one routine step, 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.

Verb Glyph What happens
ask , Answer from local context. No shell is exposed.
propose ,, Run the agent until it can stage reviewed shell work or return an answer.
do ,,, Run one auto-approved agent step; exact replacements are applied directly.
run + Run one explicit command, stream output, and record stdout/stderr snippets.
status ? Show 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

Sigil targets zsh. Install the Python command, then install the shell binding:

uv tool install sigil-sh
sigil install
sigil doctor

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/zsh/ and adds an idempotent source block to .zshrc. Running it again updates the binding without duplicating the rc block.

Requirements

  • Python 3.11+
  • zsh 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 zeta runtime entrypoint installed with Sigil. sigil doctor checks that both sigil and its runtime service are visible on PATH.

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
# Optional client-side stream idle timeout in seconds; unset or <=0 disables it.
ZETA_MODEL_IDLE_TIMEOUT_SECONDS=0
SIGIL_STATE_DIR=$HOME/.sigil
SIGIL_RUN_CAPTURE_BYTES=6000
# Optional override used by sigil doctor/runtime service discovery.
ZETA_BIN=/path/to/zeta

Sigil sends Zeta model requests with OpenAI-compatible streaming enabled internally, even though it still renders the final assistant message as one response. For local llama-server, this gives the server a direct client disconnect signal if Sigil aborts a request. ZETA_MODEL_IDLE_TIMEOUT_SECONDS is only a client-side stream read timeout; llama-server --timeout is a read/write timeout, not a generation cancellation guarantee.

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 local context.
, why did the last command fail?

# Propose one reviewed agent 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 bindings expose these shortcuts:

Glyph Name Behavior
, ask Answer from local context.
,, propose Run until Sigil can stage reviewed shell work or return an answer.
,,, do 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.

,, proposes the next reviewed step. 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.

,,, does 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. In interactive zsh, the binding captures the raw + ... prompt line before zsh parses it, so pipelines, redirection, and shell grammar can be written naturally:

+ cargo test --all | tee test.log
+ git status --short > status.txt

From Bash or scripts, sigil run COMMAND [ARGS...] keeps argv-style execution. Use sigil run --shell 'COMMAND | WITH SHELL GRAMMAR' when you need shell parsing from the CLI.

To install the CLI without punctuation shortcuts:

sigil install --no-glyphs

Route Model

Each route has a fixed effect on your system:

Route Effect Rule
, ask read-only Local answer route with no Bash tool.
,, propose read/write/execute Read-only tools run directly; Bash/edit/write are staged for review.
,,, do read/write/execute Read-only tools, Bash, edit, and write run directly.
+ run execute Explicit local command execution with stdout/stderr capture.
? status read-only Current session status without calling a model.

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 [--shell] COMMAND [ARGS...]
sigil status [--json]
sigil events [--limit N] [--json] [--raw]
sigil session [show|path|list|clear] [--json]
sigil install [--install-dir DIR] [--rc FILE] [--glyphs|--no-glyphs]
sigil doctor [--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 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

sigil_sh-0.4.0.tar.gz (150.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sigil_sh-0.4.0-py3-none-any.whl (95.9 kB view details)

Uploaded Python 3

File details

Details for the file sigil_sh-0.4.0.tar.gz.

File metadata

  • Download URL: sigil_sh-0.4.0.tar.gz
  • Upload date:
  • Size: 150.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sigil_sh-0.4.0.tar.gz
Algorithm Hash digest
SHA256 5413d256e1597b4a51cff9cf68c8019a5b36eb474771c89446817be67107a19d
MD5 ec4ebb12e630173434e0342ff1728383
BLAKE2b-256 a59b51cfdc7f116df1782a6fe860d8de88ed96b23d3a6ff1fd678599c3f6f5c4

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigil_sh-0.4.0.tar.gz:

Publisher: release.yml on rlouf/sigil

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sigil_sh-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: sigil_sh-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 95.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sigil_sh-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b2b679d0dcb9c6b5d5f870f92e7d5c03e9d21b9ab5fc214e865183f7d676f411
MD5 b5f9ddcc684cd6712c204565b7597eea
BLAKE2b-256 c9532440c5e774c878b536f5c44090e6b32ecb15cb4769ded934076e0ab9c880

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigil_sh-0.4.0-py3-none-any.whl:

Publisher: release.yml on rlouf/sigil

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page