Differences

This shows you the differences between two versions of the page.

--- user-guide:additional_interfaces:cli [2025/01/17 09:21] – Tim
+++ user-guide:additional_interfaces:cli [2025/01/22 15:48] (current) – [More documentation] Tim
@@ Line 1: / Line 1: @@
-===== CLI User guid=====
+===== CLI =====
-The CLI (command line interface) of GroIMP, can be used to interact with multiple projects without the need of a graphical user interface. This makes it a valuable feature especially on remote server or for small changes. It syntax of the commands is oriented on basic linux command.
+GroIMP can be started without its graphical interface, with a CLI. Unlike the Headless mode, the CLI enables interaction with multiple the models during run time including opening and closing models, running simulations, editing RGG files etc. Its a valuable feature especially on remote server or for small changes. It syntax of the commands is oriented on basic linux command.
+<uml>@startuml
+!pragma teoz true
+hide footbox
+title CLI
+participant User
+participant "Interactive command line" as cli
+participant GroIMP
+User -> GroIMP: Start GroIMP
+cli<-> GroIMP
+& User <-> cli
+@enduml</uml>
 ===== Installation & Execution =====
@@ Line 38: / Line 53: @@
-===== Tutorial =====
-You can have a look at [[:tutorials:Startup-CLI-model|this tutorial]] for more information.
+===== More documentation =====
+  * [[:user-guide:additional_interfaces:cli | CLI user guid]]
+    * [[:user-guide:additional_interfaces:cli#list_of_commands|List of CLI commands]]
+  * [[:groimp-platform:interfaces:cli|CLI implementation]]
+  * [[https://wkurth.grogra.de/oberlaender_msc.pdf| GroLink: implementing and testing a general application programming interface for the plant-modelling platform GroIMP]]
+===== Tutorials =====
+  * [[:tutorials:startup-cli-model|Getting started with CLI]]
 ===== List of Commands =====