Confluent CLI Release Notes

Note that the Confluent CLI is continuously updated with improvements and new features. This page highlights significant user-facing features and updates to the interface.

[12/9/2024] Confluent CLI v4.13.2 Release Notes

Bug Fixes

  • Fix SSO login failure
  • Validate --environment for confluent flink artifact commands
  • Fix an issue causing confluent kafka topic [produce | consume] to fail on Windows when using the --api-key and --api-secret flag

[12/6/2024] Confluent CLI v4.13.1 Release Notes

Bug Fixes

  • Show the correct partition count in the output of confluent kafka topic update --config num.partitions=X
  • Do not notify of major version updates when there are only minor version updates
  • Fix an architecture error for confluent local kafka start
  • Prevent confluent asyncapi export from always failing when --consume-examples is passed
  • confluent flink shell now outputs a message and the statement name before submitting it for better progress output

[11/22/2024] Confluent CLI v4.13.0 Release Notes

New Features

  • Support confluent flink statement [update | resume] <name> with --principal and/or --compute-pool

Bug Fixes

  • Fix for Error: malformed body: Unsupported destination, supported value ["Kafka"] issue when running confluent custom-code-logging update
  • Improve the confluent flink statement [update | stop | resume] examples with more accurate descriptions

[11/20/2024] Confluent CLI v4.12.0 Release Notes

New Features

  • Add the “Mirror Partition States Count” field for confluent kafka link describe
  • [Early Access] Add confluent network access-point private-network-interface commands for managing private network interfaces
  • [Early Access] Add “private-network-interface” option for confluent network gateway create --type
  • [Early Access] Add “freight” option for confluent kafka cluster create --type
  • Add “tableflow” option for confluent api-key [create | list] --resource

[11/16/2024] Confluent CLI v4.11.0 Release Notes

New Features

  • General updates and improvements

[11/13/2024] Confluent CLI v4.10.0 Release Notes

New Features

  • Add --output flag for confluent flink environment [create | describe | update]
  • Add --environment flag for confluent flink artifact commands
  • Add new “Description” and “Documentation Link” fields for confluent flink artifact commands

Bug Fixes

  • Remove unsupported “human” option for the --output flag in the --help documentation of confluent flink application [create | describe | update]
  • Improve error messages for confluent flink application and confluent flink environment commands
  • confluent flink application web-ui-forward now works without the --url flag

[10/29/2024] Confluent CLI v4.9.0 Release Notes

New Features

  • Add confluent network gateway [create | delete | update] to manage gateways

Bug Fixes

  • Fix a bug preventing confluent kafka topic consume from consuming Avro, Protobuf, and JSONSchema messages correctly produced with CLI version 4.7.0 or earlier

[10/25/2024] Confluent CLI v4.8.0 Release Notes

New Features

  • Add support for client side field level encryption (CSFLE) feature for confluent kafka topic produce and confluent kafka topic consume
  • Added “LatestOffsets” and “LatestOffsetsTimestamp” fields to the flink statement describe and flink statement list commands

Bug Fixes

  • confluent asyncapi export now uses Kafka bootstrap urls for creating Kafka consumers

[10/9/2024] Confluent CLI v4.7.0 Release Notes

New Features

  • Add confluent flink application and confluent flink environment commands for managing on-premises Flink applications and environments
  • Add confluent kafka mirror truncate-and-restore

[10/4/2024] Confluent CLI v4.6.0 Release Notes

New Features

  • [Limited Availability] Add confluent iam certificate-authority and confluent iam certificate-pool commands to manage mTLS authentication

Bug Fixes

  • Update the confirmation prompt in confluent flink artifact delete to warn users that it might affect running statements

[9/27/2024] Confluent CLI v4.5.0 Release Notes

New Features

  • Add confluent flink statement update for updating a statement’s principal and compute pool, or stopping a statement
  • Add confluent provider-integration commands for managing provider integrations
  • Add on-premises support for Confluent Managed Flink (CMF) and Flink environments in confluent cluster register and confluent iam rbac role-binding commands
  • [Early Access] Add confluent connect custom-plugin version commands for managing custom Connect plugin versions

Bug Fixes

  • Default to “Essentials” Stream Governance package in confluent environment create
  • Use correct version number in module name
  • Allow confluent kafka cluster configuration commands to be used while logged out
  • No longer require --passphrase-new in confluent secret file rotate

[9/12/2024] Confluent CLI v4.4.0 Release Notes

New Features

  • Add confluent flink connection commands for managing Flink connections
  • Add --class to confluent flink artifact create

[9/6/2024] Confluent CLI v4.3.0 Release Notes

New Features

  • Add “Class”, “Cloud”, “Region”, and “Environment” to the confluent flink artifact commands
  • Add “Private Endpoint URL” and “Catalog Endpoint URL” to confluent schema-registry cluster describe

[8/27/2024] Confluent CLI v4.2.0 Release Notes

New Features

  • General updates and improvements

[8/26/2024] Confluent CLI v4.1.0 Release Notes

New Features

  • Add “Azure Private Endpoint Custom DNS Config Domains” field to confluent network access-point commands

[8/15/2024] Confluent CLI v4.0.0 Release Notes

