Syntax
vectra-guard context summarize <mode> <path> [options]
vg context summarize <mode> <path> [options]
Subcommands
context summarize
Generate intelligent summaries of files or repositories.
vg context summarize <mode> <path> [--max <n>] [--output <format>] [--since <ref>]
mode: Summary mode - code, advanced, docs, doc, or textpath: File or directory to summarize
Maximum number of summary lines or key points per file
Output format: text or json
Only process files changed since commit/time (e.g., HEAD~1, 2024-01-01, main..feature-branch)
Summary Modes
code
Basic code summarization - extracts function signatures, main logic blocks, and key operations.
advanced
Advanced code analysis - includes control flow, dependencies, and architectural patterns.
docs / doc / text
Documentation and text summarization - extracts key concepts, headings, and main points.
Examples
Summarize a single file
vg context summarize code src/api.go
# Output:
# - Package: api
# - Imports: net/http, encoding/json, database/sql
# - Function: HandleRequest(w http.ResponseWriter, r *http.Request)
# - Function: ValidateInput(data map[string]interface{}) error
# - Uses database connection pool
Summarize entire repository
vg context summarize code . --max 3
# 📄 src/main.go
# ────────────────────────────────────────────────────────────
# - Entry point: main()
# - Initializes HTTP server on :8080
# - Configures routes and middleware
#
# 📄 src/api/handlers.go
# ────────────────────────────────────────────────────────────
# - REST API handlers
# - CRUD operations for User model
# - Authentication middleware
Summarize documentation
vg context summarize docs README.md
# - Project: Vectra Guard
# - Purpose: Security guard for AI coding agents
# - Key features: Command validation, sandboxing, CVE scanning
# - Quick start: Install with one-line curl command
# - Supports: macOS, Linux, Windows
Changed files only (git integration)
vg context summarize code . --since HEAD~1
# Only summarizes files modified in last commit
vg context summarize code . --since 2024-03-01
# Only summarizes files changed since March 1st
vg context summarize code . --since main..feature-branch
# Only summarizes files different between branches
vg context summarize code . --output json | jq
# {
# "mode": "code",
# "path": ".",
# "fileCount": 12,
# "files": [
# {
# "path": "src/main.go",
# "summary": [
# "Entry point: main()",
# "Initializes HTTP server on :8080",
# "Configures routes and middleware"
# ]
# }
# ]
# }
Advanced code analysis
vg context summarize advanced src/security/ --max 5
# Provides deeper analysis:
# - Control flow patterns
# - Dependency injection
# - Error handling strategies
# - Concurrent operations
# - Security checks
Large repository with caching
# First run: analyzes all files and caches results
vg context summarize code .
# Subsequent runs: uses cache for unchanged files (much faster)
vg context summarize code .
Filter by file changes in PR
# Summarize only files changed in current PR
git fetch origin main
vg context summarize code . --since origin/main..HEAD
Caching
Summaries are cached in:
.vectra-guard/cache/context-summaries/ (repo-local)~/.vectra-guard/cache/context-summaries/ (global fallback)
Cache is used automatically when:
- File hasn’t changed since last summary
- Same mode was used
Use Cases
Code review preparation
vg context summarize code . --since main..feature --output json > pr-summary.json
# Generate context for code review
Documentation generation
vg context summarize advanced src/ > ARCHITECTURE.md
# Create architecture documentation from code
Onboarding new developers
vg context summarize code . --max 3 > PROJECT_OVERVIEW.md
# Quick project overview for new team members
AI agent context
CONTEXT=$(vg context summarize code src/)
echo "Project context: $CONTEXT" | agent-cli
# Provide condensed codebase context to AI