What It Does
- Loads a prompt template, enriches it with source code and database context, and sends it to the configured AI agent
- The agent analyzes the provided context and returns structured JSON (findings or HTTP records)
- Results are parsed and saved to the Vigolium database
- No network scanning occurs -query mode purely analyzes what you give it
CLI Usage
Template-Based Execution
Run a built-in or custom prompt template against source code:Custom Prompt File
Use your own Markdown prompt file with YAML frontmatter:Freeform Questions
Ask a security question without a template:Stdin
Pipe a prompt from stdin:Dry Run
Render the full prompt without sending it to the agent -useful for debugging templates:List Templates and Agents
More Examples
Key Flags
| Flag | Description |
|---|---|
--prompt-template | Template ID to use (e.g., security-code-review, endpoint-discovery) |
--prompt-file | Path to a custom prompt Markdown file |
--source | Path to source code directory |
--files | Specific files to include, relative to --source (comma-separated) |
--agent | Agent backend to use (overrides agent.default_agent from config) |
--append | Extra text appended to the rendered prompt |
--output | Write raw agent output to a file |
--dry-run | Render the prompt without executing it |
--source-label | Label for records ingested from agent output (e.g., agent-review) |
API
prompt_template, prompt_file, or prompt is required. When stream is true, the response uses Server-Sent Events for real-time output.
Use Cases
- Code review -run
security-code-reviewbefore deployment to catch injection sinks, hardcoded secrets, and auth bypasses - Endpoint discovery -extract API routes from source code (Express, Spring, Django, etc.) and ingest them as HTTP records for subsequent scanning
- Secret detection -scan config files, deploy scripts, and environment templates for hardcoded credentials
- CI/CD integration -single AI call completes in seconds, making it suitable for pipeline gates
- Triage questions -ask the agent about a specific vulnerability pattern or security concept
Pros and Cons
| Pros | Cons |
|---|---|
| Fast -single AI call, completes in seconds | No network scanning -code analysis only |
| Low cost -one prompt, one response | Requires source code access for most templates |
| Deterministic scope -same template produces consistent coverage | Findings are unverified (no live confirmation) |
| Good for CI/CD -predictable runtime, structured output | Limited to what the template asks for |
| Works without a running target | Cannot discover runtime-only vulnerabilities |
| Supports structured output schemas (findings, HTTP records) | Freeform questions return unstructured text |
