.. _cli-confluent-config:

================
confluent config
================

Description
-----------
View or set connector configuration properties.


Usage
-----

.. sourcecode:: bash

   confluent config <connector-name> [ -d <connector-config-file> ]

.. tip:: For usage information, enter ``confluent help config``.

Options
-------

===================================  =======  ==============================================
Name, shorthand                      Default  Description
===================================  =======  ==============================================
``-d <connector-config-file>``                Specify a custom connector.
===================================  =======  ==============================================


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



Examples
--------

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

  .. sourcecode:: bash

     confluent config s3-sink

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

  .. sourcecode:: bash

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

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

  .. sourcecode:: bash

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