blackstork-cli
A source-available, headless engine for rendering BlackStork templates into Markdown and HTML locally or in CI/CD pipelines.
Automate report generation locally or in CI/CD
blackstork-cli is the underlying engine that powers the BlackStork SaaS platform. It executes BlackStork templates, handling the heavy lifting of API integrations, data transformations, LLM prompting, and document assembly. It is designed to be run locally by analysts or integrated directly into CI/CD pipelines for fully automated, headless report generation.
- Connect to security tools and data sources
- Ships with standard integrations for Splunk, Microsoft Graph, Elastic, Atlassian Jira, GitHub, OpenCTI, PostgreSQL, VirusTotal, and more.
- Define report logic in reusable templates
- Uses a custom configuration language based on HCL (just like Terraform does) to define document templates, allowing for explicit input data definitions, conditional logic, inline data mutations, and content generation.
- Keep sensitive data in your environment
- Keep sensitive input data on-premise.
blackstork-cliruns where your data lives, only reaching out to external APIs (like Google Gemini LLM) when explicitly instructed by your template configuration. - Produce consistent output formats
- Compiles input data and content configuration into a clear Markdown, HTML or PDF formats.
Source-available for internal and production use
blackstork-cli may be used for internal operations, including production use, and may be embedded in the backend of a separate application.
The Additional Use Grant does not permit offering the CLI's APIs, interfaces, or core functionality to third parties as a managed service or as a substitute for BlackStork. Each release converts to the Apache License 2.0 four years after its publication date.
See the complete license terms for the authoritative conditions.
CLI and SaaS use the same engine
Run the CLI locally or in CI/CD when security data must remain in your environment. The SaaS platform adds managed execution, collaborative review, native PDF rendering, template management, and hosted sharing.
| Capability | CLI | SaaS |
|---|---|---|
| Local and CI/CD execution | Managed | |
| Internal production use | ||
| Markdown and HTML | ||
| Native PDF rendering | ||
| Web review and editing | ||
| Document hosting and easy sharing | ||
| Team template management |
Run your first template locally
Download the pre-compiled binary for your OS. The CLI ships with a builtin plugin for basic data integrations and content structures to keep the footprint minimal. When you need to connect to specific external tools like Splunk, OpenCTI, or OpenAI, simply pull the exact integrations you need from our registry with a single install command.