Arangoinspect Options

Usage: arangoinspect [<options>]

Global Options

NameTypeDescription
check-configurationboolean Check the configuration and exit.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
configstring The configuration file or 'none'.
Default: ""
configurationstring The configuration file or 'none'.
Default: ""
default-languagestring ISO-639 language code.
Default: ""
definestring... Define key=value for a @key@ entry in config file.
Default: []
dump-dependenciesboolean Dump dependency graph.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
dump-optionsboolean Dump configuration options in JSON format.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: true
jslintstring... Do not start as shell, run jslint instead.
Default: []
logstring... The global or topic-specific log level.
Default: ["info"]
quietboolean Silent startup.
This option can be specified without value to enable it.
Default: false
versionboolean Reports the version and exits.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false

Console Options

NameTypeDescription
console.audit-filestring Audit log file to save commands and results.
Default: ""
console.auto-completeboolean Enable auto completion.
This option can be specified without value to enable it.
Default: true
console.colorsboolean Enable color support.
This option can be specified without value to enable it.
Default: true
console.pagerboolean Enable paging.
This option can be specified without value to enable it.
Default: false
console.pager-commandstring Pager command.
Default: "less -X -R -F -L"
console.pretty-printboolean Enable pretty printing.
This option can be specified without value to enable it.
Default: true
console.promptstring Prompt used in REPL. prompt components are: '%t': current time as timestamp, '%p': duration of last command in seconds, '%d': name of current database, '%e': current endpoint, '%E': current endpoint without protocol, '%u': current user.
Default: "%E@%d> "

Javascript Options

NameTypeDescription
javascript.check-syntaxstring... Syntax check code Javascript code from file.
Default: []
javascript.client-modulestring Client module to use at startup.
Default: "inspector.js"
javascript.copy-directorystring Target directory to copy files from 'javascript.startup-directory' into(only used when `--javascript.copy-installation` is enabled).
Default: ""
javascript.copy-installationboolean Copy contents of 'javascript.startup-directory'.
This option can be specified without value to enable it.
Default: false
javascript.current-module-directoryboolean Add current directory to module path.
This option can be specified without value to enable it.
Default: true
javascript.executestring... Execute Javascript code from file.
Default: []
javascript.execute-stringstring... Execute Javascript code from string.
Default: []
javascript.gc-intervaluint64 Request-based garbage collection interval (each n.th command).
Default: 50
javascript.module-directorystring... Additional paths containing JavaScript modules.
Default: []
javascript.startup-directorystring Startup paths containing the Javascript files.
Default: "./js"
javascript.unit-test-filterstring Filter testcases in suite.
Default: ""
javascript.unit-testsstring... Do not start as shell, run unit tests instead.
Default: []
javascript.v8-max-heapuint64 Maximal heap size (in MB).
Default: 3072
javascript.v8-optionsstring... Options to pass to v8.
Default: []

Log Options

NameTypeDescription
log.colorboolean Use colors for TTY logging.
This option can be specified without value to enable it.
Default: true
log.escapeboolean Escape characters when logging.
This option can be specified without value to enable it.
Default: true
log.filestring Shortcut for '--log.output file://<filename>'.
Default: "-"
log.force-directboolean Do not start a seperate thread for logging.
This option can be specified without value to enable it.
Default: false
log.foreground-ttyboolean Also log to tty if backgrounded.
This option can be specified without value to enable it.
Default: false
log.keep-logrotateboolean Keep the old log file after receiving a sighup.
This option can be specified without value to enable it.
Default: false
log.levelstring... The global or topic-specific log level.
Default: ["info"]
log.line-numberboolean Append line number and file name.
This option can be specified without value to enable it.
Default: false
log.outputstring... Log destination(s).
Default: []
log.performanceboolean Shortcut for '--log.level performance=trace'.
This option can be specified without value to enable it.
Default: false
log.prefixstring Prefix log message with this string.
Default: ""
log.request-parametersboolean Include full URLs and HTTP request parameters in trace logs.
This option can be specified without value to enable it.
Default: true
log.roleboolean Log server role.
This option can be specified without value to enable it.
Default: false
log.shorten-filenamesboolean Shorten filenames in log output (use with --log.line-number).
This option can be specified without value to enable it.
Default: true
log.threadboolean Show thread identifier in log message.
This option can be specified without value to enable it.
Default: false
log.thread-nameboolean Show thread name in log message.
This option can be specified without value to enable it.
Default: false
log.use-local-timeboolean Use local timezone instead of UTC.
This option can be specified without value to enable it.
Default: false
log.use-microtimeboolean Use microtime instead.
This option can be specified without value to enable it.
Default: false

Random Options

NameTypeDescription
random.generatoruint32 Random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not for Windows), 5 = WinCrypt (Windows only).
Default: 1
Possible values:
  • 1
  • 2
  • 3
  • 4

Server Options

NameTypeDescription
server.ask-jwt-secretboolean If this option is specified, the user will be prompted for a JWT secret. This option is not compatible with --server.username or --server.password. If specified, it will be used for all connections - even when a new connection to another server is created.
This option can be specified without value to enable it.
Default: true
server.authenticationboolean Require authentication credentials when connecting (does not affect the server-side authentication settings).
This option can be specified without value to enable it.
Default: false
server.connection-timeoutdouble Connection timeout in seconds.
Default: 5
server.databasestring Database name to use when connecting.
Default: "_system"
server.endpointstring Endpoint to connect to, use 'none' to start without a server.
Default: "http+tcp://127.0.0.1:8529"
server.max-packet-sizeuint64 Maximum packet size (in bytes) for client/server communication.
Default: 1073741824
server.passwordstring Password to use when connecting. If not specified and authentication is required, the user will be prompted for a password.
Default: ""
server.request-timeoutdouble Request timeout in seconds.
Default: 1200
server.usernamestring Username to use when connecting.
Default: "root"

Ssl Options

NameTypeDescription
ssl.protocoluint64 Ssl protocol (1 = SSLv2, 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2).
Default: 5
Possible values:
  • 1
  • 2
  • 3
  • 4
  • 5

Temp Options

NameTypeDescription
temp.pathstring Path for temporary files.
Default: ""