Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Download the latest installers from the Releases page. Replace <version> below with the release you downloaded (e.g. 0.1.7).

Early releases aren’t OS-code-signed yet, so your OS may show a Gatekeeper / SmartScreen prompt on first run. Every artifact is still independently verifiable — see Verifying your download (中文) for gh attestation verify (build provenance) and checksums.

Desktop app (end users)

The installed program is Vigils (executable vigils / vigils.exe).

Linux

sudo dpkg -i Vigils_<version>_amd64.deb           # Debian / Ubuntu
sudo rpm -i  Vigils-<version>-1.x86_64.rpm         # Fedora / RHEL
chmod +x Vigils_<version>_amd64.AppImage && ./Vigils_<version>_amd64.AppImage   # portable

Windows

  • NSIS: double-click Vigils_<version>_x64-setup.exe (SmartScreen → More infoRun anyway).
  • MSI: msiexec /i Vigils_<version>_x64_en-US.msi

macOS (Apple Silicon)

Open Vigils_<version>_aarch64.dmg, drag Vigils to Applications, then clear the quarantine flag (unsigned build):

xattr -d com.apple.quarantine /Applications/Vigils.app

Auto-update

Installed apps check for updates over the Tauri auto-updater (Ed25519-signed). See Auto-Update.

Rust SDK (developers)

[dependencies]
vigil-sdk = "0.1"

Published on crates.io / docs.rs. See SDK Quickstart.

Browser extension (Chrome MV3)

Redacts secrets / PII before paste or submit on AI sites (ChatGPT / Claude / Gemini / Perplexity):

  1. chrome://extensions → enable Developer modeLoad unpacked → select extensions/chrome-mv3/.
  2. The extension talks to the desktop app’s native host (registered by the desktop installer / vigil-native-host install).

CLI agent gateway

For embedding Vigils as an MCP gateway in front of your agent (Claude Code / Codex / Cursor / Zed):

  • Prebuilt: download vigils-cli-<target>.tar.gz (or .zip on Windows) from the release — it contains vigil-hub and vigil-native-host.
  • From source: cargo install --path apps/vigil-hub-cli
vigil-hub serve --stdio    # MCP agent entry point

See the Agent Integration & Test guide for per-agent config (中文).