Breaking Changes

  • Remove confluent schema-registry cluster [delete | enable | upgrade] and confluent schema-registry region list commands
  • Remove confluent context create command
  • Remove the configuration and partition-replica lists from confluent kafka topic describe for on-premises; these lists are now available through new on-premises confluent kafka topic configuration list and confluent kafka replica list commands
  • Remove the configuration and partition-replica lists from confluent local kafka topic describe; topic configurations are available through a new confluent local kafka topic configuration list command
  • Rename confluent schema-registry exporter get-config to confluent schema-registry exporter configuration describe
  • Rename confluent schema-registry exporter get-status to confluent schema-registry exporter status describe
  • Rename confluent schema-registry compatibility validate to confluent schema-registry schema compatibility validate
  • Rename confluent schema-registry config to confluent schema-registry configuration
  • Rename confluent kafka topic describe to confluent kafka topic configuration list for Confluent Cloud
  • Rename confluent kafka replica list to confluent kafka replica status list
  • Rename confluent kafka broker describe to confluent kafka broker configuration list
  • Rename confluent kafka broker update to confluent kafka broker configuration update
  • Rename confluent local kafka broker describe to confluent local kafka broker configuration list
  • Rename confluent local kafka broker update to confluent local kafka broker configuration update
  • Rename confluent price list to confluent billing price list
  • Rename confluent admin [payment | promo] subcommands to confluent billing [payment | promo] subcommands
  • Rename confluent kafka broker get-tasks to confluent kafka broker task list and remove the --all flag; this functionality is now implicit when no broker ID is provided
  • Remove the --all flag from confluent kafka broker describe; this functionality has been moved to a new on-premises confluent kafka cluster configuration list command
  • Remove the --all flag from confluent kafka broker update; this functionality has been moved to a new on-premises confluent kafka cluster configuration update command
  • Remove deprecated --api-key and --api-secret flags from all confluent schema-registry commands
  • Remove the --context flag from confluent environment use, confluent flink region use, confluent service-account use, and confluent kafka cluster use
  • Remove the --environment from confluent flink region use and confluent kafka cluster use
  • Replace the --schema flag for confluent schema-registry schema compatibility validate with a required argument
  • Replace the --name flag for confluent kafka quota create with a required argument
  • Replace the --name flag for confluent schema-registry kek create with a required argument
  • Rename --organization-id to --organization for confluent login
  • Rename --group-id to --group for confluent asyncapi export
  • Rename --kms-key-id to --kms-key for confluent schema-registry kek create
  • Rename --deleted to --all for confluent schema-registry subject describe and confluent schema-registry subject list
  • Rename --aws-account-id to --aws-account for confluent stream-share consumer redeem
  • Rename --azure-subscription-id to --azure-subscription for confluent stream-share consumer redeem
  • Rename --gcp-project-id to --gcp-project for confluent stream-share consumer redeem
  • Rename --config-name to --config for confluent kafka broker describe and confluent local kafka broker describe
  • Rename --provider to --cloud for confluent byok commands
  • Rename --ca-location and --ca-cert-path to --certificate-authority-path for all commands which use these flags
  • The --subject flag is now required for confluent schema-registry schema compatibility validate
  • The --type flag is now required for confluent schema-registry schema compatibility validate for Confluent Cloud
  • The --config flag is now required for confluent kafka topic update
  • The --passphrase and --passphrase-new flags are now required for confluent secret file rotate and no longer accept pipes or files
  • The --passphrase flag is now required for confluent secret master-key generate and no longer accepts pipes or files
  • The --config flag for confluent secret file add, confluent secret file remove, and confluent secret file update no longer accepts pipes or files
  • The broker ID is now a required argument for confluent kafka broker list and confluent kafka broker update
  • The API key and secret are now required arguments for confluent api-key store
  • Remove “Cloud Name” (human) and “cloud_name” (serialized) from the output of confluent kafka region list
  • Remove “Read-Only” (human) and “read_only” (serialized) from the output of confluent configuration commands
  • Rename “Name” to “ID” (human) and “name” to “id” (serialized) in the output of confluent plugin search; a new “Name” (human) and “name” (serialized) field has been added in its place
  • Rename “Kafka” to “Kafka Cluster” (human) and “kafka” to “kafka_cluster” (serialized) in the output of confluent ksql cluster commands
  • Rename “Schema Registry Secret” to “Schema Registry API Secret” (human) and “schema_registry_secret” to “schema_registry_api_secret” (serialized) in the output of confluent stream-share consumer redeem
  • Rename “Resource Display Name” to “Resource Name” (human) and “resource_display_name” to “resource_name” (serialized) in the output of confluent billing cost list
  • Rename “Provider” to “Cloud” (human) and “provider” to “cloud” (serialized) in the output of confluent kafka cluster describe
  • Rename “Service Provider” to “Cloud” (human) and “service_provider” to “cloud” (serialized) in the output of confluent kafka cluster list
  • Rename “Service Provider Region” to “Region” (human) and “service_provider_region” to “region” (serialized) in the output of confluent kafka cluster list
  • Rename “Schema ID” to “ID” (human) and “schema_id” to “id” (serialized) in the output of schema-registry schema list
  • Rename “Region Name” to “Name” (human) and “region_name” to “name” (serialized) in the output of “confluent kafka region list”
  • Rename “Region ID” to “Region” (human) and “region_id” to “region” (serialized) in the output of “confluent kafka region list”
  • Rename “Cloud ID” to “Cloud” (human) and “cloud_id” to “cloud” (serialized) in the output of “confluent kafka region list”
  • Rename “Resource ID” and “Environment ID” to “Resource” and “Environment” (human) and “resource_id” and “environment_id” to “resource” and “environment” (serialized) in the output of confluent billing cost list
  • Rename “Broker ID” to “Broker” (human) and “broker_id” to “broker” (serialized) in the output of confluent broker task list
  • Rename “Partition ID”, “Cluster ID” and “Leader ID” to “ID”, “Cluster” and “Leader” (human) and “partition_id”, “cluster_id” and “leader_id” to “id”, “cluster” and “leader” (serialized) in the output of confluent kafka partition [describe | list]
  • Rename “Private Link Attachment ID” to “Private Link Attachment” (human) and “private_link_attachment_id” to “private_link_attachment” (serialized) in the output of confluent network private-link attachment connection commands
  • Rename “Task ID” to “Task” (human) and “task_id” to “task” (serialized) in the output of confluent connect cluster describe
  • Rename “Plugin ID” and “Version ID” to “ID” and “Version” (human) and “plugin_id” and “version_id” to “plugin” and “version” (serialized) in the output of confluent flink artifact commands
  • Rename “Partition ID” to “Partition” (human) and “partition_id” to “partition” (serialized) in the output of confluent kafka partition reassignment list
  • Rename “ingress” and “egress” to “ingress_limit” and “egress_limit” in the serialized output of confluent kafka cluster commands
  • Rename “kafka_cluster_id” to “kafka_cluster” in the serialized output of confluent iam acl commands
  • Rename “cluster_id” to “cluster” in the serialized output of confluent broker task list
  • Rename “cluster_id” and “consumer_group_id” to “cluster” and “consumer_group” in the serialized output of confluent kafka consumer group [describe | list]
  • Rename “cluster_id”, “consumer_group_id”, “consumer_id”, “instance_id”, “client_id”, and “partition_id” to “cluster”, “consumer_group”, “consumer”, “instance”, “client”, and “partition” in the serialized output of confluent kafka consumer group lag [describe | list]
  • Rename “owner_id” and “resource_id” to “owner” and “resource” in the serialized output of confluent api-key [describe | list]
  • Rename “cluster_id”, “environment_id”, and “service_account_id” to “cluster”, “environment”, and “service_account” in the serialized output of confluent audit-log describe
  • Rename “cluster_id”, “environment_id”, and “service_account_id” to “cluster”, “environment”, and “service_account” in the serialized output of confluent connect event describe
  • Rename “source_cluster_id”, “destination_cluster_id”, and “remote_cluster_id” to “source_cluster”, “destination_cluster”, and “remote_cluster” in the serialized output of confluent kafka link [describe | list]
  • Rename “cluster_id”, “consumer_group_id”, “max_lag_consumer_id”, “max_lag_instance_id”, “max_lag_client_id”, and “max_lag_partition_id” to “cluster”, “consumer_group”, “max_lag_consumer”, “max_lag_instance”, “max_lag_client”, and “max_lag_partition” in the serialized output of confluent kafka consumer group lag summarize
  • Rename “cluster_id” to “cluster” in the serialized output of confluent kafka partition [describe | list]
  • Rename “cluster_id”, “partition_id”, and “broker_id” to “cluster”, “partition”, and “broker” in the serialized output of confluent kafka replica list
  • Rename “cluster_id” to “cluster” in the serialized output of confluent schema-registry cluster describe
  • Rename “cluster_id” to “cluster” in the serialized output of confluent kafka partition reassignment list
  • Rename “environment_id” to “environment” in the serialized output of confluent network commands
  • Rename “plugin_name” and “plugin_id” to “name” and “id” in the serialized output of confluent plugin list
  • Rename “consumer_group_id”, “consumer_id”, “instance_id”, and “client_id” to “consumer_group”, “consumer”, “instance”, and “client” in the serialized output of confluent kafka consumer list
  • The field “Network Zonal Subdomains” (human) and “network_zonal_subdomains” (serialized) in the output of confluent stream-share consumer redeem and confluent stream-share consumer share describe is now a map
  • The field “subtask_statuses” in the serialized output of confluent kafka broker task list is now a map
  • The field “config” in the serialized output of confluent schema-registry exporter describe is now a map
  • The field “kms_properties” in the serialized output of confluent schema-registry kek commands is now a map
  • The field principals in the serialized output of confluent kafka quota commands is now an array
  • The field “network_zones” in the serialized output of confluent stream-share consumer redeem and confluent stream-share consumer share describe is now an array
  • The field “Error Trace” (human) and “error_trace” (serialized) in the output of confluent schema-registry exporter status describe is now omitted when it is empty
  • The field “topic_count” in the serialized output of confluent kafka cluster describe is now omitted when it is empty
  • Remove unused “disable_updates”, “anonymous_id”, “no_browser”, and “ver” configuration fields
  • Rename the Windows-only configuration field “update_plugins_once” to “update_plugins_once_windows”
  • Legacy on-premises contexts are no longer supported; the Certificate Authority path must now be provided by flag or environment variable
  • The following deprecated environment variables are no longer supported: “CCLOUD_EMAIL”, “CCLOUD_PASSWORD”, “CONFLUENT_USERNAME”, “CONFLUENT_PASSWORD”, “CONFLUENT_MDS_URL”, and “CONFLUENT_CA_CERT_PATH”
  • Rename the CONFLUENT_PLATFORM_CA_CERT_PATH environment variable to CONFLUENT_PLATFORM_CERTIFICATE_AUTHORITY_PATH
  • confluent logout now revokes the refresh token when logging out of Confluent Cloud
  • Saved credentials will no longer be read from the .netrc file
  • CLI text highlighting is now enabled by default for new users
  • All confirmation prompts for resource delete and undelete commands are now yes/no prompts
  • The confluent login command will no longer automatically log in using saved credentials in the keychain or configuration file
  • On-premises login with confluent login will now print the confirmation code to the terminal and ask the user to confirm before opening a browser

New Features

  • Add new confluent kafka topic describe Confluent Cloud command in place of the renamed existing command
  • Add new confluent kafka replica list on-premises command in place of the renamed existing command
  • Add new confluent kafka broker describe on-premises command in place of the renamed existing command
  • Add new confluent local kafka broker describe command in place of the renamed existing command
  • Add confluent local kafka topic configuration list
  • Add confluent plugin uninstall
  • Add confluent kafka topic configuration list for on-premises
  • Add confluent kafka cluster configuration list for on-premises
  • Add confluent kafka cluster configuration update for on-premises
  • Add the “Internal” (human) and “internal” (serialized) field to the output of confluent kafka topic describe (for on-premises) and confluent local kafka topic describe
  • Add new “Name” (human) and “name” (serialized) field to the output of confluent plugin search in place of the renamed existing field

Bug Fixes

  • Improve error message in confluent flink statement list when compute pool cannot be found

[7/9/2024] Confluent CLI v3.65.0 Release Notes

New Features

  • Add confluent flink connectivity-type use to set the Flink connectivity type

Bug Fixes

  • The USE <catalog>.<database> command in confluent flink shell previously set an incorrect key/value pair in the config (catalog: database); now it sets the proper key/value pairs (sql.current-catalog: catalog, sql.current-database: database)

[6/25/2024] Confluent CLI v3.64.3 Release Notes

Bug Fixes

  • Fix an issue preventing on-premises users from refreshing SSO logins more than once

[6/21/2024] Confluent CLI v3.64.2 Release Notes

