.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/cli_configure.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_cli_configure.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_cli_configure.py:


Configure the launcher from the command line
--------------------------------------------

This example shows how to configure the ``example_httpserver`` plugin from the command line.
It consists mostly of command-line interactions. With the exception of interactive commands,
this example can be run when downloaded as a Jupyter notebook. The interactive commands and
their outputs are simply shown as text.

The configuration contains only a single value, ``directory``, which specifies the
where the HTTP server is to serve files from.

.. GENERATED FROM PYTHON SOURCE LINES 38-57

To see the list of launch modes for the ``example_httpserver`` product, run
this code:

.. code-block:: bash

  %%bash
  ansys-launcher configure example_httpserver

Here is the output:

::

  Usage: ansys-launcher configure example_httpserver [OPTIONS] COMMAND [ARGS]...

  Options:
  --help  Show this message and exit.

  Commands:
  direct

.. GENERATED FROM PYTHON SOURCE LINES 59-77

Interactive configuration
~~~~~~~~~~~~~~~~~~~~~~~~~

To interactively specify the available configuration options, run
this command:

.. code-block:: bash

  ansys-launcher configure example_httpserver direct

The preceding command might result in a session like this:

::

  directory:
   [<current-working-directory>]: /path/to/directory

  Updated /home/<your_username>/.config/ansys_tools_local_product_launcher/config.json

.. GENERATED FROM PYTHON SOURCE LINES 79-88

Non-interactive configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Alternatively, you can specify the configuration fully from the command line (non-interactively):

.. code-block:: bash

  %%bash
  ansys-launcher configure example_httpserver direct --directory /path/to/directory


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.000 seconds)


.. _sphx_glr_download_examples_cli_configure.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: cli_configure.ipynb <cli_configure.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: cli_configure.py <cli_configure.py>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_