.. _confluent_local_demo:

====================
confluent local demo
====================

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

Run |cp| end-to-end demo applications using KSQL, |crep-full|, |c3|, and more.

* Running ``confluent local demo`` requires internet connectivity and GitHub access.
* Demos are stored locally in ``$CONFLUENT_HOME/quickstart-demos``.
* The demos are for sandbox testing in a development environment. Never run these demos in production.

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

You can use these commands to explore, test, experiment, and otherwise familiarize yourself with |cp|.

::

    confluent local demo [ list | update | start | stop | info ] [ <demo-name> ] --path <path-to-confluent>

Flags
-----

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

===================================  ==========================================================
Name, shorthand                      Description
===================================  ==========================================================
``list``                             List names of available demos
``update``                           Pull the latest demo code
``start <demo-name>``                Start a demo with specified name
``stop <demo-name>``                 Stop a demo with specified name
``info <demo-name>``                 Provide README for demo with specified name
``--path <path-to-confluent>``       Path to |cp| install directory.
``-h, --help``                       Print command information.
===================================  ==========================================================

Examples
--------

-   List available demos

    .. sourcecode:: bash
    
        confluent local demo list

-   Update demo code to ensure you are running the latest code.

    .. sourcecode:: bash
    
        confluent local demo update

-   Start a demo called ``wikipedia``

    .. sourcecode:: bash
    
        confluent local demo start wikipedia

-   Stop a demo called ``wikipedia``

    .. sourcecode:: bash
    
        confluent local demo stop wikipedia

-   View the README for a demo called ``wikipedia``

    .. sourcecode:: bash
    
        confluent local demo info wikipedia