arangoinspect Options

arangoinspect Options

Usage: arangoinspect [<options>]

General

Name	Type	Description
`check-configuration`	boolean	Check the configuration and exit This is a command, no value needs to be specified. The process terminates after executing the command.
`config`	string	The configuration file or ‘none’ Default: `“”`
`configuration`	string	The configuration file or ‘none’ Default: `“”`
`default-language`	string	ISO-639 language code Default: `“”`
`default-language-check`	boolean	Check if default language matches stored language This option can be specified without value to enable it. Default: `true` Introduced in: v3.8.0
`define`	string…	Define key=value for a @key@ entry in config file Default: `[]`
`dump-dependencies`	boolean	Dump dependency graph This is a command, no value needs to be specified. The process terminates after executing the command.
`dump-options`	boolean	Dump configuration options in JSON format This is a command, no value needs to be specified. The process terminates after executing the command.
`jslint`	string…	Do not start as shell, run jslint instead Default: `[]`
`log`	string…	The global or topic-specific log level Default: `[“info”]` Deprecated in: v3.5.0
`quiet`	boolean	Silent startup This option can be specified without value to enable it. Default: `false`
`version`	boolean	Reports the version and exits This is a command, no value needs to be specified. The process terminates after executing the command.

Console

Name	Type	Description
`console.audit-file`	string	Audit log file to save commands and results Default: `“”`
`console.auto-complete`	boolean	Enable auto completion This option can be specified without value to enable it. Default: `true`
`console.colors`	boolean	Enable color support This option can be specified without value to enable it. Default: dynamic (e.g. `false`)
`console.history`	boolean	Whether or not to load and persist command-line history This option can be specified without value to enable it. Default: `true` Introduced in: v3.4.5
`console.pager`	boolean	Enable paging This option can be specified without value to enable it. Default: `false`
`console.pager-command`	string	Pager command Default: `“less -X -R -F -L”`
`console.pretty-print`	boolean	Enable pretty printing This option can be specified without value to enable it. Default: `true`
`console.prompt`	string	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> “`

Encryption

Name	Type	Description
`encryption.key-generator`	string	Enterprise Edition only Program providing the encryption key on stdout. If set, encryption will be enabled. Default: `“”`
`encryption.keyfile`	string	Enterprise Edition only File containing the encryption key. If set, encryption will be enabled. Default: `“”`

JavaScript

Name	Type	Description
`javascript.allow-external-process-control`	boolean	Allow execution and control of external processes from within JavaScript actions This option can be specified without value to enable it. Default: `false` Introduced in: v3.5.0
`javascript.allow-port-testing`	boolean	Allow testing of ports from within JavaScript actions This option can be specified without value to enable it. Default: `false` Introduced in: v3.5.0
`javascript.check-syntax`	string…	Syntax check code JavaScript code from file Default: `[]`
`javascript.client-module`	string	Client module to use at startup Default: `“inspector.js”`
`javascript.copy-directory`	string	Target directory to copy files from ‘javascript.startup-directory’ into (only used when `—javascript.copy-installation` is enabled) Default: `“”`
`javascript.copy-installation`	boolean	Copy contents of ‘javascript.startup-directory’ This option can be specified without value to enable it. Default: `false`
`javascript.current-module-directory`	boolean	Add current directory to module path This option can be specified without value to enable it. Default: `true`
`javascript.endpoints-allowlist`	string…	Endpoints that can be connected to via @arangodb/request module in JavaScript actions Default: `[]` Introduced in: v3.5.0
`javascript.endpoints-denylist`	string…	Endpoints that cannot be connected to via @arangodb/request module in JavaScript actions (if not in allowlist) Default: `[]` Introduced in: v3.5.0
`javascript.environment-variables-allowlist`	string…	Environment variables that will be accessible in JavaScript Default: `[]` Introduced in: v3.5.0
`javascript.environment-variables-denylist`	string…	Environment variables that will be inaccessible in JavaScript (if not in allowlist) Default: `[]` Introduced in: v3.5.0
`javascript.execute`	string…	Execute JavaScript code from file Default: `[]`
`javascript.execute-string`	string…	Execute JavaScript code from string Default: `[]`
`javascript.files-allowlist`	string…	Filesystem paths that will be accessible from within JavaScript actions Default: `[]` Introduced in: v3.5.0
`javascript.gc-interval`	uint64	Request-based garbage collection interval (each n.th command) Default: `50`
`javascript.harden`	boolean	Disables access to JavaScript functions in the internal module: getPid() and logLevel() This option can be specified without value to enable it. Default: `false` Introduced in: v3.5.0
`javascript.module-directory`	string…	Additional paths containing JavaScript modules Default: `[]`
`javascript.startup-directory`	string	Startup paths containing the JavaScript files Default: `“./js”`
`javascript.startup-options-allowlist`	string…	Startup options whose names match this regular expression will be allowed and exposed to JavaScript Default: `[]` Introduced in: v3.5.0
`javascript.startup-options-denylist`	string…	Startup options whose names match this regular expression will not be exposed (if not in allowlist) to JavaScript actions Default: `[]` Introduced in: v3.5.0
`javascript.unit-test-filter`	string	Filter testcases in suite Default: `“”`
`javascript.unit-tests`	string…	Do not start as shell, run unit tests instead Default: `[]`
`javascript.v8-max-heap`	uint64	Maximal heap size (in MB) Default: `3072`
`javascript.v8-options`	string…	Options to pass to v8 Default: `[]`

Log

Name	Type	Description
`log.color`	boolean	Use colors for TTY logging This option can be specified without value to enable it. Default: dynamic (e.g. `true`)
`log.escape`	boolean	Escape characters when logging This option can be specified without value to enable it. Default: `true`
`log.file`	string	Shortcut for ‘—log.output file://‘ Default: `“-“`
`log.file-group`	string	Group to use for new log file, user must be a member of this group Default: `“”` Introduced in: v3.4.5
`log.file-mode`	string	Mode to use for new log file, umask will be applied as well Default: `“”` Introduced in: v3.4.5
`log.force-direct`	boolean	Do not start a seperate thread for logging This option can be specified without value to enable it. Default: `false`
`log.foreground-tty`	boolean	Also log to tty if backgrounded This option can be specified without value to enable it. Default: dynamic (e.g. `false`)
`log.hostname`	string	Hostname to use in log message (empty for none, use ‘auto’ to automatically figure out hostname) Default: `“”` Introduced in: v3.8.0
`log.ids`	boolean	Log unique message ids This option can be specified without value to enable it. Default: `true` Introduced in: v3.5.0
`log.level`	string…	The global or topic-specific log level Default: `[“info”]`
`log.line-number`	boolean	Include the function name, file name and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]` This option can be specified without value to enable it. Default: `false`
`log.max-entry-length`	uint32	Maximum length of a log entry (in bytes) Default: `134217728` Introduced in: v3.7.9
`log.output`	string…	Log destination(s), e.g. file:///path/to/file (any ‘$PID’ will be replaced with the process id) Default: `[]`
`log.performance`	boolean	Shortcut for ‘—log.level performance=trace’ This option can be specified without value to enable it. Default: `false` Deprecated in: v3.5.0
`log.prefix`	string	Prefix log message with this string Default: `“”`
`log.process`	boolean	Show process identifier (pid) in log message This option can be specified without value to enable it. Default: `true` Introduced in: v3.8.0
`log.request-parameters`	boolean	Include full URLs and HTTP request parameters in trace logs This option can be specified without value to enable it. Default: `true`
`log.role`	boolean	Log server role This option can be specified without value to enable it. Default: `false`
`log.shorten-filenames`	boolean	Shorten filenames in log output (use with —log.line-number) This option can be specified without value to enable it. Default: `true`
`log.thread`	boolean	Show thread identifier in log message This option can be specified without value to enable it. Default: `false`
`log.thread-name`	boolean	Show thread name in log message This option can be specified without value to enable it. Default: `false`
`log.time-format`	string	Time format to use in logs Default: `“utc-datestring”` Possible values: “local-datestring”, “timestamp”, “timestamp-micros”, “timestamp-millis”, “uptime”, “uptime-micros”, “uptime-millis”, “utc-datestring”, “utc-datestring-millis” Introduced in: v3.5.0
`log.use-json-format`	boolean	Use json output format This option can be specified without value to enable it. Default: `false` Introduced in: v3.8.0
`log.use-local-time`	boolean	Use local timezone instead of UTC This option can be specified without value to enable it. Default: `false` Deprecated in: v3.5.0
`log.use-microtime`	boolean	Use microtime instead This option can be specified without value to enable it. Default: `false` Deprecated in: v3.5.0

