Reference

Commands

CLI commands, output directory behavior, filters, and command-specific flags.

Command Behavior

crd-schema-publisher [command]

Commands:
  run       Extract schemas and upload to Cloudflare Pages when credentials are configured (default)
  extract   Extract schemas from a Kubernetes cluster
  convert   Convert CRD YAML files and Kubernetes OpenAPI built-ins to JSON Schema
  upload    Upload the active site from OUTPUT_DIR/current to Cloudflare Pages
  watch     Watch for CRD changes and upload when credentials are configured
  preview   Serve a local preview of the documentation site
Command(s)Output directory behavior
extractRequires explicit --output-dir/-o or OUTPUT_DIR; does not fall back to /output.
convertRequires --output-dir/-o; does not read OUTPUT_DIR.
run, watch, uploadAccept --output-dir/-o; output root must already exist.
previewUses sample data by default; reads real extracted output only when --output-dir/-o is passed explicitly.
Command(s)Filters and command-specific flags
run, extract, watchSupport comma-separated, case-insensitive --kind, --group, and --version filters. Defaults can also come from SCHEMA_FILTER_KIND, SCHEMA_FILTER_GROUP, and SCHEMA_FILTER_VERSION.
run, extract, watchSupport --include-builtins/SCHEMA_INCLUDE_BUILTINS to include built-ins from the API server OpenAPI v2 document.
run, extract, watchSupport --include-kustomize/SCHEMA_INCLUDE_KUSTOMIZE to include kustomize’s client-side config schemas.
extractSupports --context, --base-path, and --skip-render.
convertSupports comma-separated, case-insensitive --kind, --group, and --version filters for CRD YAML and OpenAPI inputs.
convertSupports --file/-f, non-recursive --dir/-d YAML loading, optional --render, and --base-path for rendered links.
convert--openapi converts a Kubernetes OpenAPI v2 (swagger) document of built-in types into self-contained per-kind schemas, combinable with --file/--dir to render CRDs and built-ins into one site.
convert--kustomize explicitly publishes kustomize’s Kustomization and Component schemas, reflected from the pinned sigs.k8s.io/kustomize/api types. It is not filtered.