OS Manuals

/usr/bin/ferretdb

A truly Open Source MongoDB alternative

From ferretdb 2.7.0-r37 (os), captured 2026-11-07 by running ferretdb --help (exit 0). permalink

Usage: ferretdb <command> [flags]

Flags:
  -h, --help       Show context-sensitive help.
      --version    Print version to stdout and exit.

PostgreSQL
  --postgresql-url="postgres://127.0.0.1:5432/postgres"
      PostgreSQL URL ($FERRETDB_POSTGRESQL_URL).
  --postgresql-url-file=POSTGRESQL-URL-FILE
      Path to a file containing the PostgreSQL connection URL. If non-empty, this overrides
      --postgresql-url ($FERRETDB_POSTGRESQL_URL_FILE).

Interfaces
  --listen-addr="127.0.0.1:27017"    Listen TCP address for MongoDB protocol
                                     ($FERRETDB_LISTEN_ADDR).
  --listen-unix=""                   Listen Unix domain socket path for MongoDB protocol
                                     ($FERRETDB_LISTEN_UNIX).
  --listen-tls=""                    Listen TLS address for MongoDB protocol ($FERRETDB_LISTEN_TLS).
  --listen-tls-cert-file=""          TLS cert file path ($FERRETDB_LISTEN_TLS_CERT_FILE).
  --listen-tls-key-file=""           TLS key file path ($FERRETDB_LISTEN_TLS_KEY_FILE).
  --listen-tls-ca-file=""            TLS CA file path ($FERRETDB_LISTEN_TLS_CA_FILE).
  --listen-data-api-addr=""          Listen TCP address for HTTP Data API
                                     ($FERRETDB_LISTEN_DATA_API_ADDR).
  --listen-mcp-addr=""               Listen TCP address for HTTP MCP server
                                     ($FERRETDB_LISTEN_MCP_ADDR).
  --proxy-addr=""                    Proxy address ($FERRETDB_PROXY_ADDR).
  --proxy-tls-cert-file=""           Proxy TLS cert file path ($FERRETDB_PROXY_TLS_CERT_FILE).
  --proxy-tls-key-file=""            Proxy TLS key file path ($FERRETDB_PROXY_TLS_KEY_FILE).
  --proxy-tls-ca-file=""             Proxy TLS CA file path ($FERRETDB_PROXY_TLS_CA_FILE).
  --debug-addr="127.0.0.1:8088"      Listen address for HTTP handlers for metrics, pprof, etc
                                     ($FERRETDB_DEBUG_ADDR).

Miscellaneous
  --mode="normal"                   Operation mode: 'normal', 'proxy', 'diff-normal', 'diff-proxy'
                                    ($FERRETDB_MODE).
  --state-dir="."                   Process state directory ($FERRETDB_STATE_DIR).
  --[no-]auth                       Enable authentication (on by default) ($FERRETDB_AUTH).
  --log-level="INFO"                Log level: 'DEBUG', 'INFO', 'WARN', 'ERROR'
                                    ($FERRETDB_LOG_LEVEL).
  --log-format="console"            Log format: 'console', 'text', 'json', 'mongo'
                                    ($FERRETDB_LOG_FORMAT).
  --[no-]log-uuid                   Add instance UUID to all log messages ($FERRETDB_LOG_UUID).
  --[no-]metrics-uuid               Add instance UUID to all metrics ($FERRETDB_METRICS_UUID).
  --otel-service-name="ferretdb"    OpenTelemetry service name ($FERRETDB_OTEL_SERVICE_NAME).
  --otel-traces-url=""              OpenTelemetry OTLP/HTTP traces endpoint URL (e.g.
                                    'http://host:4318/v1/traces') ($FERRETDB_OTEL_TRACES_URL).
  --telemetry=undecided             Enable or disable basic telemetry reporting. See
                                    https://beacon.ferretdb.com ($FERRETDB_TELEMETRY).

Commands:
  ping [flags]
    Ping existing FerretDB instance.

Run "ferretdb <command> --help" for more information on a command.
Options (24)
OptionDescriptionSource
-h, --helpShow context-sensitive help.help
--versionPrint version to stdout and exit.help
--postgresql-url "postgres://127.0.0.1:5432/postgres"PostgreSQL URL ($FERRETDB_POSTGRESQL_URL).help
--postgresql-url-file POSTGRESQL-URL-FILEPath to a file containing the PostgreSQL connection URL.help
--listen-addr "127.0.0.1:27017"Listen TCP address for MongoDB protocol ($FERRETDB_LISTEN_ADDR).help
--listen-unix ""Listen Unix domain socket path for MongoDB protocol ($FERRETDB_LISTEN_UNIX).help
--listen-tls ""Listen TLS address for MongoDB protocol ($FERRETDB_LISTEN_TLS).help
--listen-tls-cert-file ""TLS cert file path ($FERRETDB_LISTEN_TLS_CERT_FILE).help
--listen-tls-key-file ""TLS key file path ($FERRETDB_LISTEN_TLS_KEY_FILE).help
--listen-tls-ca-file ""TLS CA file path ($FERRETDB_LISTEN_TLS_CA_FILE).help
--listen-data-api-addr ""Listen TCP address for HTTP Data API ($FERRETDB_LISTEN_DATA_API_ADDR).help
--listen-mcp-addr ""Listen TCP address for HTTP MCP server ($FERRETDB_LISTEN_MCP_ADDR).help
--proxy-addr ""Proxy address ($FERRETDB_PROXY_ADDR).help
--proxy-tls-cert-file ""Proxy TLS cert file path ($FERRETDB_PROXY_TLS_CERT_FILE).help
--proxy-tls-key-file ""Proxy TLS key file path ($FERRETDB_PROXY_TLS_KEY_FILE).help
--proxy-tls-ca-file ""Proxy TLS CA file path ($FERRETDB_PROXY_TLS_CA_FILE).help
--debug-addr "127.0.0.1:8088"Listen address for HTTP handlers for metrics, pprof, etc ($FERRETDB_DEBUG_ADDR).help
--mode "normal"Operation mode: 'normal', 'proxy', 'diff-normal', 'diff-proxy' ($FERRETDB_MODE).help
--state-dir "."Process state directory ($FERRETDB_STATE_DIR).help
--log-level "INFO"Log level: 'DEBUG', 'INFO', 'WARN', 'ERROR' ($FERRETDB_LOG_LEVEL).help
--log-format "console"Log format: 'console', 'text', 'json', 'mongo' ($FERRETDB_LOG_FORMAT).help
--otel-service-name "ferretdb"OpenTelemetry service name ($FERRETDB_OTEL_SERVICE_NAME).help
--otel-traces-url ""OpenTelemetry OTLP/HTTP traces endpoint URL (e.g. 'http://host:4318/v1/traces') ($FERRETDB_OTEL_TRACES_URL).help
--telemetry undecidedEnable or disable basic telemetry reporting.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.