arangoinspect Options

Usage: arangoinspect [<options>]

General

--check-configuration

Type: boolean

Check the configuration and exit

This is a command, no value needs to be specified. The process terminates after executing the command.

--config

Type: string

The configuration file or 'none'

Default: ""

--configuration

Type: string

The configuration file or 'none'

Default: ""

--default-language

Type: string

ISO-639 language code

Default: ""

--default-language-check

Introduced in: v3.8.0

Type: boolean

Check if default language matches stored language

This option can be specified without a value to enable it.

Default: true

--define

Type: string…

Define key=value for a @key@ entry in config file

Default: []

--dump-dependencies

Type: boolean

Dump dependency graph

This is a command, no value needs to be specified. The process terminates after executing the command.

--dump-options

Type: 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

Type: string…

Do not start as shell, run jslint instead

Default: []

--log

Deprecated in: v3.5.0

Type: string…

The global or topic-specific log level

Default: ["info"]

--quiet

Type: boolean

Silent startup

This option can be specified without a value to enable it.

Default: false

--version

Type: boolean

Reports the version and exits

This is a command, no value needs to be specified. The process terminates after executing the command.

Console

--console.audit-file

Type: string

Audit log file to save commands and results

Default: ""

--console.auto-complete

Type: boolean

Enable auto completion

This option can be specified without a value to enable it.

Default: true

--console.colors

Type: boolean

Enable color support

This option can be specified without a value to enable it.

Default: dynamic (e.g. false)

--console.history

Introduced in: v3.4.5

Type: boolean

Whether or not to load and persist command-line history

This option can be specified without a value to enable it.

Default: true

--console.pager

Type: boolean

Enable paging

This option can be specified without a value to enable it.

Default: false

--console.pager-command

Type: string

Pager command

Default: "less -X -R -F -L"

--console.pretty-print

Type: boolean

Enable pretty printing

This option can be specified without a value to enable it.

Default: true

--console.prompt

Type: 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

--encryption.key-generator

Enterprise Edition only

Type: string

Program providing the encryption key on stdout. If set, encryption will be enabled.

Default: ""

--encryption.keyfile

Enterprise Edition only

Type: string

File containing the encryption key. If set, encryption will be enabled.

Default: ""

JavaScript

--javascript.allow-external-process-control

Introduced in: v3.5.0

Type: boolean

Allow execution and control of external processes from within JavaScript actions

This option can be specified without a value to enable it.

Default: false

--javascript.allow-port-testing

Introduced in: v3.5.0

Type: boolean

Allow testing of ports from within JavaScript actions

This option can be specified without a value to enable it.

Default: false

--javascript.check-syntax

Type: string…

Syntax check code JavaScript code from file

Default: []

--javascript.client-module

Type: string

Client module to use at startup

Default: "inspector.js"

--javascript.copy-directory

Type: string

Target directory to copy files from 'javascript.startup-directory' into (only used when --javascript.copy-installation is enabled)

Default: ""

--javascript.copy-installation

Type: boolean

Copy contents of 'javascript.startup-directory'

This option can be specified without a value to enable it.

Default: false

--javascript.current-module-directory

Type: boolean

Add current directory to module path

This option can be specified without a value to enable it.

Default: true

--javascript.endpoints-allowlist

Introduced in: v3.5.0

Type: string…

Endpoints that can be connected to via @arangodb/request module in JavaScript actions

Default: []

--javascript.endpoints-denylist

Introduced in: v3.5.0

Type: string…

Endpoints that cannot be connected to via @arangodb/request module in JavaScript actions (if not in allowlist)

Default: []

--javascript.environment-variables-allowlist

Introduced in: v3.5.0

Type: string…

Environment variables that will be accessible in JavaScript

Default: []

--javascript.environment-variables-denylist

Introduced in: v3.5.0

Type: string…

Environment variables that will be inaccessible in JavaScript (if not in allowlist)

Default: []

--javascript.execute

Type: string…

Execute JavaScript code from file

Default: []

--javascript.execute-string

Type: string…

Execute JavaScript code from string

Default: []

--javascript.files-allowlist

Introduced in: v3.5.0

Type: string…

Filesystem paths that will be accessible from within JavaScript actions

Default: []

--javascript.gc-interval

Type: uint64

Request-based garbage collection interval (each n.th command)

Default: 50

--javascript.harden

Introduced in: v3.5.0

Type: boolean

Disables access to JavaScript functions in the internal module: getPid() and logLevel()

This option can be specified without a value to enable it.

Default: false

--javascript.module-directory

Type: string…

Additional paths containing JavaScript modules

Default: []

--javascript.startup-directory

Type: string

Startup paths containing the JavaScript files

Default: "./js"

--javascript.startup-options-allowlist

