Documentation
¶
Overview ¶
Package skillassets embeds the runtime assets that ship inside the vigilante binary: the built-in coding-agent skills under skills/ and the canonical repository label manifest.
Vigilante ¶
This is the module root of vigilante, a sandbox-first orchestration layer for coding agents. Vigilante turns GitHub issues into a guarded issue-to-PR pipeline: one git worktree per task, deterministic lifecycle management, scoped credentials, and a durable operator trail through issue comments, session state, and pull requests.
Vigilante is a command-line program, not a library. The orchestration logic lives in internal packages and is intentionally not part of the public API, so there is nothing here to import beyond the embedded assets above. Install and usage documentation lives in README.md and DOCS.md; the sandbox threat model is described in SANDBOX.md.
The command entry points are:
cmd/vigilante the vigilante CLI and daemon cmd/gh-sandbox the sandboxed gh wrapper used inside containers
Index ¶
Constants ¶
This section is empty.
Variables ¶
var LabelsManifest embed.FS
LabelsManifest contains the canonical Vigilante repository label definitions.
var Skills embed.FS
Skills contains built-in runtime skill files for installed binaries.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gh-sandbox
command
Command gh-sandbox is a lightweight gh CLI mirror for sandbox containers.
|
Command gh-sandbox is a lightweight gh CLI mirror for sandbox containers. |
|
vigilante
command
Command vigilante is the sandbox-first orchestration CLI and daemon for coding agents.
|
Command vigilante is the sandbox-first orchestration CLI and daemon for coding agents. |
|
internal
|
|
|
app
Package app implements the vigilante command surface: argument parsing, the subcommand handlers behind the CLI, and the operator-facing reporting such as `vigilante status` and `vigilante logs`.
|
Package app implements the vigilante command surface: argument parsing, the subcommand handlers behind the CLI, and the operator-facing reporting such as `vigilante status` and `vigilante logs`. |
|
backend
Package backend defines the issue-tracker abstraction vigilante orchestrates against: the IssueTracker and LabelManager interfaces plus the tracker-neutral types (work items, labels, progress comments) that cross that boundary.
|
Package backend defines the issue-tracker abstraction vigilante orchestrates against: the IssueTracker and LabelManager interfaces plus the tracker-neutral types (work items, labels, progress comments) that cross that boundary. |
|
backend/github
Package github implements the backend.IssueTracker and backend.LabelManager interfaces for GitHub, driving the authenticated `gh` CLI rather than talking to the REST API directly so vigilante inherits the operator's existing gh credentials and configuration.
|
Package github implements the backend.IssueTracker and backend.LabelManager interfaces for GitHub, driving the authenticated `gh` CLI rather than talking to the REST API directly so vigilante inherits the operator's existing gh credentials and configuration. |
|
backend/linear
Package linear implements the backend.IssueTracker interface for Linear, mapping Linear issues onto the tracker-neutral work-item types vigilante dispatches against.
|
Package linear implements the backend.IssueTracker interface for Linear, mapping Linear issues onto the tracker-neutral work-item types vigilante dispatches against. |
|
blocking
Package blocking classifies why a session stopped making progress and turns that into the structured blocked reason vigilante records in session state and reports back on the issue.
|
Package blocking classifies why a session stopped making progress and turns that into the structured blocked reason vigilante records in session state and reports back on the issue. |
|
build
Package build holds the version metadata stamped into the binary at link time by GoReleaser.
|
Package build holds the version metadata stamped into the binary at link time by GoReleaser. |
|
environment
Package environment is the boundary between vigilante and the host: process execution, executable lookup, platform detection, and the access log that records every external command a session ran.
|
Package environment is the boundary between vigilante and the host: process execution, executable lookup, platform detection, and the access log that records every external command a session ran. |
|
fork
Package fork implements vigilante's fork-based workflow, where the authenticated identity opens pull requests from a fork instead of pushing branches to the watched upstream repository.
|
Package fork implements vigilante's fork-based workflow, where the authenticated identity opens pull requests from a fork instead of pushing branches to the watched upstream repository. |
|
github
Package ghcli wraps the GitHub CLI.
|
Package ghcli wraps the GitHub CLI. |
|
hardening
Package hardening provides deterministic JS/TS package manifest checks for pull requests that modify package.json files.
|
Package hardening provides deterministic JS/TS package manifest checks for pull requests that modify package.json files. |
|
logging
Package logging provides the daemon's structured logger and the size-bounded rotation that keeps long-running daemon logs from filling the disk.
|
Package logging provides the daemon's structured logger and the size-bounded rotation that keeps long-running daemon logs from filling the disk. |
|
logtime
Package logtime formats timestamps for operator-facing output.
|
Package logtime formats timestamps for operator-facing output. |
|
provider
Package provider describes the coding-agent CLIs vigilante can launch — Claude Code, Codex, Gemini, and OpenCode — and how to invoke each one for a given task.
|
Package provider describes the coding-agent CLIs vigilante can launch — Claude Code, Codex, Gemini, and OpenCode — and how to invoke each one for a given task. |
|
repo
Package repo inspects a local git checkout: discovering its remote and default branch, parsing GitHub remotes into owner/name slugs, and classifying the repository's build tooling so vigilante can pick the matching implementation skill.
|
Package repo inspects a local git checkout: discovering its remote and default branch, parsing GitHub remotes into owner/name slugs, and classifying the repository's build tooling so vigilante can pick the matching implementation skill. |
|
runner
Package runner drives a single coding-agent session end to end: issue implementation, conflict resolution, and CI remediation.
|
Package runner drives a single coding-agent session end to end: issue implementation, conflict resolution, and CI remediation. |
|
sandbox
Package sandbox orchestrates containerized coding-agent execution.
|
Package sandbox orchestrates containerized coding-agent execution. |
|
sandbox/container
Package container manages Docker container lifecycle for sandbox sessions.
|
Package container manages Docker container lifecycle for sandbox sessions. |
|
sandbox/proxy
Package proxy implements the sandbox reverse proxy that intercepts gh CLI commands from sandbox containers and enforces repository-scoped access.
|
Package proxy implements the sandbox reverse proxy that intercepts gh CLI commands from sandbox containers and enforces repository-scoped access. |
|
sandbox/token
Package token implements HMAC-signed sandbox session tokens.
|
Package token implements HMAC-signed sandbox session tokens. |
|
service
Package service installs and controls the vigilante daemon as a native operating-system service: a launchd job on macOS and a systemd unit on Linux.
|
Package service installs and controls the vigilante daemon as a native operating-system service: a launchd job on macOS and a systemd unit on Linux. |
|
skill
Package skill installs and resolves the coding-agent skills that tell an agent how to implement an issue in a given repository shape.
|
Package skill installs and resolves the coding-agent skills that tell an agent how to implement an issue in a given repository shape. |
|
state
Package state is vigilante's durable record: watch targets, per-issue sessions, and the configuration the daemon reads on every scan.
|
Package state is vigilante's durable record: watch targets, per-issue sessions, and the configuration the daemon reads on every scan. |
|
telemetry
Package telemetry exports vigilante's operational events over OpenTelemetry: command invocations, workflow milestones, and downstream rate limiting.
|
Package telemetry exports vigilante's operational events over OpenTelemetry: command invocations, workflow milestones, and downstream rate limiting. |
|
testutil
Package testutil provides the shared fakes vigilante's tests use in place of the host: a scripted environment.Runner that answers commands from a fixture map, and a discarding writer.
|
Package testutil provides the shared fakes vigilante's tests use in place of the host: a scripted environment.Runner that answers commands from a fixture map, and a discarding writer. |
|
worktree
Package worktree manages the per-issue git worktrees that isolate one task from another, along with the deterministic branch names and paths derived from an issue number and title.
|
Package worktree manages the per-issue git worktrees that isolate one task from another, along with the deterministic branch names and paths derived from an issue number and title. |
|
Package scripts contains no Go implementation.
|
Package scripts contains no Go implementation. |