Usage
command [-help] [-args] [input values] [;nextcommand]
Shell for managing files in a Java Cloud Service - SaaS Extension instance.
Note:
In a single command-line, the command can be specified first, between two
arguments, or last. The command name can optionally start with "-" only
when it is specified first.
Otherwise, it must start with a hyphen in order to be recognized. A
command may have optional arguments.
Each argument must start with a hyphen. The argument value must follow
that argument. The value for boolean valued arguments can be ignored to
effectively mean a value of true. The list of arguments can be in any
order.
The argument -help can be specified anywhere after specifying a command to
get the list of arguments supported by that command.
The root directory "/" points to "/customer/scratch/" and is read-only.
"cd" to respective server directory for read/write access.
For example:
1.)ls path1 path2
2.)cd dir;ls;cd ..
3.)get -help
Possible Commands are:
pwd
- Prints current working directory.
E.g) pwd;pwd -local
ls
- Lists all the files and directories from given set of path(s).
E.g) ls dir1 dir2;ls -local
cd
- Changes the current directory to an existing directory. When executed
without an argument, it changes to the last known directory.
E.g) cd dir
mkdir
- Creates new directory.
E.g) mkdir newdir
rm
- Deletes an existing directory or a file.
E.g) rm dir
cat
- Prints a file.
E.g) cat file
echo
- Echos the given text.
E.g) echo text
who
- Prints the user name that has logged on.
E.g) who
touch
- Creates an empty file if that does not exist.
E.g) touch newfile
cp
- Copies a file to another location.
E.g) cp source dest
mv
- Moves a file to another location.
E.g) mv source dest
get
- Gets(download) a remote file to the current local directory.
E.g) get remotepath
zget
- Gets(download) a remote dir as a zip file to the current local directory.
E.g) zget;zget remotedir
put
- Puts(upload) a local file to the current remote directory.
E.g) put localpath
usage
- Prints the usage of this tool into the HTML file (defaulted to - usage.html)
for off-line reference.
exit
- Exits from this shell.
hist
- Displays history of commands. It can also execute a command from the history.
E.g) hist;hist id
Quick Argument Summary
Top
Command:
pwd - Prints current working directory.
E.g) pwd;pwd -local
Mandatory argument(s):
Optional argument(s):
Advanced argument(s):
local - When true, the shell performs the command against local file system.
Shortcut:l
Default Value: false
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
ls - Lists all the files and directories from given set of path(s).
E.g) ls dir1 dir2;ls -local
Command alias:[dir]
Mandatory argument(s):
Optional argument(s):
verbose - The flag(true/false) that indicates if the listing should be done in
verbose(full-format).
Shortcut:v
Default Value: false
Advanced argument(s):
local - When true, the shell performs the command against local file system.
Shortcut:l
Default Value: false
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
cd - Changes the current directory to an existing directory. When executed without an
argument, it changes to the last known directory.
E.g) cd dir
Mandatory argument(s):
Optional argument(s):
Advanced argument(s):
local - When true, the shell performs the command against local file system.
Shortcut:l
Default Value: false
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
mkdir - Creates new directory.
E.g) mkdir newdir
Command alias:[md]
Mandatory argument(s):
Optional argument(s):
Advanced argument(s):
local - When true, the shell performs the command against local file system.
Shortcut:l
Default Value: false
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
rm - Deletes an existing directory or a file.
E.g) rm dir
Command alias:[del]
Mandatory argument(s):
Optional argument(s):
force - The flag to indicate if the operation needs to be forced.
Shortcut:f
Advanced argument(s):
local - When true, the shell performs the command against local file system.
Shortcut:l
Default Value: false
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
cat - Prints a file.
E.g) cat file
Command alias:[type]
Mandatory argument(s):
Optional argument(s):
Advanced argument(s):
local - When true, the shell performs the command against local file system.
Shortcut:l
Default Value: false
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
echo - Echos the given text.
E.g) echo text
Mandatory argument(s):
Optional argument(s):
Advanced argument(s):
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
who - Prints the user name that has logged on.
E.g) who
Mandatory argument(s):
Optional argument(s):
Advanced argument(s):
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
touch - Creates an empty file if that does not exist.
E.g) touch newfile
Mandatory argument(s):
Optional argument(s):
Advanced argument(s):
local - When true, the shell performs the command against local file system.
Shortcut:l
Default Value: false
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
cp - Copies a file to another location.
E.g) cp source dest
Command alias:[copy]
Mandatory argument(s):
Optional argument(s):
recursive - The flag(true/false) to indicate if the operation should recursive.
Shortcut:r
Advanced argument(s):
local - When true, the shell performs the command against local file system.
Shortcut:l
Default Value: false
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed.
The default value is false. When true, only the help is printed and all the
other arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
mv - Moves a file to another location.
E.g) mv source dest
Command alias:[move]
Mandatory argument(s):
Optional argument(s):
force - The flag to indicate if the operation needs to be forced.
Shortcut:f
Advanced argument(s):
local - When true, the shell performs the command against local file system.
Shortcut:l
Default Value: false
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
get - Gets(download) a remote file to the current local directory.
E.g) get remotepath
Command alias:[download]
Mandatory argument(s):
Optional argument(s):
force - The flag to indicate if the operation needs to be forced.
Shortcut:f
Advanced argument(s):
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
zget - Gets(download) a remote dir as a zip file to the current local directory.
E.g) zget;zget remotedir
Mandatory argument(s):
Optional argument(s):
force - The flag to indicate if the operation needs to be forced.
Shortcut:f
Advanced argument(s):
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
put - Puts(upload) a local file to the current remote directory.
E.g) put localpath
Command alias:[upload]
Mandatory argument(s):
Optional argument(s):
force - The flag to indicate if the operation needs to be forced.
Shortcut:f
Advanced argument(s):
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
usage - Prints the usage of this tool into the HTML file (defaulted to - usage.html)
for off-line reference.
Mandatory argument(s):
Optional argument(s):
output - The output directory in which the usage.html is to be written. The default
value is the current directory.
Shortcut:o
Advanced argument(s):
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
exit - Exits from this shell.
Mandatory argument(s):
Optional argument(s):
Advanced argument(s):
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
Top
Command:
hist - Displays history of commands. It can also execute a command from the history.
E.g) hist;hist id
Mandatory argument(s):
Optional argument(s):
Advanced argument(s):
Diagnostic/Help argument(s):
help - The flag (true/false) to indicate whether the help text should be printed. The
default value is false. When true, only the help is printed and all the other
arguments, if specified, are ignored.
Shortcut:h
Default Value: false
debug - The flag (true/false) to indicate whether the debug-level messages should be
printed. The debug messages are more detailed than INFO-level messages. The
default value is false.
Shortcut:d
Default Value: false
