Docs / DEVELOPER TOOLS
DEVELOPER TOOLS
Korthex SDK
Written and maintained by Hendrik Schneider · Last reviewed · How we check this
The Korthex SDK gives you a typed, idiomatic client to every Korthex engine. Build your own CI runners, security dashboards, programmatic scan triggers, and internal developer platforms on top of the same surface the Korthex CLI and Dashboard consume. Status: In active development. The surfaces documented here are the planned shape; specific methods, types, and release timelines will land piecewise as each module reaches preview. Subscribe to the changelog for breaking notices.
What the SDK Solves
Embed scanning into a custom CI workflow without shelling out to the binary. Trigger remote scans from your developer portal and react to results in real time. Stream findings into your own data lake, GRC platform, or SIEM. Render custom dashboards with first-class typed data from any engine. Automate migration plans generate, preview, and (V2) execute migrations from your own tooling.
Supported Languages
All language SDKs target the same wire protocol and feature surface. Idioms differ per language (e.g. async/await in TypeScript vs. context-manager in Python), but the conceptual model and naming are identical.
| Language | Package | Status |
|---|---|---|
| TypeScript / Node.js | @korthex/sdk | Reference implementation |
| Python | korthex-sdk (pip) | In development |
| Java / Kotlin | com.korthex:korthex-sdk | In development |
| .NET (C#) | Korthex.Sdk (NuGet) | Planned |
| Go | github.com/korthex/sdk-go | Planned |
| Rust | korthex (crates.io) | Planned |
Where to Start
New to the SDK? Walk the nested navigation in this order: Installation → Authentication → Quick Start → pick the Modules branch for whichever engine you need. Returning users typically jump to API Reference or the relevant module page directly.