Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
compliancekit
command
Package main is the entry point for the compliancekit binary.
|
Package main is the entry point for the compliancekit binary. |
|
genapi
command
Command genapi enumerates the exported API surface of pkg/compliancekit and writes (or diffs) the canonical snapshot at pkg/compliancekit/api.txt.
|
Command genapi enumerates the exported API surface of pkg/compliancekit and writes (or diffs) the canonical snapshot at pkg/compliancekit/api.txt. |
|
gencheckdocs
command
Command gencheckdocs renders the canonical check catalog to docs/checks.md by introspecting the global core registry.
|
Command gencheckdocs renders the canonical check catalog to docs/checks.md by introspecting the global core registry. |
|
internal
|
|
|
baseline
Package baseline reads and writes the baseline file that the v0.6 drift workflow compares against.
|
Package baseline reads and writes the baseline file that the v0.6 drift workflow compares against. |
|
checks/aws
Package aws holds the AWS check implementations.
|
Package aws holds the AWS check implementations. |
|
checks/digitalocean
Package digitalocean holds the DigitalOcean check implementations.
|
Package digitalocean holds the DigitalOcean check implementations. |
|
checks/gcp
Package gcp holds the GCP check implementations.
|
Package gcp holds the GCP check implementations. |
|
checks/hetzner
Package hetzner holds Hetzner Cloud check implementations.
|
Package hetzner holds Hetzner Cloud check implementations. |
|
checks/k8s
Package k8s holds the Kubernetes check catalog.
|
Package k8s holds the Kubernetes check catalog. |
|
checks/linux
Package linux holds the Linux check implementations.
|
Package linux holds the Linux check implementations. |
|
cli
Package cli contains the cobra command tree for the compliancekit binary.
|
Package cli contains the cobra command tree for the compliancekit binary. |
|
collectors/aws
Package aws is the AWS Collector.
|
Package aws is the AWS Collector. |
|
collectors/cloudcommon
Package cloudcommon contains the cross-cloud abstractions every cloud collector reuses: account/region resource attribution helpers, the per-cloud Resource ID convention, and the per-cloud Region listing protocol.
|
Package cloudcommon contains the cross-cloud abstractions every cloud collector reuses: account/region resource attribution helpers, the per-cloud Resource ID convention, and the per-cloud Region listing protocol. |
|
collectors/digitalocean
Package digitalocean is the DigitalOcean Collector.
|
Package digitalocean is the DigitalOcean Collector. |
|
collectors/gcp
Package gcp is the Google Cloud Platform Collector.
|
Package gcp is the Google Cloud Platform Collector. |
|
collectors/hetzner
Package hetzner is the Hetzner Cloud Collector.
|
Package hetzner is the Hetzner Cloud Collector. |
|
collectors/k8s
Package k8s is the Kubernetes collector.
|
Package k8s is the Kubernetes collector. |
|
collectors/linux
Package linux is the Linux SSH collector (v0.2+).
|
Package linux is the Linux SSH collector (v0.2+). |
|
config
Package config defines the parsed shape of compliancekit.yaml and the loader that populates it.
|
Package config defines the parsed shape of compliancekit.yaml and the loader that populates it. |
|
diff
Package diff classifies a current scan's findings against a previously captured baseline.
|
Package diff classifies a current scan's findings against a previously captured baseline. |
|
engine
Package engine orchestrates a scan: it runs Collectors to populate the ResourceGraph, then drives the check Registry to produce Findings.
|
Package engine orchestrates a scan: it runs Collectors to populate the ResourceGraph, then drives the check Registry to produce Findings. |
|
evidence
Package evidence assembles an audit-ready folder from a set of scan findings.
|
Package evidence assembles an audit-ready folder from a set of scan findings. |
|
frameworks
Package frameworks loads compliance framework definitions from embedded YAML files and exposes them for the reporters and the `checks list` / `checks show` commands.
|
Package frameworks loads compliance framework definitions from embedded YAML files and exposes them for the reporters and the `checks list` / `checks show` commands. |
|
ingest
Package ingest reads findings produced by external security tools (Trivy, Checkov, KICS, AWS Security Hub, GCP SCC, Defender, …) and projects them onto compliancekit's resource graph + framework catalog.
|
Package ingest reads findings produced by external security tools (Trivy, Checkov, KICS, AWS Security Hub, GCP SCC, Defender, …) and projects them onto compliancekit's resource graph + framework catalog. |
|
ingest/checkov
Package checkov implements a native-JSON ingest adapter for Checkov (bridgecrewio/checkov) output.
|
Package checkov implements a native-JSON ingest adapter for Checkov (bridgecrewio/checkov) output. |
|
ingest/gitleaks
Package gitleaks implements a native-JSON ingest adapter for gitleaks (gitleaks/gitleaks) output.
|
Package gitleaks implements a native-JSON ingest adapter for gitleaks (gitleaks/gitleaks) output. |
|
ingest/grype
Package grype implements a native-JSON ingest adapter for Anchore Grype (anchore/grype) output.
|
Package grype implements a native-JSON ingest adapter for Anchore Grype (anchore/grype) output. |
|
ingest/ocsf
Package ocsf implements the OCSF (Open Cybersecurity Schema Framework) v1.x ingest adapter for compliancekit.
|
Package ocsf implements the OCSF (Open Cybersecurity Schema Framework) v1.x ingest adapter for compliancekit. |
|
ingest/oscal
Package oscal implements the OSCAL (Open Security Controls Assessment Language) Catalog ingest adapter for compliancekit.
|
Package oscal implements the OSCAL (Open Security Controls Assessment Language) Catalog ingest adapter for compliancekit. |
|
ingest/sarif
Package sarif implements the SARIF 2.1.0 ingest adapter for compliancekit.
|
Package sarif implements the SARIF 2.1.0 ingest adapter for compliancekit. |
|
ingest/trivy
Package trivy implements a native-JSON ingest adapter for Trivy (aquasecurity/trivy) output.
|
Package trivy implements a native-JSON ingest adapter for Trivy (aquasecurity/trivy) output. |
|
notify
Package notify dispatches compliancekit Findings to operator- configured channels (Slack, Discord, Teams, email, generic webhook, GitHub PR comments, Jira, PagerDuty) per the v0.17 milestone.
|
Package notify dispatches compliancekit Findings to operator- configured channels (Slack, Discord, Teams, email, generic webhook, GitHub PR comments, Jira, PagerDuty) per the v0.17 milestone. |
|
policy
Package policy implements the Rego-backed Check evaluator and the loader that turns `internal/policies/*.rego` files into entries in the compliancekit.Check registry.
|
Package policy implements the Rego-backed Check evaluator and the loader that turns `internal/policies/*.rego` files into entries in the compliancekit.Check registry. |
|
profile
Package profile is the v0.6 named-subset-of-checks abstraction.
|
Package profile is the v0.6 named-subset-of-checks abstraction. |
|
remediate
Package remediate generates structured fix-it artifacts (Terraform blocks, kubectl patches, cloud-CLI commands, Ansible plays, Helm overlays, bash one-liners) from compliancekit Findings.
|
Package remediate generates structured fix-it artifacts (Terraform blocks, kubectl patches, cloud-CLI commands, Ansible plays, Helm overlays, bash one-liners) from compliancekit Findings. |
|
remediate/ansible
Package ansible implements remediate.Strategy renderers for the FormatAnsible output.
|
Package ansible implements remediate.Strategy renderers for the FormatAnsible output. |
|
remediate/awscli
Package awscli implements remediate.Strategy renderers for the FormatAWSCLI output.
|
Package awscli implements remediate.Strategy renderers for the FormatAWSCLI output. |
|
remediate/azcli
Package azcli implements remediate.Strategy renderers for the FormatAzureCLI output.
|
Package azcli implements remediate.Strategy renderers for the FormatAzureCLI output. |
|
remediate/bash
Package bash implements remediate.Strategy renderers for the FormatBash output.
|
Package bash implements remediate.Strategy renderers for the FormatBash output. |
|
remediate/doctl
Package doctl implements remediate.Strategy renderers for the FormatDoctl output.
|
Package doctl implements remediate.Strategy renderers for the FormatDoctl output. |
|
remediate/gcloud
Package gcloud implements remediate.Strategy renderers for the FormatGCloud output.
|
Package gcloud implements remediate.Strategy renderers for the FormatGCloud output. |
|
remediate/hcloud
Package hcloud implements remediate.Strategy renderers for the FormatHcloud output.
|
Package hcloud implements remediate.Strategy renderers for the FormatHcloud output. |
|
remediate/helm
Package helm implements remediate.Strategy renderers for the FormatHelm output.
|
Package helm implements remediate.Strategy renderers for the FormatHelm output. |
|
remediate/kubectl
Package kubectl implements remediate.Strategy renderers for the FormatKubectl output.
|
Package kubectl implements remediate.Strategy renderers for the FormatKubectl output. |
|
remediate/poam
Package poam emits OSCAL v1.1.2 Plan of Action & Milestones (POA&M) JSON for findings whose remediation classifies as manual — either because no strategy is registered, or because the registered strategy declared RiskManual.
|
Package poam emits OSCAL v1.1.2 Plan of Action & Milestones (POA&M) JSON for findings whose remediation classifies as manual — either because no strategy is registered, or because the registered strategy declared RiskManual. |
|
remediate/render
Package render holds small shared helpers strategy packages use to emit safe, well-formatted snippet content.
|
Package render holds small shared helpers strategy packages use to emit safe, well-formatted snippet content. |
|
remediate/runbook
Package runbook writes the operator-facing artifacts of v0.15's remediation flow:
|
Package runbook writes the operator-facing artifacts of v0.15's remediation flow: |
|
remediate/terraform
Package terraform implements remediate.Strategy renderers for the FormatTerraform output.
|
Package terraform implements remediate.Strategy renderers for the FormatTerraform output. |
|
remediate/tickets
Package tickets files external tickets (Jira, Linear) for findings whose remediation is manual.
|
Package tickets files external tickets (Jira, Linear) for findings whose remediation is manual. |
|
report
Package report holds the Reporter implementations.
|
Package report holds the Reporter implementations. |
|
score
Package score computes the 0-100 hardening score the v0.6 milestone adds as the headline metric.
|
Package score computes the 0-100 hardening score the v0.6 milestone adds as the headline metric. |
|
server
Package server is the v1.3 serve-mode HTTP daemon.
|
Package server is the v1.3 serve-mode HTTP daemon. |
|
server/api
Package api implements the v1.3+ REST API.
|
Package api implements the v1.3+ REST API. |
|
server/assets
Package assets embeds the compiled UI bundle (Tailwind output + vendored htmx, Alpine, Preline) produced by `make ui`.
|
Package assets embeds the compiled UI bundle (Tailwind output + vendored htmx, Alpine, Preline) produced by `make ui`. |
|
server/auth
Package auth handles every authentication concern for the v1.3 serve-mode daemon: bcrypt password hashing, DB-backed sessions, double-submit-cookie CSRF protection, and the chi middleware that gates non-public routes.
|
Package auth handles every authentication concern for the v1.3 serve-mode daemon: bcrypt password hashing, DB-backed sessions, double-submit-cookie CSRF protection, and the chi middleware that gates non-public routes. |
|
server/events
Package events is the v1.6 SSE event bus the daemon uses to push live state changes to subscribed UI / TUI / API clients without polling.
|
Package events is the v1.6 SSE event bus the daemon uses to push live state changes to subscribed UI / TUI / API clients without polling. |
|
server/logs
Package logs is the v1.6 phase 6 in-UI log tail.
|
Package logs is the v1.6 phase 6 in-UI log tail. |
|
server/store
Package store is the persistent-state layer for compliancekit's serve-mode daemon.
|
Package store is the persistent-state layer for compliancekit's serve-mode daemon. |
|
server/ui
Package ui mounts the v1.3 minimal UI shell on the daemon's chi router.
|
Package ui mounts the v1.3 minimal UI shell on the daemon's chi router. |
|
server/webhook
Package webhook handles inbound webhook receivers — GitHub PR / push events + operator-defined generic webhooks.
|
Package webhook handles inbound webhook receivers — GitHub PR / push events + operator-defined generic webhooks. |
|
server/worker
Package worker is the v1.3 background job runner.
|
Package worker is the v1.3 background job runner. |
|
tui
Package tui is the v1.7 Bubble Tea terminal client.
|
Package tui is the v1.7 Bubble Tea terminal client. |
|
ui
Package ui owns the terminal styling primitives shared across every compliancekit subcommand: the severity-and-status color palette, the status glyph set, the TTY/NO_COLOR detector, and a thin Styler over lipgloss that subcommands ask for their colors instead of hand-coding ANSI escapes.
|
Package ui owns the terminal styling primitives shared across every compliancekit subcommand: the severity-and-status color palette, the status glyph set, the TTY/NO_COLOR detector, and a thin Styler over lipgloss that subcommands ask for their colors instead of hand-coding ANSI escapes. |
|
waivers
Package waivers implements compliancekit's v0.18 muting layer: explicit, time-bounded, auditable acknowledgements that a specific (check, resource) pair is non-compliant by deliberate operator choice rather than oversight.
|
Package waivers implements compliancekit's v0.18 muting layer: explicit, time-bounded, auditable acknowledgements that a specific (check, resource) pair is non-compliant by deliberate operator choice rather than oversight. |
|
pkg
|
|
|
compliancekit
Package compliancekit is the v1.0+ public API surface of compliancekit.
|
Package compliancekit is the v1.0+ public API surface of compliancekit. |
Click to show internal directories.
Click to hide internal directories.