new: [documentation] Added section about the command line interface.

scandale-project · Feb 7, 2024 · ef7e3ca · ef7e3ca
1 parent bcd6622
commit ef7e3ca
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/command-line-interface.rst b/docs/command-line-interface.rst
@@ -0,0 +1,18 @@
+Command Line Interface
+======================
+
+.. code-block:: bash
+
+    $ ./scandale_cli.py --help
+                                                                                                                                                                                                            
+    Usage: scandale_cli.py [OPTIONS] COMMAND [ARGS]...                                                                                                                                                       
+                                                                                                                                                                                                            
+    ╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+    │ --install-completion          Install completion for the current shell.                                                                                                                                │
+    │ --show-completion             Show completion for the current shell, to copy it or customize the installation.                                                                                         │
+    │ --help                        Show this message and exit.                                                                                                                                              │
+    ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+    ╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+    │ openapi                                                                                                                                                                                                │
+    │ version                                                                                                                                                                                                │
+    ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
diff --git a/docs/index.rst b/docs/index.rst
@@ -46,6 +46,7 @@ Use-case
 
    installation
    deployment
+   command-line-interface
 
 
 .. toctree::