Bug Fixes

  • Fix missing --headers flag error in confluent local kafka topic produce

[6/13/2024] Confluent CLI v3.64.1 Release Notes

Bug Fixes

  • Loosen Linux glibc version restriction applied in last release
  • Fix static linking error on Windows
  • Allow confluent schema-registry dek create to be called without specifying --algorithm

[6/10/2024] Confluent CLI v3.64.0 Release Notes

New Features

  • [Early Access] Add confluent ai, an interactive AI assistant that can answer questions about Confluent Cloud

[6/3/2024] Confluent CLI v3.63.0 Release Notes

New Features

  • Add --runtime-language to confluent flink artifact create for specifying the language runtime for Flink user-defined functions (UDFs)

Bug Fixes

  • Fix a bug requiring an on-premises login to use confluent kafka commands which do not necessarily require a login
  • Show the correct expiration time in the “Expires At” field of confluent iam user describe on-premises

[5/30/2024] Confluent CLI v3.62.0 Release Notes

New Features

  • Add --headers to confluent kafka topic produce for specifying headers manually when producing messages
  • Support on-premises SSO authentication with confluent login
  • Add a new on-premises confluent iam user describe to display username and authentication token

Bug Fixes

  • Trim custom Kafka REST --url values properly

[5/16/2024] Confluent CLI v3.61.1 Release Notes

Bug Fixes

  • Fix an issue in confluent plugin install that prevented users from installing go plugins

[5/9/2024] Confluent CLI v3.61.0 Release Notes

New Features

  • Support passing offsets to confluent connect cluster create as part of the configuration file
  • Support creating Azure Egress Private Link endpoints in confluent network access-point private-link egress-endpoint create
  • Output the associated Azure Private Endpoint ID, Private Endpoint domain, and Private Endpoint IP address in confluent network access-point private-link egress-endpoint describe and confluent network access-point private-link egress-endpoint list
  • Output the associated Azure subscription in confluent network gateway describe and confluent network gateway list
  • Print a warning when a Confluent Cloud Kafka REST URL is passed to Confluent Platform Kafka REST

Bug Fixes

  • Prevent confluent connect offset delete, confluent connect offset update, and confluent connect offset status describe from crashing

[5/2/2024] Confluent CLI v3.60.0 Release Notes

New Features

  • Support “=” in the keys and values of SET commands in confluent flink shell
  • Add a warning including the statement retention time in confluent flink compute-pool delete

[4/25/2024] Confluent CLI v3.59.0 Release Notes

New Features

  • Add new “SET” option “client.output-format” to confluent flink shell supporting plain text mode

[4/18/2024] Confluent CLI v3.58.0 Release Notes

New Features

  • Add “Properties” and “Principal” fields to confluent flink statement describe

Bug Fixes

  • [Early Access] Exclude Flink UDF artifacts in confluent connect custom-plugin list

[4/11/2024] Confluent CLI v3.57.0 Release Notes

New Features

  • Support creating Azure Private Link attachments in confluent network private-link attachment create
  • Output the associated Azure Private Link Service alias and ID in confluent network private-link attachment describe and confluent network private-link attachment list
  • Support creating Azure Private Link attachment connections with confluent network private-link attachment connection create
  • Output the associated Azure Private Link Service alias and ID in confluent network private-link attachment connection describe and confluent network private-link attachment connection list
  • Add confluent network link commands for managing network link resources in Confluent Cloud
  • Add confluent network region command to list cloud provider regions for networking

[4/4/2024] Confluent CLI v3.56.0 Release Notes

New Features

  • [Early Access] Manage connector offsets with confluent connect offset
  • confluent connect plugin install no longer requires users to log in

[3/29/2024] Confluent CLI v3.55.0 Release Notes

New Features

  • Add confluent network access-point private-link egress-endpoint commands for managing Private Link egress endpoints in Confluent Cloud
  • Add confluent network dns record commands for managing DNS records in Confluent Cloud
  • Add confluent network gateway commands for managing gateways in Confluent Cloud
  • Improve error message when running confluent kafka consumer group lag commands without a dedicated Kafka cluster
  • [Early Access] confluent flink shell now uses the upsertColumns property when it’s available

[3/14/2024] Confluent CLI v3.54.0 Release Notes

New Features

  • Add confluent connect custom-plugin create --cloud
  • Add confluent connect custom-plugin list --cloud

[3/7/2024] Confluent CLI v3.53.0 Release Notes

New Features

  • [Early Access] Support QUIT statement in confluent flink shell

Bug Fixes

  • [Early Access] Support multibyte characters in the USE statement in confluent flink shell
  • Prevent confluent context update --kafka-cluster from crashing

[3/4/2024] Confluent CLI v3.52.0 Release Notes

New Features

  • [Early Access] confluent flink shell supports new key bindings: “Ctrl-D” deletes characters and only closes if the buffer is empty, “Alt-D” deletes words, “Alt-L” lowercases words, and “Alt-U” uppercases words
  • Add confluent network dns forwarder commands for managing DNS forwarders in Confluent Cloud
  • Add “Gateway” field to confluent network list and confluent network describe

Bug Fixes

  • [Early Access] Prevent confluent flink shell from crashing if statements are executed too quickly
  • [Early Access] Improve error message in confluent flink artifact create when uploading to a third-party API fails
  • Improve error message in confluent connect custom-plugin create when uploading to a third-party API fails

[2/26/2024] Confluent CLI v3.51.0 Release Notes

New Features

  • [Early Access] Support Ctrl + Left, Ctrl + Right and Ctrl + Backspace shortcuts on Windows in confluent flink shell
  • [Early Access] Support escaped characters for catalogs and databases set with “USE” in confluent flink shell
  • [Early Access] Down arrow can be used to enter the completion list in confluent flink shell

Bug Fixes

  • Fix a panic in confluent api-key use
  • Fix an issue in confluent kafka cluster configuration update --config that could cause a duplicate key error
  • Fix a bug causing confluent kafka link create and confluent kafka link configuration update to fail when the cluster link configuration “ssl.truststore.certificates” contains an explicit “n” character
  • [Early Access] Improve text visibility in the interactive output of confluent flink shell
  • [Early Access] Remove --flink-region flag from confluent iam rbac role-binding commands

[2/16/2024] Confluent CLI v3.50.0 Release Notes

New Features

  • Add “Idle Since” column to confluent network commands
  • Allow confluent local service commands to work with Java versions later than version 12

Bug Fixes

  • Avoid crash when reading configuration files on Windows
  • [Early Access] Fix crash when running confluent flink shell on Windows
  • [Early Access] Allow pending statements to be cancelled in confluent flink shell
  • Allow Confluent Platform users to use confluent kafka topic produce and confluent kafka topic consume without logging in
  • No longer require --ca-location for on-premises confluent kafka topic produce

[2/13/2024] Confluent CLI v3.49.0 Release Notes

New Features

  • Role bindings for users in confluent iam rbac role-binding list will now show the user’s name
  • [Early Access] Add confluent flink artifact lifecycle management commands

Bug Fixes

  • Fix a bug preventing role bindings with an SSO group mapping principal from displaying in confluent iam rbac role-binding list
  • Fix a bug causing an incorrect error message to be displayed in confluent iam rbac role-binding create and confluent iam rbac role-binding delete when the principal is an SSO group mapping
  • [Early Access] Fix crashes when using multi-byte characters in confluent flink shell

[1/18/2024] Confluent CLI v3.48.0 Release Notes

New Features

  • Add confluent kafka link task list for listing cluster link task information for Confluent Cloud and on-premises
  • Add confluent kafka mirror state-transition-error list for listing cluster linking mirror state transition errors
  • Add --governance-package flag to confluent environment create and confluent environment update
  • Add “Stream Governance Package” field to confluent environment commands
  • Add --output flag to confluent secret file rotate and confluent secret master-key generate

[1/11/2024] Confluent CLI v3.47.0 Release Notes

New Features

  • Use service account resource IDs instead of integer IDs in confluent ksql cluster configure-acls
  • Added confluent schema-registry dek commands for Schema Registry Data Encryption Key (DEK) management
  • Added confluent schema-registry kek commands for Schema Registry Key Encryption Key (KEK) management
  • Autocomplete confluent ksql cluster create --credential-identity
  • Add --context and --output to confluent connect custom-plugin create
  • [Early Access] Add statement name to title of interactive results view in confluent flink shell

Bug Fixes

  • Fix “no such file or directory” error when running a serialized consumer before producer

[1/4/2024] Confluent CLI v3.46.0 Release Notes

New Features

  • Add confluent kafka mirror reverse-and-start
  • Add confluent kafka mirror reverse-and-pause

[12/15/2023] Confluent CLI v3.45.0 Release Notes

