Documentação

Painel, CLI, API e MCP compartilham a mesma camada de serviço. Todos os comandos abaixo existem na versão atual.

Primeiros passos

O aplicativo abre o painel e a API local automaticamente. Em uma instalação pelo código-fonte, inicie o serviço com o comando ao lado.

endereço padrão: 127.0.0.1:8710
copie o token na seção Ajuda
todas as rotas v1 exigem 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" [ ] vazio até você criar um perfil

Criar um perfil

O nome é obrigatório. O NimbusX seleciona o dispositivo e um fingerprint coerente; os parâmetros opcionais podem ser definidos depois.

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", )

Automação

A porta CDP bruta fica fechada. As ações comuns do navegador passam pela API autenticada, impedindo que um processo local qualquer assuma o controle do perfil.

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")

Servidor MCP

O MCP funciona por stdio, encontra o serviço em execução e usa a mesma camada protegida. Não existe um endpoint HTTP separado para MCP.

nimbusx · mcp

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

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

Proxies

Adicione um proxy HTTP, HTTPS, SOCKS5 ou SSH pela URL. A opção --check verifica disponibilidade, localização e latência na hora.

nimbusx · proxy

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

Testes

A bancada abre os detectores selecionados em perfis novos, guarda o resultado completo e marca separadamente os sites que não responderam.

nimbusx · bench

$ python -m app.cli bench run \ --only creepjs,iphey,sannysoft \ --note release-candidate O resumo aparece após o teste real terminar.