Streaming

rpk connect list

List available Redpanda Connect components. Shows inputs, outputs, processors, caches, rate limits, buffers, metrics, and tracers that can be used in pipelines.

If any component types are explicitly listed, only types of those components are shown.

When using --format jsonschema with bloblang-functions or bloblang-methods, you can optionally specify function or method names to retrieve metadata for only those items, for example rpk connect list --format jsonschema bloblang-functions uuid_v4.

Usage

rpk connect list [flags]

Examples

This section provides examples of how to use rpk connect list.

Example.

rpk connect list

Example.

rpk connect list --format json inputs output

Example.

rpk connect list rate-limits buffers

Flags

Value Type Description

--format

string

Output format: text (human-readable table), json (machine-readable), cue (CUE schema). Default is text.

--status

string

Filter the component list to only those matching the given status. Options are stable, beta or experimental.

-t, --templates

strings

EXPERIMENTAL: import Redpanda Connect templates, supports glob patterns (requires quotes).

Global flags

Value Type Description

--config

string

Redpanda or rpk config file; default search paths are ~/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings; -X help for detail or -X list for terser detail.

--ignore-profile

bool

Ignore rpk.yaml and redpanda.yaml; use default settings.

--profile

string

rpk profile to use.

-v, --verbose

bool

Enable verbose logging.