New Features

  • [Early Access] Create Flink API keys with confluent api-key create --resource flink --cloud <cloud> --region <region>
  • [Early Access] Full Flink SQL autocomplete for confluent flink shell
  • [Early Access] Add “Environment” field to the output of the confluent flink compute-pool commands
  • [Early Access] Support Alt + Enter in confluent flink shell to trigger statement submission without needing to suffix the statement with a semicolon
  • [Early Access] Support Alt + Backspace in confluent flink shell to delete the previous word
  • Add confluent network commands for managing networking resources in Confluent Cloud
  • Add the --network flag to confluent kafka cluster create, confluent kafka cluster describe, and confluent kafka cluster list commands

Bug Fixes

  • Fix panic in confluent schema-registry schema describe

[12/6/2023] Confluent CLI v3.44.0 Release Notes

New Features

  • [Early Access] Add “Cloud” to the output of the confluent flink compute-pool commands

Bug Fixes

  • Fix a 401 Unauthorized bug for Confluent Platform confluent schema-registry commands
  • Fix “REQUIRED” annotations and logic in confluent shell

[12/4/2023] Confluent CLI v3.43.0 Release Notes

New Features

  • Add GCP support in confluent byok commands for customer-managed keys in Confluent Cloud
  • Removed --encryption-key in confluent kafka cluster create in favor of the --byok flag, which can be used to pass the ID of a customer-managed key when creating BYOK Kafka clusters in Confluent Cloud
  • [Limited Availability] Added confluent iam ip-group and confluent iam ip-filter commands

Bug Fixes

  • Fixed a panic in confluent kafka topic consume when user is not logged in

[11/16/2023] Confluent CLI v3.42.0 Release Notes

New Features

  • Display replication factor and partition count in confluent kafka topic list
  • Users can run confluent kafka topic produce and confluent kafka topic consume when not logged in to Confluent Cloud by passing in --bootstrap, --api-key and --api-secret

Bug Fixes

  • Fix panic in confluent kafka topic produce

[11/9/2023] Confluent CLI v3.41.0 Release Notes

New Features

  • Multiline support for confluent feedback

Bug Fixes

  • Resolved the “no such host” error when running confluent local kafka start with the latest version of Docker
  • Fix panic during HTTP retry

[11/2/2023] Confluent CLI v3.40.0 Release Notes

New Features

  • Support --value-format double in confluent kafka topic produce and confluent kafka topic consume

Bug Fixes

  • Refresh authentication token on HTTP retry, if needed

[10/19/2023] Confluent CLI v3.39.0 Release Notes

New Features

  • General updates and improvements

[10/12/2023] Confluent CLI v3.38.0 Release Notes

New Features

  • Add --print-offset to confluent kafka topic consume for printing the partition number and offset of each message

[10/5/2023] Confluent CLI v3.37.0 Release Notes

New Features

  • Optionally enable text highlighting with confluent configuration update enable_color true
  • Improve confluent asyncapi import output
  • Improve confluent kafka topic describe output for Confluent Platform

Bug Fixes

  • Resolve an issue causing confluent kafka topic produce to fail when using schema-based key formats with some delimiter choices

[9/28/2023] Confluent CLI v3.36.0 Release Notes

New Features

  • Add confluent kafka consumer group lag commands

[9/25/2023] Confluent CLI v3.35.0 Release Notes

New Features

  • Add confluent kafka consumer group describe
  • Add confluent kafka consumer group list
  • Add confluent kafka consumer list

Bug Fixes

  • Correctly format timestamps in YAML output

[9/21/2023] Confluent CLI v3.34.0 Release Notes

New Features

  • If available, display RBAC role binding ID in confluent iam rbac role-binding commands
  • Add confluent kafka partition describe and confluent kafka partition list cloud commands

Bug Fixes

  • Add the missing --output flag to confluent kafka link describe and remove the unused --force flag
  • Verify Java version at the beginning when running confluent local services start

[9/14/2023] Confluent CLI v3.33.0 Release Notes

New Features

  • Added confluent connect custom-plugin commands

Bug Fixes

  • Fix a bug in context decryption after running confluent context update --name
  • Fix a bug where custom connectors no longer require “connector.class” in confluent connect cluster create
  • Fix a panic that occurs when using confluent kafka topic consume --key-format with a schema-based key format

[9/7/2023] Confluent CLI v3.32.0 Release Notes

New Features

  • Add --jit-enabled to allow customer to toggle the JUST-IN-TIME for SSO enabled organization
  • Add --brokers flag in confluent local kafka start to allow starting a multi-broker Confluent Local instance
  • Add confluent local kafka broker command
  • Add confluent local kafka cluster configuration command

Bug Fixes

  • Fix a bug in confluent iam user invitation list where only the first 100 results were listed
  • Fix an issue causing confluent kafka topic consume to deserialize integers to incorrect values when using --key-format integer or value-format integer
  • Resolve a panic that could occur in confluent kafka topic consume when using --key-format integer and --print-key
  • --parse-key must now be specified when using confluent kafka topic produce --key-format

[9/5/2023] Confluent CLI v3.31.0 Release Notes

New Features

  • Add confluent iam service-account use and confluent iam service-account unset

Bug Fixes

  • Fix an incorrect URL causing confluent plugin search and confluent plugin install to fail

[8/24/2023] Confluent CLI v3.30.0 Release Notes

New Features

  • Add support for multiple arguments to delete commands

Bug Fixes

  • Resolve a panic in confluent iam rbac role-binding list
  • After session has timed out, correctly refresh credentials with environment variables or credentials saved with confluent login --save

[8/17/2023] Confluent CLI v3.29.0 Release Notes

New Features

  • Add --all to confluent kafka acl list to include deleted ACLs whose principals are integer IDs
  • Add confluent configuration commands for configuration file management
  • Add confluent schema-registry config delete command

Bug Fixes

  • Fix a flaky panic that occurred when pressing Ctrl-C in confluent kafka topic produce
  • Fix a panic that occurred when /dev/tty was inaccessible in confluent flink shell

[8/11/2023] Confluent CLI v3.28.0 Release Notes

New Features

  • confluent local services commands were dropped from v3.16.0 to v3.26.0, but are back as of v3.27.0 and will be supported until the next major version release (v4.0.0). These will be replaced by faster comparable commands with the syntax confluent local <name-of-service>. The first of these, confluent local kafka, is already present in the CLI.
  • Add support for both strings and files for the --config flag, in all relevant confluent kafka and confluent schema-registry commands
  • Support --key-format integer and --value-format integer in confluent kafka topic produce and confluent kafka topic consume

Bug Fixes

  • Resolve a panic that can happen when exiting confluent kafka topic produce with Ctrl-C on Windows
  • confluent kafka topic consume --group will start consuming from the offset that it exited with last time
  • Prevent errors for certain statuses in confluent kafka mirror describe and confluent kafka mirror list

[8/7/2023] Confluent CLI v3.27.0 Release Notes

New Features

  • Support --protocol PLAINTEXT in confluent kafka topic consume
  • Enable Schema Registry to be used without authentication on-premises, for the purpose of demos

Bug Fixes

  • Fix authentication issue in confluent kafka topic [produce | consume] on Windows
  • Fix panic in confluent api-key store --resource
  • Prevent “flag accessed but not defined” error in confluent schema-registry commands

[8/3/2023] Confluent CLI v3.26.0 Release Notes

New Features

  • Add --key-format, --key-schema, and --key-references to kafka topic produce
  • Add --key-format to kafka topic consume
  • Suggest updating with brew upgrade if installed with Homebrew

[7/27/2023] Confluent CLI v3.25.0 Release Notes

New Features

  • Add confluent feedback for user-submitted feedback
  • When authenticated with Confluent Cloud, no longer require an API key for Schema Registry operations
  • Add confluent kafka cluster configuration commands for managing dedicated cluster configurations

Bug Fixes

  • Correctly display Confluent Platform mirror topics in confluent kafka link list --include-topics
  • Fix confluent asyncapi import and confluent asyncapi export to follow AsyncAPI documentation for Kafka channel bindings, with explicit fields for bindingVersion, partitions, and topicConfiguration
  • Improve error message when no API secret is provided to confluent kafka client-config create

[7/21/2023] Confluent CLI v3.24.0 Release Notes

New Features

  • Allow changing default port numbers in confluent local kafka start with the --kafka-rest-port and --plaintext-port flags
  • Print progress while downloading Docker image in confluent local kafka start
  • Print the ports that Confluent Local is using when running confluent local kafka start
  • Autocomplete flags in confluent kafka client-config create commands
  • Add autocompletion to confluent kafka topic produce and confluent kafka topic consume
  • List and install plugins from the official Confluent CLI plugin repository with confluent plugin search and confluent plugin install

Bug Fixes

  • Fix autocompletion of --availability and --type flags in confluent kafka cluster create

[7/14/2023] Confluent CLI v3.23.0 Release Notes

New Features

  • Add a suggestion to use confluent kafka cluster when users run the on-premises confluent cluster command while logged in to Confluent Cloud
  • Support passing schema IDs to the --schema flag in confluent kafka topic produce

[7/13/2023] Confluent CLI v3.22.0 Release Notes

