Add ocs-agent-cli to cli-tools docs page

simonsobs · Aug 29, 2022 · 1a9f050 · 1a9f050
1 parent 18d0435
commit 1a9f050
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/docs/user/cli_tools.rst b/docs/user/cli_tools.rst
@@ -229,3 +229,11 @@ general instructions.
    :module: ocs.ocs_systemd
    :func: get_parser
    :prog: ocs-install-systemd
+
+ocs-agent-cli
+==============
+
+.. argparse::
+   :module: ocs.agent_cli
+   :func: get_parser
+   :prog: ocs-agent-cli
diff --git a/ocs/agent_cli.py b/ocs/agent_cli.py
@@ -12,7 +12,7 @@
 DESCRIPTION = """
 This script provides a quick way to start an OCS Agent. You will need to set
 OCS_CONFIG_DIR environment variable to the directory containing default.yaml,
-or else use --site-* options to specify your configuration.
+or else use ``--site-*`` options to specify your configuration.
 
 To start an Agent, run::