Documentation
Comprehensive guides, quickstart walkthroughs, and architecture overviews.
Search Documentation & Architecture Guides
Find quickstarts, API specifications, and Tree-sitter parser references.
Fast-Track Quickstarts
Choose the integration path that fits your current workflow.
GitHub Webhook Bot
Connect any repository via OAuth in under 30 seconds. Automatically parses PR diffs in RAM and posts inline review comments.
Terminal CLI & Hooks
Run AST checks locally in your terminal before pushing code to remote. Catch unreviewed breaking changes in milliseconds.
REST API & OpenAPI
Programmatically trigger diff analyses, fetch cyclomatic radar metrics, and ingest automated webhook events.
Architecture & Security
Concrete syntax trees, ephemeral memory sandboxes, and least-privilege token access.
Tree-sitter Concrete Syntax Tree Construction
How language-native AST parsers isolate functions, classes, and scopes in temporary worker RAM in under 10ms.
Ephemeral Worker RAM Sandboxes & Zero Retention
Complete technical breakdown of why source code is never written to disk or used for public model training.
GitHub OAuth & Least-Privilege Scopes
Detailed explanation of repository access permissions, token encryption via AES-256, and webhook secrets.
CLI & Git Hooks
Pre-push local analysis, package manager installation, and command flags.
CLI Installation via npm, Homebrew, & curl
Target installation instructions for running GitCaptain AST parsers locally in your terminal.
Pre-Push & Husky Git Hooks Integration
Prevent high-risk circular imports and broken exports from being pushed to remote branches.
CLI Flags, Output Formats & CI Configuration
Reference guide for --diff-only, --fail-on-risk, and --complexity-threshold arguments.
API & Webhooks
OpenAPI REST specifications, webhook HMAC validation, and metrics endpoints.
GitHub Webhook Ingestion & HMAC Verification
How GitHub pull request events are cryptographically authenticated and queued for analysis.
POST /v1/analyze/diff — In-Memory Diff Evaluation
Programmatically evaluate unified git patches with language-aware Tree-sitter parsers.
GET /v1/repositories/{id}/metrics — Complexity Radar
Retrieve real-time cyclomatic scores, Halstead volume, and maintainability index scores.
Configuration & Keys
.gitcaptain.json repository schemas, custom risk rules, and encrypted key storage.
.gitcaptain.json Configuration Schema
Customize AST inspection depth, cyclomatic complexity thresholds, and file ignore rules.
Configuring Bring-Your-Own API Keys (/apis)
Store encrypted personal keys for Gemini, Groq, OpenRouter, and Mistral with sub-second failover.
GitHub Branch Protection & CI Required Checks
Enforce GitCaptain PR analysis passing before pull requests are permitted to merge into main.
Have a Question or Custom Requirement?
Need help deploying isolated worker runners, custom Tree-sitter grammar queries, or monorepo rule tuning? Our engineering group replies directly.