New Features

  • Improve the error message when a user runs an on-premises command while logged into Confluent Cloud
  • Bidirectional link support for confluent kafka link
  • No longer require passing the --resource flag to confluent api-key use

Bug Fixes

  • Prevent a panic when passing a non-existent Kafka cluster to confluent api-key store --resource
  • Fix “type” output in confluent schema-registry schema describe and properly format Avro schemas
  • Print an error message when confluent local kafka start is run from an AMD64 binary on an ARM64 machine

[7/6/2023] Confluent CLI v3.21.0 Release Notes

New Features

  • Add confluent pipeline create --use-schema-registry, and by default do not add Schema Registry to pipelines

Bug Fixes

  • Fix misleading error messages in confluent kafka topic consume

[6/29/2023] Confluent CLI v3.20.0 Release Notes

New Features

  • Autocompletion for confluent api-key create --resource
  • Add confluent kafka link describe

Bug Fixes

  • Fixes the 404 error when creating a role binding attached to an identity pool

[6/23/2023] Confluent CLI v3.19.0 Release Notes

New Features

  • Encrypt API key pair in context credentials

Bug Fixes

  • Fix permission issue while running confluent update in Docker image

[6/15/2023] Confluent CLI v3.18.0 Release Notes

New Features

  • Add confluent connect plugin install command to install Connect plugins for Confluent Platform
  • Support calling confluent environment describe without arguments
  • Autocomplete arguments in confluent service-quota list

Bug Fixes

  • Prevent panic while retrieving Schema Registry cluster information

[6/8/2023] Confluent CLI v3.17.0 Release Notes

New Features

  • Add confluent billing cost list

Bug Fixes

  • Fix confluent update checksum validation for Alpine Linux

[6/2/2023] Confluent CLI v3.16.0 Release Notes

New Features

  • Added new Docker-based confluent local commands for improved local testing of Confluent Platform

Bug Fixes

  • Removed unused --output flag in confluent kafka topic consume

[5/25/2023] Confluent CLI v3.15.0 Release Notes

New Features

  • Support topic prefixes ending with a wildcard (*) in confluent asyncapi export --topics
  • Update “num.partitions” for a Kafka topic with confluent kafka topic update --config

[5/18/2023] Confluent CLI v3.14.0 Release Notes

New Features

  • Publish with Homebrew
  • Add --metadata and --ruleset to confluent schema-registry schema create
  • Add --compatibility-group, --metadata-defaults, --metadata-overrides, --ruleset-defaults, and --ruleset-overrides to confluent schema-registry subject update

Bug Fixes

  • Fix decryption error when running non-authenticated commands
  • Correctly display mirror topics in confluent kafka link list --include-topics

[5/12/2023] Confluent CLI v3.13.0 Release Notes

New Features

  • Publish linux/arm64 Docker image

Bug Fixes

  • Allow plugins whose filepath starts with ~ to run
  • Fix service account error in confluent api-key create when audit logs are disabled

[5/4/2023] Confluent CLI v3.12.0 Release Notes

New Features
  • Add --topics flag to confluent asyncapi export to only export specified topics

[4/28/2023] Confluent CLI v3.11.0 Release Notes

New Features
  • Add a new --all flag to confluent schema-registry schema list to include soft-deleted schemas in the output
Bug Fixes
  • Schemas can now be permanently deleted with confluent schema-registry schema delete when using --version all

[4/13/2023] Confluent CLI v3.10.0 Release Notes

New Features
  • Add argument autocompletion for confluent iam, confluent kafka, and confluent pipeline commands
  • Support for topic partition count in confluent asyncapi export
  • Add --context flag to all confluent environment subcommands
Bug Fixes
  • Display a warning instead of an error if the topic count is not found in confluent kafka cluster describe
  • Allow more than 10 KSQL clusters to be listed in confluent ksql cluster list

[4/7/2023] Confluent CLI v3.9.0 Release Notes

New Features
  • Add argument autocompletion for confluent api-key describe
  • Add support for autocompleting multiple arguments for confluent connect cluster pause and confluent connect cluster resume
  • Add --ksql-cluster and --update-schema-registry to confluent pipeline update

[3/31/2023] Confluent CLI v3.8.0 Release Notes

New Features
  • Add confluent schema-registry region list command
Bug Fixes
  • Fix a bug on Windows preventing decryption of authentication tokens
  • Fix confluent update for Windows

[3/30/2023] Confluent CLI v3.7.0 Release Notes

New Features
  • Add confluent asyncapi import command
  • Add suggestions to check CLI’s access to /etc when encryption fails
  • Improve documentation for confluent iam acl commands
Bug Fixes
  • Correct filename autocompletion for avsc files

[3/23/2023] Confluent CLI v3.6.0 Release Notes

New Features
  • When specifying a file with a flag, auto-complete according to file extension
Bug Fixes
  • Prevent panics in confluent kafka cluster use and confluent api-key commands for users without an environment
  • Fixed a decryption error when running confluent context list with old contexts from ~/.confluent/config.json

[3/17/2023] Confluent CLI v3.5.2 Release Notes

Bug Fixes
  • Prevent a panic that could occur in various confluent api-key commands

[3/16/2023] Confluent CLI v3.5.1 Release Notes

Bug Fixes
  • Fix an issue where confluent schema-registry schema delete --permanent prevents permanent deletion of schema versions
  • Allow confluent kafka topic produce to run when using a context created with confluent context create
  • Ignore Protobuf schemas in confluent asyncapi export
  • Correctly propagate backend errors in confluent kafka quota list
  • Allow primitive Avro schemas in confluent asyncapi export

[3/7/2023] Confluent CLI v3.5.0 Release Notes

New Features
  • Add confluent organization describe, list, and update
Bug Fixes
  • Disable plugins by default on Windows, but allow manual re-enablement in ~/.confluent/config.json
  • Fix cipher: message authentication failed issue on Alpine image

[3/2/2023] Confluent CLI v3.4.0 Release Notes

New Features
  • Format JSON output in confluent schema-registry schema describe
  • Add the --use flag to confluent api-key create to select an API key after it has been created
  • Add jq to Docker image
  • Update description of confluent login --save to mention that credentials will also be saved to keychain on macOS
  • Improve error messages for when a Kafka cluster is deleted from outside of the CLI
  • Display a warning message when a command requires an active environment, but no environment is selected
Bug Fixes
  • Ignore the “Current” column when sorting the output of list commands
  • Prevent empty flag values from being passed in confluent price list
  • Validate nonce length to avoid a panic while encrypting or decrypting login credentials
  • Prevent a panic that could occur when using commands with the --environment flag
  • Fix examples for on-prem confluent kafka acl create
  • Use $PATHEXT to correctly determine if a plugin is executable on Windows

[2/23/2023] Confluent CLI v3.3.0 Release Notes

New Features
  • Add confluent byok (Bring Your Own Key) commands for customer-managed keys in Confluent Cloud
Bug Fixes
  • Resolve a panic that could occur in confluent api-key list

[2/21/2023] Confluent CLI v3.2.1 Release Notes

Bug Fixes
  • Fix a panic that could occur in confluent asyncapi export when using protobuf schemas
  • Fix an issue preventing users from successfully using confluent login in a Docker container
  • Fix a panic that could occur in confluent schema-registry cluster describe
  • Update ingress/egress limits to correct values in confluent kafka cluster describe

[2/17/2023] Confluent CLI v3.2.0 Release Notes

Breaking Changes
  • Confluent Cloud sign-up in the CLI has been removed. confluent cloud-signup now opens the sign-up page in the user’s browser
New Features
  • Encrypt authenticated context and login credentials on local storage
Bug Fixes
  • Fixed an issue in confluent api-key list. Users with DeveloperRead/Write/Manage roles can list API keys to which they have access.
  • The Kafka cluster name is not updated when it’s not specified in confluent kafka cluster update

[2/9/2023] Confluent CLI v3.1.1 Release Notes

Bug Fixes
  • Fix panic in confluent kafka link list
  • Fix inefficiencies while searching $PATH for plugins
  • Standardize flag value format across all examples

[2/3/2023] Confluent CLI v3.1.0 Release Notes

New Features
  • confluent plugin list will now display an error if plugins are disabled
  • Add informative examples of the --inclusive flag in confluent iam rbac role-binding list
Bug Fixes
  • Fix an issue causing confluent iam rbac role-binding create to display an error despite successfully creating the role-binding when the principal is a service account

[1/31/2023] Confluent CLI v3.0.1 Release Notes

Bug Fixes
  • Fix a bug causing the “Activation Privilege” field to always show “false” in the output of confluent pipeline commands
  • Fix issues in confluent iam rbac role-binding list which could cause a “400 Bad Request” error when listing role bindings for a service account
  • Various updates to the formatting of error messages and examples

[1/25/2023] Confluent CLI v3.0.0 Release Notes

Confluent CLI is now source-available under the Confluent Community License. For more details, check out the Announcing the Source Available Confluent CLI blog post.

