Vigil Help

Vigil Help Articles

Command reference for the active Vigil registry, organized by category with examples, syntax, safety notes, and technical contracts.

Executive summary

Vigil is Starlit Digital's local safety and evidence layer for repository automation. The official project homepage is sltd.ca/vigil. Source, release, and project context live in the Vigil GitHub repository. Built with ❤️ by Starlit Digital.

Vigil terminal showing ready project status and verify JSON evidence
Vigil in action: local readiness checks followed by machine-readable verification evidence for humans and agents.
Safety model: Vigil is a policy and evidence layer. It is not an operating-system sandbox.
Total commands87
Generated2026-08-22
SourceActive command registry

Automation#

CommandSourceAccessPurpose
hooks:doctorCore commandRead-onlyInspect Vigil hook paths, ownership, and backups.
hooks:installCore commandWrites files/stateInstall Vigil Git hook shims into the current repository.
hooks:pre-commitCore commandRead-onlyRun pre-commit checks from Vigil config.
hooks:pre-pushCore commandRead-onlyRun pre-push checks from Vigil config.
hooks:uninstallCore commandWrites files/stateRestore chained hooks or remove Vigil-managed hooks.
init:ciCore commandConditional writeGenerate GitHub Actions helper workflows from loaded checks.

Checks#

CommandSourceAccessPurpose
checks:command-catalogCore commandRead-onlyAudit the active command catalog for malformed entries.
checks:public-assumptionsCore commandRead-onlyScan public Vigil source for product-specific assumptions.
checks:public-parityCore commandRead-onlyCheck public source stays inside configured public boundaries.
checks:staged-sensitiveCore commandRead-onlyScan staged files for common secret patterns before commit.
checks:tracked-assistant-artifactsCore commandRead-onlyDetect tracked local AI and editor instruction artifacts.
checks:workspace-hygieneCore commandRead-onlyDetect local OS, editor, backup, and temporary artifacts.
deps:inventoryCore commandRead-onlyInventory common dependency manifests and lockfiles.
verifyCore commandRead-onlyRun the public readiness proof set.

Config#

CommandSourceAccessPurpose
config:initCore commandConditional writeGenerate or write a starter JSON config.
config:migrateCore commandConditional writeMigrate config files to the current schema.
config:repairCore commandWrites files/stateInteractively repair missing or broken config fields.
config:reportCore commandRead-onlyReport effective redacted configuration and discovery details.
config:schemaCore commandRead-onlyPrint the supported JSON config schema summary.
config:templateCore commandRead-onlyPrint a versioned starter config for a selected profile.
config:validateCore commandRead-onlyValidate the effective JSON config.
settings:showCore commandRead-onlyAlias for config:report.

Core#

CommandSourceAccessPurpose
advancedCore commandRead-onlyShow every command and advanced option.
applyCore commandWrites files/stateVerify and execute an unchanged reviewed plan.
checkCore commandConditional writeRun the normal project checks.
doctorCore commandRead-onlyCheck local readiness for using Vigil.
explainCore commandRead-onlyExplain a command's source, access, and usage.
fixCore commandRead-onlySuggest safe next actions.
guards:summaryCore commandRead-onlySummarize read-only and mutating command coverage.
helpCore commandRead-onlyShow command help and contracts.
learnCore commandRead-onlyLearn one Vigil feature at a time.
listCore commandRead-onlyList core and loaded pack commands.
nextCore commandRead-onlyPrioritize next local setup and verification actions.
planCore commandConditional writeCreate a digest-bound plan for configured local checks.
resources:catalogCore commandRead-onlyList public local diagnostic resources.
self-heal:planCore commandRead-onlySuggest safe repairs for local configuration and setup.
sentryCore commandConditional writeInteractively review a workflow plan in Sentry Mode.
sentry:applyCore commandConditional writeExecute a Sentry-reviewed workflow plan.
sentry:stateCore commandRead-onlyPrint an agent-readable Sentry safety state.
statusCore commandRead-onlySummarize config, pack, Git, and command readiness.
support:bundleCore commandWrites files/stateWrite or preview a redacted local diagnostic bundle.
tools:catalogCore commandRead-onlyList public tools and command contracts.
versionCore commandRead-onlyPrint Vigil version and build metadata.
workflow:localCore commandConditional writePreview or run configured local preflight checks.