Introduced in: v3.5.0

Type: string…

Startup options whose names match this regular expression will be allowed and exposed to JavaScript

Default: []

--javascript.startup-options-denylist

Introduced in: v3.5.0

Type: string…

Startup options whose names match this regular expression will not be exposed (if not in allowlist) to JavaScript actions

Default: []

--javascript.unit-test-filter

Type: string

Filter testcases in suite

Default: ""

--javascript.unit-tests

Type: string…

Do not start as shell, run unit tests instead

Default: []

--javascript.v8-max-heap

Type: uint64

Maximal heap size (in MB)

Default: 3072

--javascript.v8-options

Type: string…

Options to pass to v8

Default: []

Log

--log.color

Type: boolean

Use colors for TTY logging

This option can be specified without a value to enable it.

Default: dynamic (e.g. true)

--log.escape

Type: boolean

Escape characters when logging

This option can be specified without a value to enable it.

Default: true

--log.file

Type: string

Shortcut for '--log.output file://<filename>'

Default: "-"

--log.file-group

Introduced in: v3.4.5

Type: string

Group to use for new log file, user must be a member of this group

Default: ""

--log.file-mode

Introduced in: v3.4.5

Type: string

Mode to use for new log file, umask will be applied as well

Default: ""

--log.force-direct

Type: boolean

Do not start a seperate thread for logging

This option can be specified without a value to enable it.

Default: false

--log.foreground-tty

Type: boolean

Also log to tty if backgrounded

This option can be specified without a value to enable it.

Default: dynamic (e.g. false)

--log.hostname

Introduced in: v3.8.0

Type: string

Hostname to use in log message (empty for none, use 'auto' to automatically figure out hostname)

Default: ""

--log.ids

Introduced in: v3.5.0

Type: boolean

Log unique message ids

This option can be specified without a value to enable it.

Default: true

--log.level

Type: string…

The global or topic-specific log level

Default: ["info"]

--log.line-number

Type: 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 a value to enable it.

Default: false

--log.max-entry-length

Introduced in: v3.7.9

Type: uint32

Maximum length of a log entry (in bytes)

Default: 134217728

--log.output

Type: string…

Log destination(s), e.g. file:///path/to/file (any '$PID' will be replaced with the process id)

Default: []

--log.performance

Deprecated in: v3.5.0

Type: boolean

Shortcut for '--log.level performance=trace'

This option can be specified without a value to enable it.

Default: false

--log.prefix

Type: string

Prefix log message with this string

Default: ""

--log.process

Introduced in: v3.8.0

Type: boolean

Show process identifier (pid) in log message

This option can be specified without a value to enable it.

Default: true

--log.request-parameters

Type: boolean

Include full URLs and HTTP request parameters in trace logs

This option can be specified without a value to enable it.

Default: true

--log.role

Type: boolean

Log server role

This option can be specified without a value to enable it.

Default: false

--log.shorten-filenames

Type: boolean

Shorten filenames in log output (use with --log.line-number)

This option can be specified without a value to enable it.

Default: true

--log.thread

Type: boolean

Show thread identifier in log message

This option can be specified without a value to enable it.

Default: false

--log.thread-name

Type: boolean

Show thread name in log message

This option can be specified without a value to enable it.

Default: false

--log.time-format

Introduced in: v3.5.0

Type: 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”

--log.use-json-format

Introduced in: v3.8.0

Type: boolean

Use json output format

This option can be specified without a value to enable it.

Default: false

--log.use-local-time

Deprecated in: v3.5.0

Type: boolean

Use local timezone instead of UTC

This option can be specified without a value to enable it.

Default: false

--log.use-microtime

Deprecated in: v3.5.0

Type: boolean

Use microtime instead

This option can be specified without a value to enable it.

Default: false

Random

--random.generator

Type: 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

--server.ask-jwt-secret

Type: 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 a value to enable it.

Default: true

--server.authentication

Type: boolean

Require authentication credentials when connecting (does not affect the server-side authentication settings)

This option can be specified without a value to enable it.

Default: false

--server.connection-timeout

Type: double

Connection timeout in seconds

Default: 5

--server.database

Type: string

Database name to use when connecting

Default: "_system"

--server.endpoint

Type: 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

Introduced in: v3.6.0

Type: boolean

Force to not use VelocyPack for easier debugging

This option can be specified without a value to enable it.

Default: false

--server.jwt-secret-keyfile

Type: 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

Type: uint64

Maximum packet size (in bytes) for client/server communication

Default: 1073741824

--server.password

Type: 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

Type: double

Request timeout in seconds

Default: 1200

--server.username

Type: string

Username to use when connecting

Default: "root"

SSL

--ssl.protocol

Type: 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

--temp.path

Type: string

Path for temporary files

Default: ""