Breaking Changes
  • Default to HTTPS for on-prem login with confluent login
  • Require acknowledgment before deleting any resource, and use --force flag to skip acknowledgment
  • Use correct and consistent JSON and YAML formatting across all commands
  • Remove leading “v” from archive names, so the format matches binary names
  • Place asterisk in “Current” column in confluent api-key list, confluent environment list, and confluent kafka list
  • Delete confluent ksql app commands in favor of confluent ksql cluster commands
  • In confluent iam rbac role-binding list, combine “Service Name” and “Pool Name” into “Name”
  • In confluent iam rbac role-binding list, require the --inclusive flag to list role bindings in nested scopes
  • Move Connect cluster management commands under confluent connect cluster
  • Prevent using numeric IDs for confluent kafka acl commands
  • Print a table instead of a list in confluent schema-registry compatibility validate and confluent schema-registry config describe
  • Remove the “KAPI” field, “API Endpoint” field, and the corresponding --all flag from confluent kafka cluster describe
  • Remove shorthand flags: -D, -P, -r, -S, and -V
  • Rename “Exporter” to “exporter” in serialized output for confluent schema-registry exporter list
  • Rename “task” to “tasks” in confluent connect cluster describe
  • Rename --current-env to --current-environment
  • Rename --no-auth to --no-authentication
  • Rename --operation to --operations where appropriate
  • Rename --refs to --references
  • Rename --show-refs to --show-references
  • Rename --sr-apikey and --sr-api-key to --schema-registry-api-key
  • Rename --sr-apisecret and --sr-api-secret to --schema-registry-api-secret
  • Rename --sr-endpoint to --schema-registry-endpoint
  • Rename confluent audit-log migrate config to confluent audit-log config migrate
  • Rename confluent kafka link describe to confluent kafka link configuration list
  • Rename confluent kafka partition get-reassignments to confluent kafka partition reassigments list
  • Rename values for confluent price list --cluster-type
  • Replace all instances of “First Name” and “Last Name” with “Full Name”
  • Require --environment in confluent schema-registry cluster delete
New Features
  • Use Kafka REST for all confluent kafka commands
  • Remove login requirement for confluent secret commands
  • Add “Read Only” column to confluent kafka topic describe
  • Add detailed Kafka REST examples for confluent kafka acl commands

[5/17/2023] Confluent CLI v2.38.1 Release Notes

Bug Fixes
  • Encrypt authenticated context and login credentials on local storage

[1/12/2023] Confluent CLI v2.38.0 Release Notes

New Features
  • Add --activation-privilege flag to confluent pipeline update
  • Add “Secret Names” field to confluent pipeline commands
  • Improve examples for confluent iam rbac role-binding create

[12/15/2022] Confluent CLI v2.37.0 Release Notes

New Features
  • Add --ksql-cluster flag in confluent iam role-binding and confluent iam role
Bug Fixes
  • Resolve panic when logging in to Confluent Cloud without a valid role binding or environment
  • Print missing “KafkaRestProduce” metric in confluent price list

[12/8/2022] Confluent CLI v2.36.0 Release Notes

New Features
  • Add --schema-registry-cluster-id to confluent iam rbac role-binding commands
  • Add “Free Schemas Limit” field to confluent schema-registry cluster describe

[12/2/2022] Confluent CLI v2.35.0 Release Notes

New Features
  • Add a disable_feature_flags option to the configuration file
Bug Fixes
  • Fix an issue in confluent asyncapi export which could cause repeated topic descriptions

[11/29/2022] Confluent CLI v2.34.0 Release Notes

New Features
  • Add warning about required privileges to confluent ksql cluster create
  • Update on-prem examples for confluent kafka topic commands
Bug Fixes
  • Fix a bug causing repeated tags in confluent asyncapi export
  • Fix bug in confluent iam rbac role-binding create that could prevent creation when using the --resource flag
  • Fix empty list bug in confluent iam rbac role-binding list when using the --resource flag

[11/17/2022] Confluent CLI v2.33.0 Release Notes

New Features
  • Export AsyncAPI specification files with confluent asyncapi export
Bug Fixes
  • Show logical KSQL cluster IDs in confluent iam rbac role-binding list
  • Fix HTTP status code error in confluent ksql cluster configure-acls
  • Fix 0 partition error in confluent kafka topic create

[11/15/2022] Confluent CLI v2.32.1 Release Notes

Bug Fixes
  • Fix replication factor error in confluent kafka topic create
  • Print mirror topic name instead of source topic name in confluent kafka mirror create

[11/3/2022] Confluent CLI v2.32.0 Release Notes

New Features
  • Improve error messages when users provide an incorrectly formatted Kafka cluster ID
Bug Fixes
  • Fix CLI panic when setting environment in configuration

[10/27/2022] Confluent CLI v2.31.0 Release Notes

New Features
  • Allow multiple connectors to be paused and resumed at once
  • Allow all flags accepting lists to accept comma-separated lists of strings
  • Add --environment flag to confluent api-key list
  • Verify that a cluster exists before unregistering it with confluent cluster unregister
Bug Fixes
  • Only check for plugins in top-level directories within $PATH
  • Fix index out of range error in confluent ksql cluster configure-acls
  • Allow users with no role bindings to log in
  • Fix race condition during in-browser SSO login
  • Allow password prompt to be interrupted with Ctrl+C
  • Fix misleading error message in confluent api-key store

[10/21/2022] Confluent CLI v2.30.1 Release Notes

Bug Fixes
  • Fix an app notarization issue affecting Darwin builds

[10/21/2022] Confluent CLI v2.30.0 Release Notes

New Features
  • Add confluent schema-registry schema list
Bug Fixes
  • Fix an issue preventing confluent kafka cluster describe from being called on a provisioning cluster
  • Improve error messaging in confluent kafka topic and confluent kafka acl commands
  • Fix panic that could occur in some confluent kafka commands

[10/13/2022] Confluent CLI v2.29.0 Release Notes

New Features
  • Show more detailed error message in confluent api-key use

[5/3/2023] Confluent CLI v2.28.2 Release Notes

Bug Fixes
  • Encrypt authenticated context and login credentials on local storage

[10/6/2022] Confluent CLI v2.28.1 Release Notes

Bug Fixes
  • Fix “unspecified resource type” error when describing or deleting Kafka ACLs

[10/3/2022] Confluent CLI v2.28.0 Release Notes

New Features
  • General updates and improvements

[9/29/2022] Confluent CLI v2.27.0 Release Notes

New Features
  • Confluent CLI is now available for Linux and Alpine Linux on ARM64 architecture
  • Added Topic Count field in confluent kafka cluster describe and confluent kafka cluster update
Bug Fixes
  • The Error field in confluent kafka link list will now be empty instead of printing NO_ERROR when the link is not in an error state

[9/22/2022] Confluent CLI v2.26.0 Release Notes

New Features
  • Display State, Error and Error Message in confluent kafka link list
  • Show more detailed error messages for Confluent Cloud API routes

[9/13/2022] Confluent CLI v2.25.0 Release Notes

New Features
  • Add confluent environment describe
  • Add confluent api-key describe
  • The -vvv flag now notifies the user that $PATH is recursively searched for plugins
Bug Fixes
  • Fix the example for confluent kafka acl create
  • Allow deletion of ksqlDB clusters that failed to provision

Note

The new CLI plugins functionality, introduced in v2.24.0, searches your entire $PATH and can cause slow response time.

If you are experiencing CLI commands hanging, set the following in the ~/.confluent/config.json file to disable the plugins:

"disable_plugins": true

[8/22/2022] Confluent CLI v2.24.2 Release Notes

Bug Fixes
  • Fix 404 error for kafka acl commands
  • Fix non-root user in Docker image

[8/21/2022] Confluent CLI v2.24.1 Release Notes

Bug Fixes
  • --unsafe-trace works with every command that uses HTTP
  • Fix panic that could occur when user was unauthenticated

[8/18/2022] Confluent CLI v2.24.0 Release Notes

New Features
  • Added plugin framework and confluent plugin list command
  • Signed Windows binaries
  • Add non-root user to Dockerfile
  • Added examples for confluent login
  • Warn when updating read-only topic configurations in confluent kafka topic update
Bug Fixes
  • Add global --unsafe-trace flag
  • Netrc auto-login should use the current context
  • Update command list on login in confluent shell
  • Prevent error when fetching Kafka cluster from within an API key context
  • Improve error messages in confluent kafka topic create

[7/28/2022] Confluent CLI v2.23.0 Release Notes

Bug Fixes
  • Correctly identify Confluent Cloud contexts created with confluent context create
  • Fix panic when running confluent local services connect start without “plugin.path”

[7/20/2022] Confluent CLI v2.22.0 Release Notes

New Features
  • Add confluent iam user update
  • Add --package flag to confluent schema-registry cluster enable --package
  • Add confluent schema-registry cluster upgrade
  • Improve error message when trying to delete a cluster with active connectors
  • Add “Detailed Processing Log” field to confluent ksql cluster create and confluent ksql cluster describe
  • Add “Usage” field to confluent service-quota list