Random

Name	Type	Description
`random.generator`	uint32	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

Name	Type	Description
`server.ask-jwt-secret`	boolean	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.authentication`	boolean	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-timeout`	double	Connection timeout in seconds Default: `5`
`server.database`	string	Database name to use when connecting Default: `“_system”`
`server.endpoint`	string	Endpoint to connect to. Use ‘none’ to start without a server. Use http+ssl:// or vst+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp://, vst+tcp:// or unix:// Default: `“http+tcp://127.0.0.1:8529”`
`server.force-json`	boolean	Force to not use VelocyPack for easier debugging This option can be specified without value to enable it. Default: `false` Introduced in: v3.6.0
`server.jwt-secret-keyfile`	string	If this option is specified, the jwt secret will be loaded from the given file. This option is not compatible with —server.ask-jwt-secret, —server.username or —server.password. If specified, it will be used for all connections - even when a new connection to another server is created Default: `“”`
`server.max-packet-size`	uint64	Maximum packet size (in bytes) for client/server communication Default: `1073741824`
`server.password`	string	Password to use when connecting. If not specified and authentication is required, the user will be prompted for a password Default: `“”`
`server.request-timeout`	double	Request timeout in seconds Default: `1200`
`server.username`	string	Username to use when connecting Default: `“root”`

SSL

Name	Type	Description
`ssl.protocol`	uint64	Ssl protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS) Default: `5` Possible values: 1, 2, 3, 4, 5, 6, 9

Temp

Name	Type	Description
`temp.path`	string	Path for temporary files Default: `“”`