Перейти к содержанию

CLI Reference

This page is generated from the Commander.js CLI definition during MkDocs builds. Update the CLI definition in source code instead of editing this page by hand.

Usage

Usage: cloakbrowser-mcp [options] [command]

Playwright MCP bridge backed by CloakBrowser.

Options:
  -V, --version                     output the version number
  -h, --help                        display help for command

Transport
  --transport <mode>                MCP transport exposed by the bridge.
                                    (choices: "stdio", "streamable-http",
                                    default: stdio, env:
                                    CLOAK_PLAYWRIGHT_MCP_TRANSPORT)

Bridge
  --geoip-proxy-match               Match CloakBrowser timezone and locale to
                                    the configured proxy GeoIP. (default: false,
                                    env: CLOAK_PLAYWRIGHT_MCP_GEOIP_PROXY_MATCH)
  --humanize                        Enable CloakBrowser human-like mouse,
                                    keyboard, and scroll behavior. (default:
                                    false, env: CLOAK_PLAYWRIGHT_MCP_HUMANIZE)
  --human-preset <preset>           CloakBrowser human behavior preset. Used
                                    only when humanize is enabled. (choices:
                                    "default", "careful", default: default, env:
                                    CLOAK_PLAYWRIGHT_MCP_HUMAN_PRESET)

Streamable HTTP
  --http-protocol <protocol>        Streamable HTTP listener protocol. (choices:
                                    "http", "https", default: http, env:
                                    CLOAK_PLAYWRIGHT_MCP_HTTP_PROTOCOL)
  --http-host <host>                Streamable HTTP bind host. (default:
                                    127.0.0.1, env:
                                    CLOAK_PLAYWRIGHT_MCP_HTTP_HOST)
  --http-port <port>                Streamable HTTP bind port. Use 0 for an
                                    ephemeral port in tests. (default: 3000,
                                    env: CLOAK_PLAYWRIGHT_MCP_HTTP_PORT)
  --http-endpoint <path>            Streamable HTTP endpoint path. Reserved
                                    probe paths: /healthz, /readyz. (default:
                                    /mcp, env:
                                    CLOAK_PLAYWRIGHT_MCP_HTTP_ENDPOINT)
  --http-auth-token <token>         Optional Bearer token required on Streamable
                                    HTTP requests. (env:
                                    CLOAK_PLAYWRIGHT_MCP_HTTP_AUTH_TOKEN)
  --https-cert <path>               TLS certificate PEM file for HTTPS
                                    Streamable HTTP. (env:
                                    CLOAK_PLAYWRIGHT_MCP_HTTPS_CERT)
  --https-key <path>                TLS private key PEM file for HTTPS
                                    Streamable HTTP. (env:
                                    CLOAK_PLAYWRIGHT_MCP_HTTPS_KEY)
  --https-pfx <path>                TLS PFX/PKCS12 file for HTTPS Streamable
                                    HTTP. (env: CLOAK_PLAYWRIGHT_MCP_HTTPS_PFX)
  --https-passphrase <value>        Passphrase for an encrypted HTTPS key or
                                    PFX. (env:
                                    CLOAK_PLAYWRIGHT_MCP_HTTPS_PASSPHRASE)
  --http-session-backend <backend>  Session metadata backend. Only memory is
                                    implemented in this release. (choices:
                                    "memory", default: memory, env:
                                    CLOAK_PLAYWRIGHT_MCP_HTTP_SESSION_BACKEND)
  --http-session-idle-ttl-ms <ms>   Idle TTL for Streamable HTTP sessions.
                                    (default: 3600000, env:
                                    CLOAK_PLAYWRIGHT_MCP_HTTP_SESSION_IDLE_TTL_MS)
  --http-session-max <count>        Maximum active Streamable HTTP sessions in
                                    one process. (default: 32, env:
                                    CLOAK_PLAYWRIGHT_MCP_HTTP_SESSION_MAX)

Commands:
  doctor [options]                  Run local diagnostics without starting the
                                    MCP bridge.

Commands

doctor

Usage: doctor [options]

Run local diagnostics without starting the MCP bridge.

Options:
  --json      Output diagnostics as JSON.
  -h, --help  display help for command

Options

Option Environment Default Values Description
--transport <mode> CLOAK_PLAYWRIGHT_MCP_TRANSPORT stdio stdio, streamable-http MCP transport exposed by the bridge.
--geoip-proxy-match CLOAK_PLAYWRIGHT_MCP_GEOIP_PROXY_MATCH false Match CloakBrowser timezone and locale to the configured proxy GeoIP.
--humanize CLOAK_PLAYWRIGHT_MCP_HUMANIZE false Enable CloakBrowser human-like mouse, keyboard, and scroll behavior.
--human-preset <preset> CLOAK_PLAYWRIGHT_MCP_HUMAN_PRESET default default, careful CloakBrowser human behavior preset. Used only when humanize is enabled.
--http-protocol <protocol> CLOAK_PLAYWRIGHT_MCP_HTTP_PROTOCOL http http, https Streamable HTTP listener protocol.
--http-host <host> CLOAK_PLAYWRIGHT_MCP_HTTP_HOST 127.0.0.1 Streamable HTTP bind host.
--http-port <port> CLOAK_PLAYWRIGHT_MCP_HTTP_PORT 3000 Streamable HTTP bind port. Use 0 for an ephemeral port in tests.
--http-endpoint <path> CLOAK_PLAYWRIGHT_MCP_HTTP_ENDPOINT /mcp Streamable HTTP endpoint path. Reserved probe paths: /healthz, /readyz.
--http-auth-token <token> CLOAK_PLAYWRIGHT_MCP_HTTP_AUTH_TOKEN unset Optional Bearer token required on Streamable HTTP requests.
--https-cert <path> CLOAK_PLAYWRIGHT_MCP_HTTPS_CERT unset TLS certificate PEM file for HTTPS Streamable HTTP.
--https-key <path> CLOAK_PLAYWRIGHT_MCP_HTTPS_KEY unset TLS private key PEM file for HTTPS Streamable HTTP.
--https-pfx <path> CLOAK_PLAYWRIGHT_MCP_HTTPS_PFX unset TLS PFX/PKCS12 file for HTTPS Streamable HTTP.
--https-passphrase <value> CLOAK_PLAYWRIGHT_MCP_HTTPS_PASSPHRASE unset Passphrase for an encrypted HTTPS key or PFX.
--http-session-backend <backend> CLOAK_PLAYWRIGHT_MCP_HTTP_SESSION_BACKEND memory memory Session metadata backend. Only memory is implemented in this release.
--http-session-idle-ttl-ms <ms> CLOAK_PLAYWRIGHT_MCP_HTTP_SESSION_IDLE_TTL_MS 3600000 Idle TTL for Streamable HTTP sessions.
--http-session-max <count> CLOAK_PLAYWRIGHT_MCP_HTTP_SESSION_MAX 32 Maximum active Streamable HTTP sessions in one process.