help

help <command>  [--as-json] [--all] [--directory]

Shows help about command line tool and commands. This command can be executed any time.

Arguments

Argument	Explanation
command	command to show help for

Options

Option	Explanation
–as-json	output all texts as json
–all	output detailed help for all commands
–directory	output detailed help for all commands

Example

Interactive

tomas@tomsmbp:~/ > dboo example_queries -u=example_user -p=password

# First, just type help...
dboo example_user@example_queries> help
Usage from command line:
 > dboo <connect string> -- <command> [<required argument> [<options> ...]] [> <output file>] [< input file]

<connect string>: <database> [-u=<user>] [-p=<password>] [--port=<port>] [--host=<host>]

To view help of individual commands use:
 > dboo --help <command>

Usage from dboo prompt, interactive use:
dboo> <command> [<required argument> [<options> ...]] [> <output file>] [< input file]

Use the tab key in interactive mode to list available commands and/or completions and auto complete.
To view help of individual commands use:
   help <command>

Commands:
   exit                             Exits the dboo shell.
   quit                             Exits the dboo shell.
   connect                          Connects to the specified database.
   add group                        Adds a new group.
   modify group                     Modifies an existing group.
   drop group                       Deletes an existing group.
   add user                         Adds a new user.
   modify user                      Modifies an existing user.
   drop user                        Deletes an existing user.
   create database                  Creates a new database.
   modify database                  Modifies an existing database.
   create index                     Creates a type or field index.
   rebuild index                    Rebuilds a type or field index.
   rebuild all indices              Rebuilds all type and field indics.
   modify index                     Modify a type or field index.
   drop index                       Deletes a type or field index.
   drop database                    Deletes a database.
   list users                       Lists existing users.
   list groups                      Lists existing groups.
   list databases                   Lists databases.
   list indices                     Lists indices.
   dbconfig list                    lists a database's configuration.
   help                             Shows help about command line tool and commands.
   version                          Shows version of dboo command line utility and (if connected) server.
   select<class>([<expression>])    Select objects from type <class> that matches the specified <expression>.
   erase<class>([<expression>])     Erase objects from type <class> that matches the specified <expression>.
   request<class>([<expression>])   Requests named objects
   count<class>([<expression>])     Count objects from type <class> that matches the specified <expression>.
   list classes                     Lists classes used in database.
   print class                      Print class definition.
   set password                     Sets the current user's password.
   restore                          Restores database from a backup source.
   backup                           Backups database to standard out or a file.
   config                           Sets/gets variables for dboo command line
   server logs                      Sets/gets variables for dboo command line

# Help for one command 'add group'
dboo example_user@example_queries> help add group
add group
Usage (from dboo, interactive mode):

add group <groupid>  [[<option>=<value>] ...] [> <output file>] [< input file]

Adds a new group.
This command requires connection to the server database.

Arguments:
   groupid             group id

Options:
   --description, -d   description

Non-interactive

tomas@tomsmbp:~/ > dboo --help
Usage from command line:
 > dboo <connect string> -- <command> [<required argument> [<options> ...]] [> <output file>] [< input file]

<connect string>: <database> [-u=<user>] [-p=<password>] [--port=<port>] [--host=<host>]

To view help of individual commands use:
 > dboo --help <command>

Usage from dboo prompt, interactive use:
dboo> <command> [<required argument> [<options> ...]] [> <output file>] [< input file]

Use the tab key in interactive mode to list available commands and/or completions and auto complete.
To view help of individual commands use:
   help <command>

Commands:
   exit                             Exits the dboo shell.
   quit                             Exits the dboo shell.
   connect                          Connects to the specified database.
   add group                        Adds a new group.
   modify group                     Modifies an existing group.
   drop group                       Deletes an existing group.
   add user                         Adds a new user.
   modify user                      Modifies an existing user.
   drop user                        Deletes an existing user.
   create database                  Creates a new database.
   modify database                  Modifies an existing database.
   create index                     Creates a type or field index.
   rebuild index                    Rebuilds a type or field index.
   rebuild all indices              Rebuilds all type and field indics.
   modify index                     Modify a type or field index.
   drop index                       Deletes a type or field index.
   drop database                    Deletes a database.
   list users                       Lists existing users.
   list groups                      Lists existing groups.
   list databases                   Lists databases.
   list indices                     Lists indices.
   dbconfig list                    lists a database's configuration.
   help                             Shows help about command line tool and commands.
   version                          Shows version of dboo command line utility and (if connected) server.
   select<class>([<expression>])    Select objects from type <class> that matches the specified <expression>.
   erase<class>([<expression>])     Erase objects from type <class> that matches the specified <expression>.
   request<class>([<expression>])   Requests named objects
   count<class>([<expression>])     Count objects from type <class> that matches the specified <expression>.
   list classes                     Lists classes used in database.
   print class                      Print class definition.
   set password                     Sets the current user's password.
   restore                          Restores database from a backup source.
   backup                           Backups database to standard out or a file.
   config                           Sets/gets variables for dboo command line
   server logs                      Sets/gets variables for dboo command line