DECK(1)

✨ NAME ✨

deck β€” configuration management for Kong and Kong Enterprise πŸ¦πŸ‘‘

(and yes bestie, this is the section 1 manual page, DECK(1), so you already know it's a user command πŸ’…)


πŸ’– DESCRIPTION πŸ’–

okay so listen. decK helps you manage Kong clusters with a declarative configuration file. no clicking around in a UI, no vibes-based config drift, just a file that says what your world should look like 🌍✨

It can be used to export, import or sync entities to Kong. that's the whole personality, and it ate 🍽️

🫢 Usage:

deck [command]

πŸŽ€ Available Commands:

  • completion β€” Generate the autocompletion script for the specified shell. so you can stop typing the whole thing like a peasant ✨
  • diff β€” Diff the current entities in Kong with the on on disks. like a spot-the-difference but for your gateway πŸ”
  • dump β€” Export Kong configuration to a file. screenshotting your whole setup, but as config πŸ“Έ
  • help β€” Help about any command. the "bestie explain" button πŸ™‹β€β™€οΈ
  • ping β€” Verify connectivity with Kong. is anyone there?? πŸ‘€
  • reset β€” Reset deletes all entities in Kong. this is the nuclear option, more on that in a sec πŸ’€
  • sync β€” Sync performs operations to get Kong's configuration to match the state file. the main character of this whole operation πŸ‘‘
  • validate β€” Validate the state file. proofread before you post πŸ“
  • version β€” Print the version of decK. receipts, basically 🧾

🌸 Flags:

  • --ca-cert string β€” Custom CA certificate to use to verify Kong's Admin TLS certificate. This value can also be set using DECK_CA_CERT environment variable. πŸ”
  • --config string β€” config file (default is $HOME/.deck.yaml). your lil home base 🏠
  • --headers strings β€” HTTP Headers(key:value) to inject in all requests to Kong's Admin API. This flag can be specified multiple times to inject multiple headers. stack 'em, queen πŸ₯ž
  • -h, --help β€” help for deck 🫢
  • --kong-addr string β€” HTTP Address of Kong's Admin API. This value can also be set using DECK_KONG_ADDR environment variable. (default "http://localhost:8001") πŸ›°οΈ
  • --no-color β€” disable colorized output. for when you're feeling monochrome, no judgement 🌫️
  • --skip-workspace-crud β€” Skip API calls related to Workspaces (Kong Enterprise only). enterprise girlies only ✨
  • --tls-server-name string β€” Name to use to verify the hostname in Kong's Admin TLS certificate. This value can also be set using DECK_TLS_SERVER_NAME environment variable. πŸͺͺ
  • --tls-skip-verify β€” Disable verification of Kong's Admin TLS certificate. This value can also be set using DECK_TLS_SKIP_VERIFY environment variable. 🚨 (turning off cert verification means you're trusting whatever shows up, so like… be aware.)
  • --verbose int β€” Enable verbose verbose logging levels. Setting this value to 2 outputs all HTTP requests/responses between decK and Kong. yes it literally says "verbose verbose" and honestly, mood. level 2 is the full behind-the-scenes commentary track πŸŽ™οΈπŸ”₯
heads up bestie: reset deletes all entities in Kong. that is not a typo, that is the entire job description of that command. read twice, run once πŸ’€

And for anything else:

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

that's the whole page, no notes πŸ’œ ngl you're gonna slay your Kong config. go forth and sync, periodt. πŸ¦‹

this manual was brought to you by deck 1.4.0, dated December 2025 β€” see you in the next release, love u bye πŸŽ€βœ¨

πŸ“¦ where this page comes from