.. _command_line_interface:

**********************
Command Line Interface
**********************

CLI
===

Appsuite Proxy comes with a command line tool which basically gives access to Proxy`s management API Endpoints. The command line tool can be installed as additional docker image or locally using gradle a task.
For more information see project`s readme. Once you have installed command line tool run ``appsuite-proxy --help`` to get a list with possible actions


::

    root@2a1f20a3b3d7:/usr/local/bin# appsuite-proxy
    Usage: appsuite-proxy [OPTIONS] COMMAND [ARGS]...

      Command line tool can be used to perform management tasks from shell which
      basically invoke Appsuite Proxy`s REST API Endpoints.

    Options:
      --baseurl TEXT  Base URL to HTTP API  [default: (http://127.0.0.1:8888)]
      --debug         Show debug output in case of any errors  [default: (False)]
      --version       The CLI version
      -h, --help      Show this message and exit.

    Commands:
      config  Actions calling Appsuite Proxy`s configuration endpoint
      health  Actions calling Appsuite Proxy`s health endpoint
      metrics  Actions calling Appsuite Proxy`s metrics endpoint

      Run 'appsuite-proxy COMMAND --help' for more information

CLI Docker Image
================

Alternatively you can use appsuite-proxy-cli docker image which includes the clt. To use it you need just to run the image, e.g. ``docker run ImageId``. This will show you the help text and you can just add options or commands on your next docker run call, e.g. ``docker run ImageId config get``.