Skip to content

Kingfisher Documentation Index

This page routes users, operators, LLM agents, rule authors, and library developers to the authoritative Kingfisher documentation for each task.

Start by Goal

Goal Documentation
Install or upgrade Kingfisher Installation
Run a first scan or understand scan output Usage
Scan a hosted service or developer platform Integrations
Configure project-wide defaults Project configuration
Follow detection through containment Defender workflow
Validate credentials and filter by outcome Usage: validation
Map credential identity, permissions, and resources Blast radius
Review and prioritize findings in a browser Viewer usage, hosted guide
Revoke a supported credential Revocation providers
Send alerts to chat or webhook destinations Alert webhooks
Deploy in CI, pre-commit, or a central service Deployment
Tune performance, validation, filtering, or CI behavior Advanced configuration
Track accepted findings without hiding new ones Baseline management
Preserve repository coverage evidence Repository audit log
Write, import, or verify detection rules Rule authoring
Embed scanning and validation in Rust Library API and integration recipes
Embed the Python SDK or maintain PyPI distributions Python/PyPI
Embed the JavaScript/TypeScript SDK in Node.js or VS Code Node SDK
Run Node SDK teaching examples or integrate from an LLM Executable recipe walkthrough
Configure npm trusted publishing and release the Node SDK npm publishing setup

Response Workflow

Detection and Finding Semantics

Operations and Deployment

  • Installation — package managers, binaries, Docker, source builds, hooks, cache, and release-attestation verification.
  • Integrations — authentication and commands for every remote scan target.
  • Project configuration — kingfisher.yaml policy and CLI precedence.
  • Advanced configuration — confidence, validation tuning, CI diffs, performance, exclusions, updates, and exit codes.
  • Deployment — local, CI, centralized, and embedded deployment patterns.

Development and Project Reference

  • Architecture — crates, CLI paths, scanner pipeline, validation, and reporters.
  • Rust library API — embedding the scanner and selecting validation features.
  • Python/PyPI — Native Python detection, validation, revocation, runnable uv examples, wheels, and publishing.
  • JavaScript/TypeScript — native Node SDK, typed subpaths, runnable examples, VS Code workspace integration, and npm trusted publishing.
  • Benchmarks — methodology, performance, and network requests.
  • Project background — production use, lineage, evolution, and roadmap.
  • Changelog — release history.
  • Contributing — development workflow and contribution expectations.
  • Security policy — vulnerability reporting.

Guidance for LLMs and Automation

  1. Read the repository AGENTS.md before changing code or documentation.
  2. Use kingfisher scan --format toon for token-efficient scan output. Add --no-update-check in reproducible automation.
  3. Use structured validation.outcome values and finding fingerprints; do not infer state by parsing human-readable labels.
  4. Treat USAGE.md, CONFIG.md, and command --help as authoritative for CLI behavior. Use ARCHITECTURE.md for source routing.
  5. Read RULES.md before non-trivial detector or schema changes. Generally useful rules belong upstream in Betterleaks; custom rules can use either the Kingfisher rule format (YAML) or Betterleaks TOML.
  6. Live validation, blast-radius mapping, alerts, and revocation can make network requests or cause external effects. Follow the authorization and safety guidance in the relevant document.