location: src/Tools/Command/coolfluid-command

The coolfluid-command executable is an interactive command-line interpreter of cf3 Since the component-architecture of COOLFluiD is very similar to a file system, the syntax for coolfluid-command is based on the UNIX commands to manipulate and visualize files.

Interactive mode

By default when starting "coolfluid-command", the user seemingly enters another shell environment. where commands such as "ls", "pwd", "cd" , "exit" can be used to traverse the data structure.

$> coolfluid-command
[/] ls
Environment
Factories
Libraries
Tools
[/] cd Tools
[//Tools] pwd
//Tools
[//Tools] exit
$>

"ls l" shows detailed view, "ls s" shows signals only, "ls a" shows both Components and signals.

"coolfluid-command --help" displays all available commands.

Batch mode

coolfluid-command can also be used in batch:

Following will show exactly the same output as above, and exits the executable automatically

$> coolfluid-command --ls   --cd Tools  --pwd
[/] ls
Environment
Factories
Libraries
Tools
[/] cd Tools
[//Tools] pwd
//Tools
$>

The same commands as in interactive mode can be used, but have to be prepended with "--". When ending the line with "--interactive", the user enters the interactive shell to continue interactively.

$> coolfluid-command --ls   --cd Tools  --pwd --interactive
[/] ls
Environment
Factories
Libraries
Tools
[/] cd Tools
[//Tools] pwd
//Tools
[//Tools]

Reading from a script

coolfluid-command can interprete a script. An example script "example.cfscript":

# This is a comment line
ls
cd Tools   # This is also comment

pwd

Interpreting the script:

$> coolfluid-command --file example.cfscript  --interactive
[/] ls
Environment
Factories
Libraries
Tools
[/] cd Tools
[//Tools] pwd
//Tools
[//Tools]