.. _confluent_local_config:

======================
confluent local config
======================

Description
-----------

Use this command to view or set connector configuration properties.

.. include:: ../../../includes/cli.rst
    :start-after: cli_limitations_start
    :end-before: cli_limitations_end

::

    confluent local config <connector-name> -- [ -d <connector-config-file> ] --path <path-to-confluent>

.. include:: ../../../includes/confluent-local-consume-limit.rst

Flags
-----

.. include:: ../../../includes/path-set-cli.rst

===================================  =======  ==============================================
Name, shorthand                      Default  Description
===================================  =======  ==============================================
``-d <connector-config-file>``                Specify a custom connector.
``--path <path-to-confluent>``                Path to |cp| install directory.
``-h, --help``                                Print command information.
``-v, --verbose``                             Increase verbosity (``-v`` for warn, ``-vv``
                                              for info, ``-vvv`` for debug, ``-vvvv`` for
                                              trace).
===================================  =======  ==============================================


Positional arguments
--------------------

===========================  =======  =====================================================
Name, shorthand              Default  Description
===========================  =======  =====================================================
``<connector-config-file>``           The configuration file. The file must be formatted
                                      as valid JSON or Java and must contain a correct
                                      configuration for a connector whose name matches
                                      the one specified in the command-line.
``<connector-name>``                  The connector name. If only the connector name
                                      is specified, the connector configuration is printed.
<path-to-confluent>                   The relative path to |cp|. You can also define this
                                      as an environment variable named ``CONFLUENT_HOME``.
===========================  =======  =====================================================

Examples
--------

- Print the current configuration of a connector named ``s3-sink``:

  .. codewithvars:: bash

     confluent local config s3-sink

- Configure a connector named ``wikipedia-file-source`` by passing its configuration properties in JSON format.

  .. codewithvars:: bash

     confluent local config wikipedia-file-source -d <path-to-connector>/wikipedia-file-source.json \
     --path <path-to-confluent>

- Configure a connector named ``wikipedia-file-source`` by passing its configuration properties as Java properties.

  .. codewithvars:: bash

     confluent local config wikipedia-file-source -d <path-to-connector>/wikipedia-file-source.properties \
     --path <path-to-confluent>