.. _confluent_local_demo:

==============
confluent demo
==============

Description
-----------
Run Confluent Platform end-to-end demo applications using KSQL, Confluent Replicator, |c3|, and more.

* Running ``confluent 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.


Usage
-----

.. codewithvars:: bash

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

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


Options
-------

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

Examples
--------

1. List available demos

.. codewithvars:: bash

    confluent demo list

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

.. codewithvars:: bash

    confluent demo update

3. Start a demo called ``wikipedia``

.. codewithvars:: bash

    confluent demo start wikipedia

4. Stop a demo called ``wikipedia``

.. codewithvars:: bash

    confluent demo stop wikipedia

5. View the README for a demo called ``wikipedia``

.. codewithvars:: bash

    confluent demo info wikipedia