If you are working with a new installation of Rose you should look at the Site And User Configuration.
Rose combines the settings in the site configuration and the user configuration at run time. You can view the resultant configuration by issuing the command:
Rose should work out of the box if it is configured correctly at your site.
- The default external text editor used by GUIs is
- The default external text editor used by CLI commands is the value of
EDITORenvironment variable, or
viif neither environment variable is set.
To change the default editor change the following settings in the user
- The external text editor used by GUIs
- The external text editor used by CLI commands
For emacs and most text editors, you can do something like:
[external] editor=emacs geditor=emacs
For any text editor command that normally forks and detaches from the shell
it is started in, you should use an option to ensure that the text editor
runs in the foreground to allow Rose to wait for the edit session to
finish. E.g. for
gvim, you will do:
[external] editor=gvim -f geditor=gvim -f
Editor Syntax Highlighting¶
emacs plugins for syntax
highlighting of Rose configuration files, located within the Rose installation:
The plugins contain setup instructions within.
Additionally there is a Pygments lexer located in
You can locate your Rose installation using:
rose version --long
There is a Rose bash completion script that you can source to enhance the Rose command line interface within an interactive Bash shell.
The script allows you to tab-complete Rose commands, options, and arguments.
You can find the script in the Rose installation
The file contains the instructions for using it.
See the “Installation” and “User Config File” sections of the Cylc User Guide.
Do not modify the default values of the following cylc settings:
Equivalent functionalities are provided by the
rose.conf[rose-suite-run]root-dir settings in the Rose