From 1fd05fcca8225b01d2fb3c6dededc9f3928d6965 Mon Sep 17 00:00:00 2001
From: mgrani <michael.granitzer@uni-passau.de>
Date: Tue, 18 Jun 2024 16:32:33 +0200
Subject: [PATCH] doc: documentation improved

---
 docs/source/commands.md | 44 ++++++++++++++++++++++++++++++++++++++---
 1 file changed, 41 insertions(+), 3 deletions(-)

diff --git a/docs/source/commands.md b/docs/source/commands.md
index 573a01e..2e9b186 100644
--- a/docs/source/commands.md
+++ b/docs/source/commands.md
@@ -1,12 +1,50 @@
 # OWIlix Commands
 
-The OWIlix CLI includes custom commands that can be executed within the Flask application context. 
-These commands are defined in the `owilix/core/commands.py` file and are imported and parameterized in `owilix/cli.py`.
+The OWIlix CLI includes custom commands that can be executed via the CLI. 
+Commands are utilising core functions and add a python rich ui based console UI on top of it. 
+Regular python functions can be registered as commands, where the parameters are translated to CLI parameters and the function name becomes the command name.
+The main components are shown in the figure below.
 
-```{automodule} owilix.core.commands
+![](_static/owilix-commands.png)
+
+
+## OWILIX Command Module
+
+```{automodule} owilix.cmd
+:members:
+:undoc-members:
+:private-members:
+:special-members: __init__
+:show-inheritance:
+```
+
+### Local OWILIX Commands
+
+
+```{automodule} owilix.cmd.local.LocalCommands
 :members:
 :undoc-members:
 :private-members:
 :special-members: __init__
 :show-inheritance:
+```
+
+```{autofunction} owilix.cmd.local.stats
+```
+
+```{autofunction} owilix.cmd.local.ls
+```
+
+```{autofunction} owilix.cmd.local.insert
+```
+
+
+### OWILIX BaseCommands
+
+```{automodule} owilix.cmd.base.BaseCommand
+:members: __init__
+:undoc-members:
+:private-members:
+:special-members: __init__
+:show-inheritance:
 ```
\ No newline at end of file
-- 
2.51.2