.. _cli-install:

==================================
Installing and Configuring the CLI
==================================

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

Installing the CLI
------------------
The Confluent CLI is included as a part of the |cp| :ref:`package <available_packages>`. To install, download
the |cp| package.


Configuring the CLI
-------------------
You must configure the CLI before using.

#.  Set your PATH variable:

    .. codewithvars:: bash

       export PATH=<path-to-confluent>/bin:${PATH};


#.  Install ``jq`` for your `platform <https://stedolan.github.io/jq/download/>`_.


#.  Optional: Specify a custom location to store the CLI data and logs. By default the Confluent CLI stores its data and logs in your platform's temporary directory.

    .. tip:: You can check the current data and log location with the :litwithvars:`|confluent_current|` command.

    #.  Create a directory:

        .. codewithvars:: bash

             mkdir <path-to-confluent>/var

    #.  Set the path to your directory:

        .. codewithvars:: bash

             export CONFLUENT_CURRENT=<path-to-confluent>/var