Wiki Markup |
---|
{scrollbar} |
- what is it?
- benefits
- what it does/replaces
- tools and commands
- how-to samples
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.
Running GShell
A simple launcher script/.bat file is located in the bin
directory of a Geronimo server. To start GShell on a *nix OS:
Code Block |
---|
cd geronimo-jetty6-javaee5-2.1/bin
./gsh
|
or on Windows
Code Block |
---|
cd c:\ger\bin
gsh
|
GShell commands may be specified when starting GShell:
Code Block |
---|
./gsh deploy/list-modules
|
or commands may be entered interactively:
Panel |
---|
coltrane kevan$ ./gsh Type 'help' for more information. |
The help
command will display all GShell commands that are available in the current environment.
Code Block |
---|
kevan@coltrane:/> help
For information about Apache Geronimo, visit:
http://geronimo.apache.org
Available commands:
execute-alias Execute an alias
exit Exit the shell
print Alias to: echo
alias Create an alias
source Load a file/url into the current shell
? Alias to: help
. Alias to: source
unalias Remove an alias
unset Unset a variable
help Show command help
echo Echo or print arguments to STDOUT
clear Clear the terminal screen
quit Alias to: exit
set Set a variable
remote-control
server-control Remote server control
deploy
undeploy Undeploy a module
connect Connect to a Geronimo server
install-library Install library
stop Stop a module
list-targets List targets
restart Restart a module
install-plugin Install a plugin
list-plugins Install plugins into a geronimo server
start Start a module
assemble Extract a geronimo server from the current one
deploy Deploy a module
list-modules List modules
redeploy Redeploy a module
distribute Distribute a module
disconnect Disconnect from a Geronimo server
remote
rsh-server Start a GShell server
rsh Connect to a remote GShell server
geronimo
stop-server Stop a Geronimo server
start-client Start a Geronimo application client
start-server Start a Geronimo server
|
The quit
command will exit the GShell environment.
To obtain help information on any command, use the {--help} option:
Code Block |
---|
kevan@coltrane.local:/> deploy/list-modules --help
list-modules
--
TARGET Target name
-a (--all) Show started or stopped modules
-h (--help) Display this help message
-p (--port) N Port, default 1099
-r (--started) Show started modules only
-s (--hostname, --server) VAL Hostname, default localhost
-t (--stopped) Show stopped modules only
-u (--username) VAL Username
-w (--password) VAL Password
|
Geronimo GShell Commands
The following deploy
commands are available:
Code Block |
---|
deploy/deploy Deploy a module
deploy/undeploy Undeploy a module
deploy/start Start a module
deploy/stop Stop a module
deploy/restart Restart a module
deploy/list-modules List modules
deploy/redeploy Redeploy a module
deploy/distribute Distribute a module
deploy/connect Connect to a Geronimo server
deploy/disconnect Disconnect from a Geronimo server
deploy/install-library Install library
deploy/list-targets List targets
deploy/install-plugin Install a plugin
deploy/list-plugins Install plugins into a geronimo server
deploy/assemble Extract a geronimo server from the current one
|
Code Block |
---|
geronimo/start-server Start a Geronimo server
geronimo/stop-server Stop a Geronimo server
geronimo/start-client Start a Geronimo application client
|
More complete documentation is needed on these..GSHELL documentation available here.