open-consul/website/pages/docs/commands/config.html.md

layout	page_title	sidebar_current
docs	Commands: Config	docs-commands-config

Consul Config

Command: consul config

The config command is used to interact with Consul's central configuration system. It exposes commands for creating, updating, reading, and deleting different kinds of config entries. See the agent configuration for more information on how to enable this functionality for centrally configuring services and configuration entries docs for a description of the configuration entries content.

Usage

Usage: consul config <subcommand>

For the exact documentation for your Consul version, run consul config -h to view the complete list of subcommands.

Usage: consul config <subcommand> [options] [args]

  This command has subcommands for interacting with Consul's centralized
  configuration system. Here are some simple examples, and more detailed
  examples are available in the subcommands or the documentation.

  Write a config:

    $ consul config write web.serviceconf.hcl

  Read a config:

    $ consul config read -kind service-defaults -name web

  List all configs for a type:

    $ consul config list -kind service-defaults

  Delete a config:

    $ consul config delete -kind service-defaults -name web

  For more examples, ask for subcommand help or view the documentation.

For more information, examples, and usage about a subcommand, click on the name of the subcommand in the sidebar.