Streaming

rpk connect lint

Check a Redpanda Connect configuration file for syntax errors and potential issues without running it.

Usage

rpk connect lint [flags]

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

Lint a specific file.

rpk connect lint target.yaml

Lint all YAML files in a directory.

rpk connect lint ./configs/*.yaml

Lint with resource imports.

rpk connect lint -r ./foo.yaml ./bar.yaml

Lint all files in a directory tree.

rpk connect lint ./configs/...

Value Type Description

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.

--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.

Was this helpful?