Chapter 2. Configuring the Knative CLI


You can customize your Knative (kn) CLI setup by creating a config.yaml configuration file. You can give this configuration by using the --config flag, otherwise the CLI picks up the configuration from a default location.

The default configuration location conforms to the Cross-Desktop Group (XDG) Base Directory Specification, and is different for UNIX systems and Windows systems.

Default configuration file locations for the Knative (kn) CLI across different operating systems and an overview of the configuration file structure and key fields.

For UNIX systems:

  • If the XDG_CONFIG_HOME environment variable is set, the default configuration location that the Knative (kn) CLI looks for is $XDG_CONFIG_HOME/kn.
  • If the XDG_CONFIG_HOME environment variable is not set, the Knative (kn) CLI looks for the configuration in the home directory of the user at $HOME/.config/kn/config.yaml.

For Windows systems, the default Knative (kn) CLI configuration location is %APPDATA%\kn.

You get an output similar to the following example:

plugins:
  path-lookup: true
  directory: ~/.config/kn/plugins
eventing:
  sink-mappings:
  - prefix: svc
    group: core
    version: v1
    resource: services
plugins.path-lookup
Specifies whether the Knative (kn) CLI should look for plugins in the PATH environment variable. This is a boolean configuration option. The default value is false.
plugins.directory
Specifies the directory where the Knative (kn) CLI looks for plugins. The default path depends on the operating system, as described earlier. This can be any directory that is visible to the user.
eventing.sink-mappings
The sink-mappings spec defines the Kubernetes addressable resource that is used when you use the --sink flag with a Knative (kn) CLI command.
sink-mappings.prefix
The prefix you want to use to describe your sink. svc for a service, channel, and broker are predefined prefixes for the Knative (kn) CLI.
sink-mappings.group
The API group of the Kubernetes resource.
sink-mappings.version
The version of the Kubernetes resource.
sink-mappings.resource
The plural name of the Kubernetes resource type. For example, services or brokers.
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat Documentation

Legal Notice

Theme

© 2026 Red Hat
Back to top