Namespace: <em>global</em>
Basic commands provided by the shell
commands
NAME commands – Print a list of available commands
SYNTAX
commands
ALIASES cmds
exit
NAME exit – Exit the interactive shell
SYNTAX
exit [code]
ALIASES quit
ARGUMENTS
- code - [optional] -The exit code. Must be a positive number otherwise 0 is assumed. Defaults to 0.
help
NAME help – The help command
SYNTAX
help [options] [command]
OPTIONS
- -export - If used export all the commands available in a wiki format to the given file. If a directory is given the export will be made in file help.wiki in that directory.
- -ns - [optional] - to be used to filter commands by namespaces when generating the documentation. By default all namespaces are dumped.
ARGUMENTS
- command - [optional] -the name of the command to get help for
install
NAME install – Install a SH script to launch the shell in the terminal. Available only for UNIX systems.
SYNTAX
install [file]
ARGUMENTS
- file - [optional] -the file where to install the shell script. If not used the script will be printed on stdout.
interactive
NAME interactive – Interactive shell
SYNTAX
interactive
settings
NAME settings – Print or modify the shell settings.
SYNTAX
settings [options] [name] [value]
OPTIONS
- -reset - [flag] - Reset settings to their defaults. Need to restart shell.
ARGUMENTS
- name - [optional] -The variable to print or set.
- value - [optional] -The variable value to set.
trace
NAME trace – Print the last error stack trace if any
SYNTAX
trace
use
NAME use – Switch the current command namespace. If no namespace is specified the current namepsace name is printed.
SYNTAX
use [name]
ARGUMENTS
- name - [optional] -The command namespace to use
version
NAME version – Print Nuxeo Shell Version
SYNTAX
version