/usr/bin/kates

  ╦╔═  ╔═╗  ╔╦╗  ╔═╗  ╔═╗
  ╠╩╗  ╠═╣   ║   ║╣   ╚═╗
  ╩ ╩  ╩ ╩   ╩   ╚═╝  ╚═╝
  Kafka Advanced Testing & Engineering Suite

  Performance testing, chaos engineering, and
  trend analysis for Apache Kafka — from your terminal.

Quick Start:
  $ kates ctx set local --url http://localhost:30083
  $ kates ctx use local
  $ kates health

Health & Status:
  health         System health, Kafka connectivity, engine status
  status         Quick one-line system status
  doctor         Pre-flight cluster readiness checklist
  version        CLI, API, and runtime version info
  cluster        Kafka cluster metadata and topic listing
  diff           Compare Kafka cluster state between two contexts
  test list      List test runs with optional filters
  test get       Show details of a specific test run

Testing:
  test create    Start a new performance test
  test apply     Apply a YAML test scenario definition
  test delete    Delete a test run
  test cleanup   Delete orphaned RUNNING tests
  test prune     Delete finished runs older than a cutoff
  test compare   Side-by-side metric diff of two runs
  test summary   Aggregate stats across all tests
  test export    Export results to CSV or JSON file
  test flame     ASCII latency histogram

Tuning:
  lab            Interactive performance tuning laboratory
  advisor        Analyze test results & recommend config improvements
  profile        Save, compare, and assert performance profiles
  flow           Declarative multi-step pipeline orchestrator
  benchmark      Run full test battery with letter-grade scorecard
  tune           Tuning tests, each measuring one configuration

Analysis:
  report         View reports, export CSV/JUnit/Markdown/HTML
  trend          Historical performance trends with sparkline charts
  explain        Plain-English test narrative with verdict
  replay         Re-run a previous test with the same parameters
  scenario-diff  Compare scenario YAML against a test run
  gate           CI quality gate — exit non-zero if grade < threshold

Kafka Client:
  kafka          Interactive Kafka — brokers, topics, groups, produce, consume

Observability:
  dashboard      Full-screen monitoring dashboard (alias: dash)
  top            Live view of running tests (like kubectl top)
  watch          Live event stream of all Kates activity
  audit          Audit log of all mutating operations
  webhook        Manage test-completion webhook notifications
  cost           Estimate cloud costs for test configurations
  snapshot       Capture, compare, and diff cluster state
  changelog      Generate changelog from audit events
  badge          Generate status badges for README files

Toolbox:
  help           Help about any command
  init           Initialize workspace with config, scenarios, and CI gate
  test scaffold  Browse and export built-in scenario templates
  plugin         Discover and run external plugin commands
  tldr           Quick command reference cheatsheet
  docs           Man-style documentation for all commands
  theme          Manage CLI color themes
  look           Choose the CLI look: frames, tables, key hints
  mcp            Serve Kates to AI agents over MCP
  upgrade        Build and install a new version of the CLI

Configuration:
  ctx            Manage Kates server contexts (not kubectl contexts)
  ctx profiles   Show or choose the command profiles a context enables
  ports          Port-forward the Kates services to localhost
  completion     Shell auto-completion (bash, zsh, fish, powershell)

Disruption & Chaos:
  disruption     Run, list, and monitor disruption experiments
  chaos          Chaos experiment history and probe analysis
  resilience     Combined performance + chaos resilience testing
  schedule       Automated recurring test schedules

Security:
  security audit       Full security posture scan with A-F grading
  security tls         TLS protocol, cipher, and certificate inspection
  security auth-test   ACL authorization probing per user
  security pentest     Adversarial penetration tests
  security compliance  CIS Kafka, SOC2, PCI-DSS compliance report
  security baseline    Save security snapshot for drift detection
  security drift       Compare posture against saved baseline
  security gate        CI/CD gate — exit non-zero if below grade

Policy Engine (Kyverno):
  kyverno status       Show all ClusterPolicies with mode and rule counts
  kyverno violations   Pretty-print policy violations by namespace
  kyverno enforce      Switch a policy from Audit to Enforce mode
  kyverno audit        Switch a policy from Enforce to Audit mode

Deployment:
  deploy         Deploy the Kates stack (Kafka, Kates, chaos, monitoring)
  deploy status  Health of the deployed components
  compliance     Check the cluster against a reference architecture
  detect         Deep cluster compatibility report for Kafka
  auto           Auto-detect cluster config and deploy Kafka
  operators      Strimzi operators on this cluster
  versions       Strimzi and Kafka versions this cluster can run
  migrate        Cross-version Kafka migration with MirrorMaker 2
  clean          Remove every Kates-managed release and namespace

Flags:
  -o, --output     Output format: table or json
      --url        Override API URL for a single call
      --context    Use a named context for a single call
      --api-key    API key for authenticating with the server
  -h, --help       Show this help

Environment Variables:
  KATES_URL        Override API URL (lower priority than --url)
  KATES_OUTPUT     Override output format (lower priority than -o)
  KATES_CONTEXT    Override context (lower priority than --context)
  KATES_API_KEY    API key for authentication (lower priority than --api-key)
  KATES_PROFILES   Command profiles for this call; all enables every command

Examples:
  $ kates health
  $ kates test create --type LOAD --records 100000
  $ kates test apply -f scenario.yaml --wait
  $ kates lab
  $ kates advisor abc123
  $ kates flow run -f release-qual.yaml
  $ kates benchmark --records 50000
  $ kates gate --min-grade B --type STRESS
  $ kates cost estimate --records 1M --cloud aws

Docs & more:  kates <command> --help


Usage:
  kates [command]

Use "kates [command] --help" for more information about a command.