README
¶
KCP CLI
A command-line tool for planning and executing Kafka migrations to Confluent Cloud.
Scan existing Kafka deployments, generate migration plans and cost reports, create infrastructure-as-code assets, and execute end-to-end migrations with real-time monitoring.
Installation
[!CAUTION] Do not build from source for normal use. Install a released binary using the methods below instead. Source builds can contain breaking, untested changes.
kcp ships pre-built binaries with every GitHub release: macOS and Linux (amd64/arm64), and Windows (amd64).
macOS & Linux
Recommended — install script. Detects your OS and architecture, downloads the latest stable release, verifies its checksum, and installs it onto your PATH:
curl -fsSL https://raw.githubusercontent.com/confluentinc/kcp/main/install.sh | sh
To pin a specific version or change the install directory:
# Install a specific release
curl -fsSL https://raw.githubusercontent.com/confluentinc/kcp/main/install.sh | KCP_VERSION=v0.8.5 sh
# Install somewhere other than /usr/local/bin
curl -fsSL https://raw.githubusercontent.com/confluentinc/kcp/main/install.sh | KCP_INSTALL_DIR="$HOME/.local/bin" sh
Manual download. Prefer to do it by hand? Run uname -m if unsure of your architecture (arm64/aarch64 → arm64; x86_64 → amd64):
# Apple Silicon: darwin_arm64. Intel Mac: darwin_amd64. Linux: linux_amd64 or linux_arm64.
PLATFORM=darwin_arm64
LATEST_TAG=$(curl -s https://api.github.com/repos/confluentinc/kcp/releases/latest \
| grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
curl -L -o kcp "https://github.com/confluentinc/kcp/releases/download/${LATEST_TAG}/kcp_${PLATFORM}"
chmod +x kcp
sudo mv kcp /usr/local/bin/kcp
kcp version
Windows
- Download
kcp_windows_amd64.exefrom the latest release. - Rename it to
kcp.exe. - Create a folder to keep it in, for example
C:\Program Files\kcp, and movekcp.exethere. - Add that folder to your
PATHso you can runkcpfrom any terminal: open the Start menu, search for "Edit environment variables for your account", select Path, click Edit → New, paste the folder path, then OK. - Open a new PowerShell window (so it picks up the updated
PATH) and verify:
kcp version
Upgrading
kcp can update itself in place:
kcp update # check for and install the latest release
kcp update --check-only # report the latest version without installing
sudo kcp update # for system-wide installs (e.g. /usr/local/bin)
Contributing
This repository is public and open to community contributions. To build from source, run the tests, or submit a pull request, see CONTRIBUTING.md.
Resources and Support
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
gen-docs
command
Command gen-docs regenerates the per-command markdown reference under docs/assets/command-reference/ from the Cobra command tree.
|
Command gen-docs regenerates the per-command markdown reference under docs/assets/command-reference/ from the Cobra command tree. |
|
internal
|
|
|
build_info
Package build_info exposes ldflag-injected build metadata (Version, Commit, Date) and small derived helpers (IsDev, DocsURL) that depend on it.
|
Package build_info exposes ldflag-injected build metadata (Version, Commit, Date) and small derived helpers (IsDev, DocsURL) that depend on it. |
|
redact
Package redact removes sensitive values from connector configurations before they are persisted to the state file or written to logs.
|
Package redact removes sensitive values from connector configurations before they are persisted to the state file or written to logs. |
|
services/hcl/confluent
Package confluent: topic.go generates Terraform for plain Confluent Cloud topics (used by `kcp create-asset migrate-topics --mode new`).
|
Package confluent: topic.go generates Terraform for plain Confluent Cloud topics (used by `kcp create-asset migrate-topics --mode new`). |
|
services/iampolicy
Package iampolicy renders AWS IAM policy documentation for commands that have multiple variants (e.g.
|
Package iampolicy renders AWS IAM policy documentation for commands that have multiple variants (e.g. |
|
pkg
|
|
|
lib
Package lib is the stable bytes-in / bytes-out façade over kcp's state-processing and plan-generation pipelines.
|
Package lib is the stable bytes-in / bytes-out façade over kcp's state-processing and plan-generation pipelines. |