Packaging#

CommandSourceAccessPurpose
completionCore commandRead-onlyGenerate shell completion for Bash, Zsh, or Fish.
manpageCore commandRead-onlyGenerate the vigil(1) manual page.
manpage:generateCore commandRead-onlyGenerate the vigil(1) manual page.
manpage:installCore commandWrites files/stateInstall the vigil(1) manual page.

Packs#

CommandSourceAccessPurpose
a11y:ciPack: a11y-adaptersRead-onlyRun the configured accessibility adapter set for CI.
a11y:inventoryPack: a11y-adaptersRead-onlyList locally available accessibility tools.
a11y:lighthousePack: a11y-adaptersRead-onlyRun Lighthouse accessibility checks.
a11y:pa11yPack: a11y-adaptersRead-onlyRun Pa11y against a route.
a11y:playwrightPack: a11y-adaptersRead-onlyRun Playwright accessibility tests.
a11y:smokePack: a11y-adaptersRead-onlyRun fast accessibility smoke checks with available local tools.
checks:dependency-securityPack: dependency-adaptersRead-onlyRun public dependency and scanner adapters.
checks:release-policyPack: release-policyRead-onlyCheck generic release readiness.
composer:validatePack: dependency-adaptersRead-onlyRun Composer manifest validation.
deploy:verifyPack: deploy-verifyRead-onlyVerify a configured public endpoint.
deps:whyPack: dependency-adaptersRead-onlyFind package references in supported dependency manifests.
extensions:doctorCore commandRead-onlyValidate loaded pack manifests.
extensions:listCore commandRead-onlyList loaded pack manifests.
files:iteratePack: file-iteratorRead-onlyIterate over repository files matching a glob.
github:init-ciPack: github-cicdConditional writeGenerate a GitHub Actions workflow from Vigil preflight checks.
history:diagnosePack: repo-healthRead-onlyAlias for repository health diagnostics.
javascript:qualityPack: dependency-adaptersRead-onlyRun public JavaScript quality adapters.
npm:auditPack: dependency-adaptersRead-onlyRun npm audit.
php:lintPack: dependency-adaptersRead-onlyRun PHP syntax checks.
phpstan:analysePack: dependency-adaptersRead-onlyRun PHPStan analysis.
readme:checkPack: scribeRead-onlyCheck Scribe managed README block freshness.
readme:generatePack: scribeWrites files/stateGenerate Scribe managed README block.
repo:healthPack: repo-healthRead-onlyReport lightweight Git history diagnostics.
security:gitleaksPack: security-adaptersRead-onlyRun local secret scanner.
tests:affectedPack: test-adaptersRead-onlyList likely tests for changed files.
tests:historyPack: test-adaptersRead-onlySummarize JUnit test history.

Plugins#

CommandSourceAccessPurpose
plugins:conformanceCore commandConditional writeValidate an external executable against the plugin protocol.
plugins:doctorCore commandRead-onlyVerify plugin digests, trust, compatibility, and handshakes.
plugins:index:verifyCore commandRead-onlyVerify a signed plugin index against local publisher trust.
plugins:installCore commandWrites files/stateInstall and trust a local or signed-index plugin executable.
plugins:listCore commandRead-onlyList locked plugins and local trust state.
plugins:publishersCore commandRead-onlyList trusted and revoked plugin publisher keys.
plugins:removeCore commandWrites files/stateRemove and locally revoke a locked plugin.
plugins:revoke-publisherCore commandWrites files/stateLocally revoke a trusted plugin publisher key.
plugins:trust-publisherCore commandWrites files/stateTrust an Ed25519 plugin publisher key.
plugins:updateCore commandWrites files/stateUpdate a locked plugin from a local file or signed index.

Setup#

CommandSourceAccessPurpose
initCore commandConditional writeAlias for setup:wizard.
setupCore commandConditional writePlan or apply first-run Vigil configuration setup.
setup:wizardCore commandConditional writeRun the interactive setup wizard.