Skip to content

What is Sentinel?

Lint everything but your code.

Sentinel is a small CLI that automates non-code checks for pull requests. It loads your plugins, inspects the diff from the active provider, and posts a single comment with a structured report.

Provider aware

Sentinel resolves a provider (local, GitHub, GitLab, or Bitbucket) so plugins can read pull request metadata and diff information.

Plugin driven

Plugins implement optional setup and run hooks to prepare resources and emit messages via the shared reporter.

Single report

The runner aggregates messages from every plugin and posts one Markdown summary to the provider.
  1. The CLI loads sentinel.config.ts or sentinel.config.js from the current working directory.
  2. It resolves the provider (defaulting to local) and loads any configured plugins.
  3. Each plugin runs against the pull request diff and metadata and uses the shared reporter to add info, warnings, or failures.
  4. Sentinel compiles the collected messages into a Markdown summary and posts it back through the provider.