Bug Fixes
  • Properly identify organizations on free trial
  • Fix panic when creating kSQL API keys with confluent api-key create exceeds the quota
  • Reformat error message when shrinking a cluster by more than 1 CKU in confluent kafka cluster update

[7/11/2022] Confluent CLI v2.21.0 Release Notes

New Features
  • Add confluent iam service-account describe
  • Show more detailed error messages for Confluent Cloud API routes
Bug Fixes
  • Fix issue where organizations are marked as suspended, even after being reactivated

[6/30/2022] Confluent CLI v2.20.0 Release Notes

New Features
  • Support --dry-run and --no-validate flags for confluent kafka link create
Bug Fixes
  • Refresh cached Kafka cluster metadata on a weekly basis, instead of infinitely

[5/8/2023] Confluent CLI v2.19.1 Release Notes

Bug Fixes
  • Encrypt authenticated context and login credentials on local storage

[6/23/2022] Confluent CLI v2.19.0 Release Notes

New Features
  • Improve free remaining credit message in confluent login and confluent cloud-signup

[6/16/2022] Confluent CLI v2.18.0 Release Notes

New Features
  • Show service account role bindings in confluent iam role-binding list
  • Improve examples for confluent ksql cluster create
  • Make errors more descriptive in confluent api-key create
  • Add “Service Provider Region” and “Package” fields to confluent schema-registry cluster describe
  • Add --source-topic flag to confluent kafka mirror topic create
Bug Fixes
  • Allow configuration values to contain commas in --config

Confluent CLI v2.17.2 Release Notes

Bug Fixes
  • When running confluent update, Alpine Linux users will update to a statically-linked CLI build, while other users will update to a dynamically-linked CLI build. See Prerequisites for details.
  • On Alpine Linux, you cannot use confluent update to update from Confluent CLI versions earlier than v2.17.2. The confluent update command works for v2.17.2 or later. From the older versions, use curl or tarball installation to update to the latest version. See Install Confluent CLI for details.

Confluent CLI v2.17.1 Release Notes

New Features
  • When running confluent update, Alpine Linux users will update to a statically-linked CLI build, while other users will update to a dynamically-linked CLI build.

Confluent CLI v2.17.0 Release Notes

New Features
  • Allow suspended users to connect a credit card and redeem promo codes
  • Add confluent schema-registry cluster delete
Bug Fixes
  • Improve error message when running confluent kafka topic produce <topic> --value-format without a schema path or schema ID specified

Confluent CLI v2.16.0 Release Notes

New Features
  • Retry 5 times if request fails in a subset of commands.
  • Add --offset flag to confluent kafka topic consume command, allowing users to set an offset from the beginning to consume from
  • Add --partition flag to confluent kafka topic consume command, allowing users to consume from a certain partition of topic
Bug Fixes
  • Fix environment not found in context error when passing audit log or connect event environment via --environment flag
  • Remove the null byte prepended to messages when running confluent kafka topic consume command without a schema

Confluent CLI v2.15.1 Release Notes

Bug Fixes
  • Resolve auth token refresh failure for a group of SSO users

Confluent CLI v2.15.0 Release Notes

New Features
  • Add the ability to disable cloud features in the event of a security incident
  • Clarify that confluent login --save should not be used with SSO login

Confluent CLI v2.14.0 Release Notes

New Features
  • Added confluent schema-registry exporter commands for Confluent Platform
  • Return a more specific error message if resource quota limits are exceeded
Bug Fixes
  • Ignore redundant --save flag at confluent login for SSO users

Confluent CLI v2.13.2 Release Notes

Bug Fixes
  • Fix panic on confluent login when user context is not defined

Confluent CLI v2.13.1 Release Notes

Bug Fixes
  • If user is already authenticated with a username and password, confluent login will prompt for new credentials instead of refreshing the existing session

Confluent CLI v2.13.0 Release Notes

New Features
  • Automatically refresh sessions, keeping users logged in while the CLI is in use
  • Add --principal flag to confluent kafka acl commands for filtering by service account or user
  • Add --config, --config-file, and --schema-id flags to confluent kafka topic produce and confluent kafka topic consume
  • Improve documentation for confluent kafka topic, confluent ksql, and confluent secret
Bug Fixes
  • Fix typos in various command descriptions

Confluent CLI v2.12.0 Release Notes

New Features
  • Let --kafka-cluster-id imply --cloud-cluster in confluent iam rbac role-binding list
  • In confluent schema-registry describe optionally print the entire schema graph
Bug Fixes
  • Add dataplane roles to suggestion message in iam rbac role describe
  • Delete temporary schema directories after producing or consuming
  • Remove redundant log messages during API pagination

Confluent CLI v2.11.0 Release Notes

New Features
  • Add --full-header flag to confluent kafka topic consume to print untruncated message headers
  • Add support for source-initiated cluster links in Confluent Cloud
Bug Fixes
  • Validate --geo flag values when creating Schema Registry clusters
  • Show all available roles with confluent iam rbac role list
  • Fix error message when resizing a Kafka cluster

Confluent CLI v2.10.1 Release Notes

Bug Fixes
  • Add back -D shorthand for --deleted flag in schema-registry subject describe

Confluent CLI v2.10.0 Release Notes

New Features
  • New commands for Confluent Cloud: schema-registry compatibility and schema-registry config
  • New commands for Confluent Platform: schema-registry compatibility, schema-registry config, schema-registry subject, and schema-registry schema
Bug Fixes
  • Fix bug where locally stored API key could be cleared
  • Refresh SSO tokens on auto-login

Confluent CLI v2.9.0 Release Notes

New Features
  • Migrated to new APIs that support faster cluster provisioning
Bug Fixes
  • Fixed issue that prevented HTTPS_PROXY environment variable from having an effect
  • Fixed incorrect options for updating Schema Registry subject modes
  • Improved error messages and help examples

Confluent CLI v2.8.1 Release Notes

New Features
  • Show user email, organization name, and organization ID on login
Bug Fixes
  • Show the correct email when listing API keys for users with dataplane roles

Confluent CLI v2.8.0 Release Notes

New Features
  • confluent service-quota list command for Confluent Cloud
  • Add schema ID field in confluent schema-registry schema describe output
Bug Fixes
  • Fix parsing of quoted flag values and arguments in confluent shell
  • Fix parsing of multi-value flags in confluent shell
  • Fix error with protobuf schema references for produce and consume commands

Confluent CLI v2.7.0 Release Notes

New Features
  • Added confluent kafka client-config commands
  • Improved logging for produce and consume commands, and during SSO login
  • Added support for multiline properties in cluster link configuration files
Bug Fixes
  • Fixed capitalization in human-readable output

Confluent CLI v2.6.2 Release Notes

Bug Fixes
  • Encrypt authenticated context and login credentials on local storage

Confluent CLI v2.6.1 Release Notes

New Features
  • Improved cipher algorithm used for secret command
Bug Fixes
  • Fix issue with updating cluster links

Confluent CLI v2.6.0 Release Notes

New Features
  • Verify checksums during confluent update
  • Enforce TLS 1.2 or greater
  • Added organization ID to login message
  • Produce and consume support for Confluent Platform
  • Add kafka link commands for Confluent Platform
Bug Fixes
  • Allow colons in role binding subject resources
  • Improve error when logging in to a suspended org

Confluent CLI v2.5.1 Release Notes

Bug Fixes
  • List ACLs created with service account resource IDs in kafka acl list
  • Improve suggestion when API key is not recognized as valid

Confluent CLI v2.5.0 Release Notes

Breaking Changes
  • Due to backend changes, the --dry-run and --no-validate flags in the kafka link create commands no longer have an effect. Deprecation notices are added to the flag descriptions.
New Features
  • Improved shell completions for bash and zsh
  • Add ksql cluster commands and add deprecation warnings to ksql app commands
Bug Fixes
  • Fix potential panic in kafka cluster describe
  • Fix potential request failures for users with large number of resources
  • Improvements to error and help messages

Confluent CLI v2.4.0 Release Notes

New Features
  • Add support for logging into specific Confluent Cloud organizations
  • Update librdkafka to 1.8.2
  • Don’t show deactivated users (or those with expired invitations) in role binding list command
  • Add on-prem replica management commands
  • Improved version of confluent shell command
  • Add autocompletion support for remaining command flags (--api-key, --context, --environment)
Bug Fixes
  • Fix issue where CLI would not show additional information with verbosity flags set (-v, -vv, -vvv, -vvvv)
  • Return error if SSO user enters different emails in CLI prompt and their SSO provider
  • Fix regression in --ca-cert-path flag so that it uses absolute filepaths
  • Check whether service account exists before attempting to create or delete a Kafka ACL
  • Add friendlier error messages for RBAC commands

Confluent CLI v2.3.1 Release Notes

Bug Fixes
  • Show the correct error for confluent api-key list and confluent audit-log describe if audit logs are disabled for an organization

Confluent CLI v2.3.0 Release Notes

