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)
--release-channel <channel> CloakBrowser binary release channel. (choices: "stable", "preview", default: stable, env: CLOAK_PLAYWRIGHT_MCP_RELEASE_CHANNEL)
--binary-path <path> Use this CloakBrowser executable instead of resolving a cached binary. (env: CLOAKBROWSER_BINARY_PATH)
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)
Managed CDP
--cdp-enabled, --no-cdp-enabled Enable managed CDP for stdio and as the HTTP session default. (env: CLOAK_PLAYWRIGHT_MCP_CDP_ENABLED)
--cdp-port-range <port|start-end> Managed CDP external proxy port or inclusive port range. (env: CLOAK_PLAYWRIGHT_MCP_CDP_PORT_RANGE)
--cdp-host <host> Managed CDP external proxy bind host. (default: 127.0.0.1, env: CLOAK_PLAYWRIGHT_MCP_CDP_HOST)
--cdp-allow-remote, --no-cdp-allow-remote Allow managed CDP to bind to a non-loopback host. (env: CLOAK_PLAYWRIGHT_MCP_CDP_ALLOW_REMOTE)
--cdp-advertised-host <host> Connectable host published in managed CDP discovery URLs. (env: CLOAK_PLAYWRIGHT_MCP_CDP_ADVERTISED_HOST)
--cdp-advertised-scheme <scheme> Published managed CDP discovery scheme; does not enable TLS. (choices: "http", "https", default: http, env: CLOAK_PLAYWRIGHT_MCP_CDP_ADVERTISED_SCHEME)
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. |
--release-channel <channel> | CLOAK_PLAYWRIGHT_MCP_RELEASE_CHANNEL | stable | stable, preview | CloakBrowser binary release channel. |
--binary-path <path> | CLOAKBROWSER_BINARY_PATH | unset | Use this CloakBrowser executable instead of resolving a cached binary. | |
--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. | |
--cdp-enabled, --no-cdp-enabled | CLOAK_PLAYWRIGHT_MCP_CDP_ENABLED | false | Enable managed CDP for stdio and as the HTTP session default. | |
--cdp-port-range <port|start-end> | CLOAK_PLAYWRIGHT_MCP_CDP_PORT_RANGE | unset | Managed CDP external proxy port or inclusive port range. | |
--cdp-host <host> | CLOAK_PLAYWRIGHT_MCP_CDP_HOST | 127.0.0.1 | Managed CDP external proxy bind host. | |
--cdp-allow-remote, --no-cdp-allow-remote | CLOAK_PLAYWRIGHT_MCP_CDP_ALLOW_REMOTE | false | Allow managed CDP to bind to a non-loopback host. | |
--cdp-advertised-host <host> | CLOAK_PLAYWRIGHT_MCP_CDP_ADVERTISED_HOST | unset | Connectable host published in managed CDP discovery URLs. | |
--cdp-advertised-scheme <scheme> | CLOAK_PLAYWRIGHT_MCP_CDP_ADVERTISED_SCHEME | http | http, https | Published managed CDP discovery scheme; does not enable TLS. |