Differences

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

--- 01_user_documentation:10_additional_interfaces:cli [2025/01/30 10:54] – removed - external edit (Unknown date) 127.0.0.1
+++ 01_user_documentation:10_additional_interfaces:cli [2025/12/12 14:58] (current) – [More documentation] groimp
@@ Line 1: / Line 1: @@
+===== CLI =====
+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 =====
+The CLI can be installed using the GroIMP [[01_user_documentation:03_interacting_with_groimp:02_panels:14_plugin_manager|plugin manager]] (which also works in [[01_user_documentation:user-guide:pluginmanager#usage_from_commandline|headless]] or compiled from [[https://gitlab.com/grogra/groimp-plugins/CLI|source]].
+To start the CLI application in a terminal the additional parameter -a cli is needed:
+<code bash>
+java -Xverify:none -jar core.jar --headless -a cli
+</code>
+The name core.jar can variate based on the way GroIMP was installed.
+===== Structure =====
+==== Projects ====
+The CLI can be used to manage multiple workbenches. The currently used workbench is defined in the prefix of the command line:
+ [**myProject**]%%>>%%
+After starting the CLI the first workbench is always "base", which is similar to the empty window when starting the GUI. This workbench cant do much more then creating or opening other projects.
+==== Commands ====
+The commands to interact with GroIMP and the proejcts are sorted by level of usage. There is currently three levels:
+  * application for managing the different projects and for basic interaction with the operation system
+  * window for managing the panels(the cli version) of the current workbench
+  * workbench for editing and execution the current project as well general project management
+The list can be found below.
+===== More documentation =====
+  * [[01_user_documentation:10_additional_interfaces:cli| CLI user guid]]
+    * [[01_user_documentation:10_additional_interfaces:cli#list_of_commands|List of CLI commands]]
+  * [[https://wkurth.grogra.de/oberlaender_msc.pdf| GroLink: implementing and testing a general application programming interface for the plant-modelling platform GroIMP]]
+===== Tutorials =====
+  * [[02_user_tutorials:30_additional_interfaces:cli:startup-cli-model|Getting started with CLI]]
+===== List of Commands =====
+The commands are sorted by level of usage. There is currently three levels: at application, window, or workbench level. The first character of a command indicates at which level it should be executed.
+**Note: the command ''$help'' lists most of the available commands with a description**
+| **App commands ($)**                                                       |                                                  |
+| $pwd                                                                   | print the current system directory               |
+| $ls                                                                    | list all files of the current system directory   |
+| $cd (system-path)                                                      | change the current system directory              |
+| $editFile (system-path)                                                | open a system file with a default application    |
+| $open (system-path)                                                    | open an existing Project file in a new Workbench |
+| $createWB (selected template(optional), name of the new WB(optional))  | create a new Project based on a RGG template     |
+| $loadExample (identifier of the Example, name of the new WB(optional)) | load an example project                          |
+| $listExamples (search parameter (optional))                            | list the available examples                      |
+| $listTemplates (search parameter (optional))                           | list the available templates                     |
+| $selectWB (workbench id)                                               | select a new workbench                           |
+| $listWB                                                                | list all open Workbenches                        |
+| $listProjects                                                          | list all open projects                           |
+| **Window command (%)**                                |                                       |
+| only a small selection of the most used panels... |                                       |
+| %list                                             | list all open windows                 |
+| %inspector                                        | shows the hierarchic object inspector |
+| %inspector:select (tree-id)                       | select the node                       |
+| %inspector:show (tree-id)                         | opens the properties of the node      |
+| %log                                              | show the log                          |
+| %fileexplorer                                     | list all files                        |
+| %fileexpolorer:show (file name or id)             | opens a file in nano                  |
+| **Workbench command**                       |                                                                      |
+| open (system-path)                      | open an existing Project file in a new Workbench (is equal to $open) |
+| save                                    | save the file to the original location                               |
+| saveas (system-path)                    | save the file to a new location                                      |
+| undo                                    | undo last action                                                     |
+| compile                                 | compiles the RGG code                                                |
+| listFunctions                           | list all exiting RGG functions of the model                          |
+| addNode (system-path or -o object-path) | add a Object form either a file or a 3d object (-o) to the scene     |
+| addFile (system-path)                   | add a file to the Project, create one if the path is empty     |
+| renameFile (file name , new name)       | rename a file                                                        |
+| removeFile (file name)                  | remove a file                                                        |
+| export3d (system-path)                  | export the scene to a file                                           |
+| close                                   | closes the Project                                                   |
+| xlconsole                               | open the XL console                                                  |
+| graph                                   | shows the hierarchic object inspector                                |
+| ls                                      | list all files of the Project                                        |
+| editFile (file name)                    | open Nano to edit a file                                             |
+| <RGG-function-name>                     | execute the RGG function with that name                                             |