Command-Line Tool cathy

Command-Line Tool cathy#

The command line tool cathy is the ‘command center’ to perform various tasks. The basic syntax is:

Shell

cathy [--debug] [command [sub-command]] [option [...]]

The set of available commands and sub-commands depends on the Catharsys modules that are installed. Each module can define its’ own commands and sub-commands.

Getting help#

To get help for any cathy command, use the -h or --help option as in:

Shell

cathy [command [sub-command]] -h

To see the HTML documentation in a web browser, run:

Shell

cathy --docs

There is currently no option to open specifig HTML documentation for a command.

List of Commands#

Here is a list of the commands that are available by default.

Command

Sub-Command

Description

See also

install

system

Installs the Catharsys system

Catharsys Installation

workspace

Installs a pre-packaged workspace that comes with the setup package

ToDo

other commands

Debugging#

If a command returns with an error and you think it’s a bug, or you do not understand where the error is comming from, run the command again with the --debug option. This should show a trace, where in the code the error occurred. Note, that the option --debug must be the first element after cathy for any command. For example,

Shell

cathy --debug [command [sub-command]] [option [...]]