|Home > Documentation > User's guide > GShell|
GShell is an extensible, command-line processing environment for creating command-line applications. GShell includes support for command editing, command history, input/output redirection, and more. GShell is a subproject of Geronimo. For more information on GShell, see the GShell wiki.
Many Geronimo administrative commands have been implemented using GShell. Previously existing Geronimo commands (e.g. startup, geronimo.sh, deploy.sh) are still included in Geronimo. Over time, however, it is expected that we will implement all administrative commands using GShell, only.
This document is organized in the following sections:
A simple launcher script/.bat file is located in the <geronimo_home>/bin directory. To start GShell just type
GShell commands may be specified when starting GShell:
or commands may be entered interactively:
help command will display all GShell commands that are available in the current environment.
quit command will exit the GShell environment.
To obtain help information on any command, use the
The following list shows the Geronimo specific commands available:
Geronimo can be started through gshell using the
--background option is not used, then the server instance will maintain control of the terminal and a new instance of gshell must be started to interact with the server.
geronimo/start-server options (Use
geronimo/start-server --help to see a full list of options).
Geronimo can be stopped using the
-u and password
-w are not provided on the command line, the user will be prompted for them before the server shutdown process is started. The full set of
geronimo/stop-server options can be seen in gshell using the
--help option, the same way as for
On a Windows platform
Use forward slash "/" instead of traditional back slash "\" as directory seperators.
This issue is addressed by (https://issues.apache.org/jira/browse/GERONIMO-4709)
deploy/connect can be used to connect to an instance of Geronimo that is already running. If no options are provided, then the default port (1099) and host (localhost) will be used to connect to a server. The
-p option can be used to specify a different port and
-s to specify a remote hostname.
deploy/disconnect can be used to disconnect from an already connected instance of Geronimo. Since only one instance of Geronimo can be connected at a time, no options are needed to specify which server to disconnect from.
deploy/deploy can be used to deploy a module to the geronimo instance that is currently connected.
A module file can be one of the following:
-w options can be used to provide username and password when issuing the command. The
-s option can be used to specify the hostname. If none specified, then the hostname defaults to localhost. Likewise
-p can be used to specify a port to contact the host on with 1099 being the default.
-i can be used to specify an inPlace deployment from the directory you are actually developing the application. In that instance, the path to the application would need to be provided in place of the location of the module.
A deployment plan is necessary to deploy an application. If the deployment plan is not in the WEB-INF directory of a module, then its location must be specified after the module in the command.
deploy/redeploy is used to deploy a newer version of a module onto a server where the older module is already deployed. It functions in a similar way to
deploy/deploy but lacks an inPlace deployment option. The username and password is still required and can be provided via command line (
-w) or through a prompt after the command is issued. As with the deploy command, the user can specify both port
(-p) and hostname
(-s) if they differ from the defaults
deploy/undeploy is used to properly remove a module from a server. The command takes the username
(-u) and password
(-w) options. If not provided, the user will be prompted. As with the deploy command, the user can specify both port
(-p) and hostname
(-s) if they differ from the defaults. The module id must be provided for the module you wish to undeploy.
deploy/distribute works exactly like
deploy/deploy except the module is not started once it has been deployed into the server and is not marked to be started each time the server starts. The command can be issued in the same way, with the same options, as