.\" Text automatically generated by txt2man
.TH grr_console 1 "18 July 2017" "GRR 3.1.0.2" ""
.SH NAME
\fBgrr_console \fP- GRR Rapid Response server console
\fB
.SH SYNOPSIS
.nf
.fam C
\fBgrr_console\fP [\fB-h\fP] [\fB--verbose\fP] [\fB--debug\fP] [\fB--config\fP \fICONFIG\fP]
            [\fB--secondary_configs\fP \fISECONDARY_CONFIGS\fP] [\fB--config_help\fP]
            [\fB--context\fP \fICONTEXT\fP] [\fB--plugins\fP \fIPLUGINS\fP]
            [\fB--disallow_missing_config_definitions\fP] [\fB-p\fP \fIPARAMETER\fP]
            [\fB--list_storage\fP] [\fB--local_client\fP] [\fB--local_worker\fP]
            [\fB--client_ids\fP \fICLIENT_IDS\fP] [\fB--hostnames\fP \fIHOSTNAMES\fP]
            [\fB--testnames\fP \fITESTNAMES\fP] [\fB--client\fP \fICLIENT\fP] [\fB--reason\fP \fIREASON\fP]
            [\fB--code_to_execute\fP \fICODE_TO_EXECUTE\fP]
            [\fB--command_file\fP \fICOMMAND_FILE\fP] [\fB--exit_on_complete\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
This is the interactive console for the GRR server. Its usage follows the
guidelines of IPython as it is based on this toolkit.
.SH OPTIONS
.TP
.B
\fB--verbose\fP
Turn of verbose logging.
.TP
.B
\fB--debug\fP
When an unhandled exception occurs break in the
debugger.
.TP
.B
\fB--config\fP \fICONFIG\fP
Primary Configuration file to use. This is normally
taken from the installed package and should rarely be
specified.
.PP
\fB--secondary_configs\fP \fISECONDARY_CONFIGS\fP
Secondary configuration files to load (These override
previous configuration files.).
.TP
.B
\fB--config_help\fP
Print help about the configuration.
.TP
.B
\fB--context\fP \fICONTEXT\fP
Use these contexts for the config.
.TP
.B
\fB--plugins\fP \fIPLUGINS\fP
Load these files as additional plugins.
.PP
\fB--disallow_missing_config_definitions\fP
If true, we raise an error on undefined config
options.
.PP
\fB-p\fP \fIPARAMETER\fP, \fB--parameter\fP \fIPARAMETER\fP
Global override of config values. For example \fB-p\fP
DataStore.implementation=MySQLDataStore
.TP
.B
\fB--list_storage\fP
List all storage subsystems present.
.TP
.B
\fB--local_client\fP
The target \fBclient\fP(s) are running locally.
.TP
.B
\fB--local_worker\fP
Run tests with a local worker.
.PP
\fB--client_ids\fP \fICLIENT_IDS\fP
List of client ids to test. If unset we use
Test.end_to_end_client_ids from the config.
.PP
\fB--hostnames\fP \fIHOSTNAMES\fP
List of client hostnames to test. If unset we use
Test.end_to_end_client_hostnames from the config.
.PP
\fB--testnames\fP \fITESTNAMES\fP
List of test names to run. If unset we run all
relevant tests.
.TP
.B
\fB--client\fP \fICLIENT\fP
Initialise the console with this client id (e.g.
C.1234345).
.TP
.B
\fB--reason\fP \fIREASON\fP
Create a default token with this access reason
.PP
\fB--code_to_execute\fP \fICODE_TO_EXECUTE\fP
If present, no console is started but the code given
in the flag is run instead (comparable to the \fB-c\fP
option of IPython).
.PP
\fB--command_file\fP \fICOMMAND_FILE\fP
If present, no console is started but the code given
in command file is supplied as input instead.
.TP
.B
\fB--exit_on_complete\fP
If set to False and command_file or code_to_execute is
set we keep the console alive after the code
completes.
.SH SEE ALSO
\fBgrr_export\fP(1), \fBgrr_fuse\fP(1).
.SH AUTHOR
GRR developers team <grr-dev@googlegroups.com>