New Features
  • Expand existing autocompletion functionality to include many command arguments and flags
  • Add built-in aliases for several long command names
  • Add reference support for JSON and protobuf in schema producer and consumer
  • Add --subject-format flag to schema-registry exporter commands
  • Notify user when ksqlDB cluster provisioning fails
  • Add extra validation logic for login URLs
  • Warn Confluent Platform users before enabling updates
Bug Fixes
  • Create audit log API keys using the correct service account
  • Err if a process is already listening on the SSO callback port
  • Fix panic when autocompleting service-account commands in confluent shell

Confluent CLI v2.2.0 Release Notes

New Features
  • Properly label “PAUSED” ksqlDB clusters
Bug Fixes
  • Fix Windows failures due to missing pthreads library
  • NOTE: Users of confluent v2.0.0, v2.1.0, or v2.1.1 must manually update to this version with curl -sL https://cnfl.io/cli | sh -s -- -b $(dirname $(which confluent))

Confluent CLI v2.1.0 Release Notes

New Features
  • Restore partition count field when describing a topic’s configuration
  • Show success message when deleting a service account
  • Allow CONFLUENT_PLATFORM_MDS_URL and CONFLUENT_PLATFORM_CA_CERT_PATH to be used with confluent cluster describe
Bug Fixes
  • Fix issue with listing pending user invitations
  • Fix issue with logging into SSO-enabled organizations when user is not already logged in
  • Only auto-login to the current context
  • Update description of confluent prompt
  • Hide confluent iam acl commands when logged into a cloud context

Confluent CLI v2.0.0 Release Notes

Breaking Changes
  • WARNING: If you are updating from a prior Confluent CLI v1.x client, note that this version is NOT interoperable with Confluent Platform v7.0 or earlier. See Supported Versions and Interoperability for full details on CLI client to Confluent Platform interoperability.
  • If you are updating from the Confluent Cloud CLI, the client name will change to confluent with this version.
  • See Migration Guide for a full list of breaking changes and details regarding differences from v1.x.
New Features

  • This version of Confluent CLI supports both Confluent Cloud and Confluent Platform management.

    To use Confluent CLI v2.0 for Confluent Cloud, sign up with confluent cloud-signup or authenticate with confluent login.

Confluent CLI v1.43.2 Release Notes

Bug Fixes
  • Encrypt authenticated context and login credentials on local storage

Confluent CLI v1.43.1 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.43.0 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.42.0 Release Notes

Bug Fixes
  • Fix 404 error in confluent kafka acl list

Confluent CLI v1.41.0 Release Notes

New Features
  • Add support for managing brokers and partitions

Confluent CLI v1.40.2 Release Notes

Bug Fixes
  • Encrypt authenticated context and login credentials on local storage

Confluent CLI v1.40.1 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.40.0 Release Notes

Bug Fixes
  • Fix issues when changing directories after logging in with a custom CA cert path
  • Make confluent iam rolebinding list support filtering by resource
  • Fix confluent iam rolebinding list when no role is specified

Confluent CLI v1.39.1 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.39.0 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.38.0 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.37.1 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.37.0 Release Notes

Bug Fixes
  • Improved error messaging and help output

Confluent CLI v1.36.0 Release Notes

Bug Fixes
  • Fix the issue of inserting + for whitespace in iam rolebinding parameters

Confluent CLI v1.35.0 Release Notes

New Features
  • Performance improvements
Bug Fixes
  • Show all new release notes on CLI update

Confluent CLI v1.34.0 Release Notes

New Features
  • Kafka ACL management via Confluent REST Proxy
Bug Fixes
  • Fix logout panic when removing netrc entry

Confluent CLI v1.33.0 Release Notes

New Features
  • Remove credentials from .netrc file when logout command is run
  • Move non-interactive login/environment messages to debug-level printouts to stderr
Bug Fixes
  • Fix supporting custom home directories specified via the $HOME environment variable

Confluent CLI v1.32.0 Release Notes

Bug Fixes
  • Fix iam acl create bug for User principals with @ symbol

Confluent CLI v1.31.0 Release Notes

New Features
  • Increase default number of metadata key iterations from 1000 to 10000

Confluent CLI v1.30.0 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.29.0 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.28.1 Release Notes

Bug Fixes
  • Fix bug where update command fails to find some versions

Confluent CLI v1.28.0 Release Notes

New Features
  • Improved help text and examples

Confluent CLI v1.27.0 Release Notes

New Features
  • Build and release darwin/arm64 binaries and archives

Confluent CLI v1.26.0 Release Notes

New Features
  • Topic management commands via Confluent REST Proxy API
Bug Fixes
  • Use CONFLUENT_MDS_URL and CONFLUENT_CA_CERT_PATH for login command when set
  • Require --role flag for iam rolebinding delete command

Confluent CLI v1.25.0 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.24.0 Release Notes

New Features
  • Non-interactive login
  • CONFLUENT_MDS_URL and CONFLUENT_CA_CERT_PATH environment variable support

Confluent CLI v1.23.0 Release Notes

Bug Fixes
  • Better handling of --ca-cert-path flag for saved logins

Confluent CLI v1.22.0 Release Notes

New Features
  • Stateless mode
  • Support self-signed certs for confluent cluster describe
Bug Fixes
  • Fix confluent local services start bug for Centos
  • Fix no newline bug when auto injected configs are appended to manually added configs for confluent local commands

Confluent CLI v1.21.1 Release Notes

New Features
  • Fix case where wrong ca-cert-path might be used when logging in

Confluent CLI v1.21.0 Release Notes

New Features
  • --prompt flag for login command to bypass non-interactive login
Bug Fixes
  • Fix automatic update of auth tokens for username/email with special characters

Confluent CLI v1.20.1 Release Notes

New Features
  • Prompt for credentials instead of throwing error when non-interactive login fails

Confluent CLI v1.20.0 Release Notes

New Features
  • Verbose HTTP and TLS information is logged (with trace log level) when logging in to the CLI.
  • Non-interactive login supported via environment variables
  • Binaries and archives are now shipped for Alpine Linux
Bug Fixes
  • Fixed issue where update command may not detect new CLI versions

Confluent CLI v1.19.1 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.19.0 Release Notes

New Features
  • Infer default protocol and port number for URLs when logging in
Bug Fixes
  • When using local Kafka sub-commands, only check status of Kafka cluster if it is a locally-running cluster
  • Fix flushing of logs and log processing during CLI startup

Confluent CLI v1.18.0 Release Notes

New Features
  • Improve warning messages for audit log commands

Confluent CLI v1.17.0 Release Notes

New Features
  • Expose context management commands
Bug Fixes
  • Add additional logging when setting custom CA cert path
  • Updated list of connectors for CP 6.0
  • Fix KSQL path issue for CP verions older than 5.5
  • Minor documentation/example fixes

Confluent CLI v1.16.0 Release Notes

New Features
  • Add audit log migration commands
  • Support piping credentials to login commands

Confluent CLI v1.15.0 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.14.0 Release Notes

No changes relating to Confluent CLI for this version.

Confluent CLI v1.13.1 Release Notes

Bug Fixes
  • Fix command output bug for commands that were supposed to output to Stdout but were outputting to Stderr

Confluent CLI v1.13.0 Release Notes

New Features
  • Allow for pipe-able log output from confluent local services ... log.
Bug Fixes
  • Fix panic when invalid role is specified during resource-scoped rolebinding commands.
  • Fix grammar and typos in command help and examples.

Confluent CLI v1.12.1 Release Notes

Bug Fixes
  • Fix success and error message display bug

Confluent CLI v1.12.0 Release Notes

Bug Fixes
  • Improve error message handling for audit log commands
  • Fix parsing of credentials on Windows for login command

Confluent CLI v1.11.0 Release Notes

New Features
  • Rewrite confluent local command to use consistent grammar and eliminate need for passing – to subcommands with arguments
  • Add confluent cluster command to register/unregister clusters from a Confluent Cluster Registry instance (Confluent Platform 5.5+)
  • Update RBAC rolebinding commands to support friendly cluster names
  • Add Schema Registry ACLs commands for confluent local
  • Improve error and success messages and add suggestions for commands that don’t succeed
Bug Fixes
  • Update macOS system requirements for Confluent Platform 6.0
  • Fix handling of errors from invalid RBAC rolebinding commands for Confluent Platform 6.0
  • Handle errors with loading CLI configuration files and ignore them when configs aren’t needed
  • Respect log output/verbosity levels when loading configuration files
  • Only check for updates once every 24 hours

Confluent CLI v1.10.0 Release Notes

Bug Fixes
  • Compatibility fix for RBAC in Confluent Platform 5.x

Confluent CLI v1.9.0 Release Notes

Bug Fixes
  • Restrict feedback nudges to fewer commands
  • Skip update check when running the update command

Confluent CLI v1.8.0 Release Notes

New Features
  • Update RBAC rolebinding commands to support friendly cluster names (CP 6.0)
  • Add feedback command so users can give direct in-product feeback
  • Start publishing release notes with each release
Bug Fixes
  • Fix panics when metadata service returns internal server errors
  • Improve command examples in help output