Documentation

The dashboard, CLI, API and MCP share one service layer. Every command below exists in the current build.

Quick start

The app opens the dashboard and local API automatically. For a source install, start the service with the command shown here.

default address: 127.0.0.1:8710
copy the token from Help
every v1 route requires a token

nimbusx · start

$ python -m app.cli serve --port 8710 ✓ http://127.0.0.1:8710 $ python -m app.cli token

$ curl http://127.0.0.1:8710/api/v1/profiles \ -H "X-Antidetect-Token: $TOKEN" [ ] empty until you create a profile

Creating a Profile

A name is required. NimbusX selects the device and coherent fingerprint; optional settings can be added later.

nimbusx · profiles

$ curl -X POST http://127.0.0.1:8710/api/v1/profiles \ -H "X-Antidetect-Token: $TOKEN" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: market-01" \ -d '{"name":"market-01"}'

from app.client import Client api = Client() profile = api.create_profile( "market-01", idempotency_key="market-01", )

Automation

The raw CDP port stays closed. Common browser actions use the authenticated API, so an arbitrary local process cannot take full control of a profile.

nimbusx · automation

api.launch("market-01") api.goto("market-01", "https://iphey.com") title = api.evaluate( "market-01", "() => document.title" ) api.screenshot("market-01", "check.png") api.stop("market-01")

MCP-server

MCP runs over stdio, discovers the active service and uses the same protected layer. There is no separate HTTP endpoint for MCP.

nimbusx · mcp

{ "mcpServers": { "nimbusx": { "command": "C:\\Program Files\\NimbusX\\NimbusX.exe", "args": ["mcp"] } } }

{ "mcpServers": { "nimbusx": { "command": "python", "args": ["-m", "app.mcp"] } } }

Proxies

Add an HTTP, HTTPS, SOCKS5 or SSH proxy by URL. The flag --check checks availability, location and latency immediately.

nimbusx · proxy

$ python -m app.cli proxy add \ --url socks5://user:pass@host:1080 \ --label berlin-01 --check

Test runs

The test bench opens the selected detectors in fresh profiles, stores the complete result and marks sites that did not respond separately.

nimbusx · bench

$ python -m app.cli bench run \ --only creepjs,iphey,sannysoft \ --note release-candidate The summary is printed after the live run finishes.