Moab Accounting Manager > Appendices > Appendix A: Commands Reference > goldsh

goldsh

Synopsis

goldsh [--debug] [--site <site_name>] [--help] [--man] [--format <output_type>] [--quiet] [--verbose] [--version] [<command>]

Overview

goldsh is an interactive control program that can access all functionality available in Gold. You can invoke commands directly from the command line, or an interpreter can parse commands from stdin.

Commands follow the form:

<Object>[,<Object>...] <Action> [<Predicate>]...

<Predicate> follows the form:

[<Conjunction>] [<OpenParentheses>] [<Object>.]<Name Operator> [<Subject>.]<Value> [<CloseParentheses>]

Where

<Conjunction> defaults to "And" and includes:
- && – and
- || – or
- &! – and not
- |! – or not
<OpenParentheses> can be any number of literal open parentheses '('.
<Name> is the name of the condition, assignment or option.
<Operator> is one of:
- == – equals
- < – less than
- > – greater than
- <= – less than or equal to
- >= – greater than or equal to
- != – not equal to
- ~ – matches
- !~ – does not match
- = – assignment
- += – increment
- -= – decrement
- := – option
- :! – negated option
<Value> is the value of the condition, assignment, or option and may be enclosed in double quotes to enclose spaces or special characters.
<CloseParentheses> can be any number of literal close parentheses ')'.

You can specify the desired selections (columns to be displayed) in a query via a pseudo Show option with a value of comma-separated attribute names. It can optionally include an object, operator and alias. It will follow the form:

Show:="[operator(][object.]name[=alias][)][,[operator(][object.]name[=alias][)]]...".

See Using the gold shell (goldsh) for more information on constructing requests.

Options

--debug
Format	--debug
Default	---
Description	Logs debug information to the screen.

--format
Format	--format <standard\|csv>
Default	standard
Description	Specifies the data output format. Valid values include standard and csv.

--help
Format	--help
Default	---
Description	Displays a brief help message.

--man
Format	--man
Default	---
Description	Displays full documentation.

--quiet
Format	--quiet
Default	---
Description	Suppresses headers and success messages.

--site
Format	--site <site_name>
Default	---
Description	Obtains a response from specified site.

--verbose
Format	--verbose
Default	---
Description	Displays modified object details.

--version
Format	--version
Default	---
Description	Displays the product version.