ccloud topic describe

Description

Describe topics.

Usage

ccloud [(--config-dir <configDir> | -c <configDir>)] [(--verbose | -v)]
 topic describe [--topics-with-overrides] [--unavailable-partitions]
 [--under-replicated-partitions] [--] [<topic>]

Tip

For usage information, enter ccloud help topic describe.

Options

Name, shorthand Default Description
--config-dir <configDir>, -c <configDir> $HOME/.ccloud The configuration directory.
--topics-with-overrides   Only show topics that have overridden configs.
--unavailable-partitions   Only show topics that have unavailable partitions.
--under-replicated-partitions   Only show topics that have under replicated partitions.
--verbose, -v   Detailed output of a command.
--   Use this option to separate command-line options from the list of argument. This is useful when arguments might be mistaken for command-line options

Positional arguments

Name, shorthand Default Description
<configDir>   The path to the configuration directory.
<topic>   Name of topic to describe.

Example

Describe the my_topic topic.

ccloud topic describe my_topic