CLI | Evocrawl

Faça busca, scraping e interaja com a web diretamente do terminal. A EvoCrawl CLI pode ser usada de forma independente ou como uma Skill que agentes de programação com IA, como Claude Code, Antigravity e OpenCode, podem descobrir e usar automaticamente.

Instalação

Se você estiver usando um agente de IA, como o Claude Code, poderá instalar a Evocrawl Skill abaixo, e o agente a configurará para você.

npx -y evocrawl-cli@latest init --all --browser

--all instala a Evocrawl Skill em todos os agentes de codificação de IA detectados
--browser abre o navegador automaticamente para autenticação do Evocrawl

After installing the skill, restart your agent for it to discover the new skill.

Você também pode instalar manualmente a CLI do Evocrawl globalmente usando npm:

CLI

# Instale globalmente com npm
npm install -g evocrawl-cli

Autenticação

Antes de usar a CLI, você precisa autenticar-se com sua chave de API do Evocrawl.

CLI

# Login interativo (abre o navegador ou solicita a chave da API)
evocrawl login

# Login com autenticação do navegador (recomendado para agentes)
evocrawl login --browser

# Login com chave da API diretamente
evocrawl login --api-key fc-YOUR-API-KEY

# Ou defina via variável de ambiente
export EVOCRAWL_API_KEY=fc-YOUR-API-KEY

Visualizar configuração

CLI

# Ver configuração atual e status de autenticação
evocrawl view-config

Logout

CLI

# Limpar credenciais armazenadas
evocrawl logout

Auto-hospedado / Desenvolvimento local

Para instâncias auto-hospedadas do Evocrawl ou para desenvolvimento local, use a opção --api-url:

CLI

# Use uma instância local do Evocrawl (nenhuma chave de API necessária)
evocrawl --api-url http://localhost:3002 scrape https://example.com

# Or set via environment variable
export EVOCRAWL_API_URL=http://localhost:3002
evocrawl scrape https://example.com

# Configure and persist the custom API URL
evocrawl config --api-url http://localhost:3002

Ao usar uma URL de API personalizada (qualquer endereço diferente de https://api.evocrawl.com), a autenticação por chave de API é automaticamente ignorada, permitindo que você use instâncias locais sem uma chave de API.

Verificar status

Verifique se a instalação e a autenticação estão corretas e consulte os limites de taxa:

CLI

evocrawl --status

Resultado quando estiver pronto:

   evocrawl cli v1.1.1

  ● Authenticated via EVOCRAWL_API_KEY
  Concurrency: 0/100 jobs (parallel scrape limit)
  Credits: 500,000 remaining

Concorrência: Máximo de tarefas em paralelo. Execute operações paralelas próximas a esse limite, mas sem ultrapassá-lo.
Créditos: Créditos de API disponíveis. Cada operação de scrape/crawl consome créditos.

Comandos

Scrape

Faça scraping de uma única URL e extraia seu conteúdo em vários formatos.

Use --only-main-content para obter um resultado limpo, sem navegação, rodapés ou anúncios. Isso é recomendado para a maioria dos casos de uso em que você quer apenas o artigo ou o conteúdo principal da página.

CLI

# Faz scrape de uma URL (padrão: saída em markdown)
evocrawl https://example.com

# Ou use o comando explícito de scrape
evocrawl scrape https://example.com

# Recomendado: use --only-main-content para saída limpa sem navegação/rodapé
evocrawl https://example.com --only-main-content

Formatos de saída

CLI

# Obter saída em HTML
evocrawl https://example.com --html

# Múltiplos formatos (retorna JSON)
evocrawl https://example.com --format markdown,links

# Obter imagens de uma página
evocrawl https://example.com --format images

# Obter um resumo do conteúdo da página
evocrawl https://example.com --format summary

# Rastrear mudanças em uma página
evocrawl https://example.com --format changeTracking

# Formatos disponíveis: markdown, html, rawHtml, links, screenshot, json, images, summary, changeTracking, attributes, branding

Opções de Scrape

CLI

# Extrai apenas o conteúdo principal (remove navegação e rodapés)
evocrawl https://example.com --only-main-content

# Wait for JavaScript rendering
evocrawl https://example.com --wait-for 3000

# Take a screenshot
evocrawl https://example.com --screenshot

# Include/exclude specific HTML tags
evocrawl https://example.com --include-tags article,main
evocrawl https://example.com --exclude-tags nav,footer

# Save output to file
evocrawl https://example.com -o output.md

# Pretty print JSON output
evocrawl https://example.com --format markdown,links --pretty

# Force JSON output even with single format
evocrawl https://example.com --json

# Show request timing information
evocrawl https://example.com --timing

Opções disponíveis:

Opção	Atalho	Descrição
`--url <url>`	`-u`	URL para extrair conteúdo (alternativa ao argumento posicional)
`--format <formats>`	`-f`	formatos de saída (separados por vírgula): `markdown`, `html`, `rawHtml`, `links`, `screenshot`, `json`, `images`, `summary`, `rastreioDeMudanças`, `attributes`, `branding`
`--html`	`-H`	Atalho para `--format html`
`--only-main-content`		Extrair apenas o conteúdo principal
`--wait-for <ms>`		Tempo de espera, em milissegundos, para renderização de JS
`--screenshot`		Fazer uma captura de tela
`--include-tags <tags>`		Tags HTML a incluir (separadas por vírgula)
`--exclude-tags <tags>`		Tags HTML a excluir (separadas por vírgula)
`--output <path>`	`-o`	Salvar o resultado em um arquivo
`--json`		Forçar saída em JSON mesmo com um único formato
`--pretty`		Imprimir a saída JSON formatada
`--timing`		Mostrar tempo da requisição e outras informações úteis

Pesquisar

Pesquise na web e, opcionalmente, faça o scraping dos resultados.

CLI

# Pesquisar na web
evocrawl search "web scraping tutorials"

# Limitar resultados
evocrawl search "AI news" --limit 10

# Imprimir resultados formatados
evocrawl search "machine learning" --pretty

Opções de busca

CLI

# Search specific sources
evocrawl search "AI" --sources web,news,images

# Buscar com filtros de categoria
evocrawl search "react hooks" --categories github
evocrawl search "machine learning" --categories research,pdf

# Time-based filtering
evocrawl search "tech news" --tbs qdr:h   # Last hour
evocrawl search "tech news" --tbs qdr:d   # Last day
evocrawl search "tech news" --tbs qdr:w   # Last week
evocrawl search "tech news" --tbs qdr:m   # Last month
evocrawl search "tech news" --tbs qdr:y   # Last year

# Location-based search
evocrawl search "restaurants" --location "Berlin,Germany" --country DE

# Search and scrape results
evocrawl search "documentation" --scrape --scrape-formats markdown

# Save to file
evocrawl search "evocrawl" --pretty -o results.json

Opções disponíveis:

Opção	Descrição
`--limit <number>`	Número máximo de resultados (padrão: 5, máx.: 100)
`--sources <sources>`	Fontes de pesquisa: `web`, `images`, `news` (separadas por vírgula)
`--categories <categories>`	Filtrar por categoria: `github`, `research`, `pdf` (separadas por vírgula)
`--tbs <value>`	Filtro de tempo: `qdr:h` (hora), `qdr:d` (dia), `qdr:w` (semana), `qdr:m` (mês), `qdr:y` (ano)
`--location <location>`	Segmentação geográfica (ex.: “Berlin,Germany”)
`--country <code>`	Código de país ISO (padrão: US)
`--timeout <ms>`	Tempo limite em milissegundos (padrão: 60000)
`--ignore-invalid-urls`	Excluir URLs inválidas para outros endpoints do Evocrawl
`--scrape`	Fazer scraping dos resultados da pesquisa
`--scrape-formats <formats>`	Formatos para o conteúdo extraído (padrão: markdown)
`--only-main-content`	Incluir apenas o conteúdo principal ao fazer scraping (padrão: true)
`--json`	Saída em JSON
`--output <path>`	Salvar saída em arquivo
`--pretty`	Imprimir saída JSON formatada

Mapear

Descubra rapidamente todas as URLs de um site.

CLI

# Descobre todas as URLs de um site
evocrawl map https://example.com

# Output as JSON
evocrawl map https://example.com --json

# Limit number of URLs
evocrawl map https://example.com --limit 500

Opções do Map

CLI

# Filtrar URLs por consulta de pesquisa
evocrawl map https://example.com --search "blog"

# Incluir subdomínios
evocrawl map https://example.com --include-subdomains

# Controlar uso do sitemap
evocrawl map https://example.com --sitemap include   # Usar sitemap
evocrawl map https://example.com --sitemap skip      # Pular sitemap
evocrawl map https://example.com --sitemap only      # Usar apenas sitemap

# Ignorar parâmetros de consulta (dedupe URLs)
evocrawl map https://example.com --ignore-query-parameters

# Aguardar conclusão do mapeamento com timeout
evocrawl map https://example.com --wait --timeout 60

# Salvar em arquivo
evocrawl map https://example.com -o urls.txt
evocrawl map https://example.com --json --pretty -o urls.json

Opções disponíveis:

Opção	Descrição
`--url <url>`	URL a ser mapeada (alternativa ao argumento posicional)
`--limit <number>`	Número máximo de URLs a serem descobertas
`--search <query>`	Filtra URLs pela consulta de busca
`--sitemap <mode>`	Tratamento de sitemap: `include`, `skip`, `only`
`--include-subdomains`	Inclui subdomínios
`--ignore-query-parameters`	Trata URLs com parâmetros diferentes como iguais
`--wait`	Aguarda o término do mapeamento
`--timeout <seconds>`	Tempo máximo de espera, em segundos
`--json`	Saída em JSON
`--output <path>`	Salva a saída em um arquivo
`--pretty`	Imprime a saída JSON formatada

Navegador

Faça seus agentes interagirem com a web usando um sandbox seguro de navegador. Inicie sessões de navegador na nuvem e execute código Python, JavaScript ou bash remotamente. Cada sessão executa uma instância completa do Chromium — sem necessidade de instalar um navegador local. O código é executado no servidor com um objeto page do Playwright pré-configurado e pronto para uso.

CLI

# Launch a cloud browser session
evocrawl browser launch-session

# Executar comandos agent-browser (padrão - "agent-browser" é prefixado automaticamente)
evocrawl browser execute "open https://example.com"
evocrawl browser execute "snapshot"
evocrawl browser execute "click @e5"
evocrawl browser execute "scrape"

# Execute Playwright Python code
evocrawl browser execute --python 'await page.goto("https://example.com")
print(await page.title())'

# Execute Playwright JavaScript code
evocrawl browser execute --node 'await page.goto("https://example.com"); console.log(await page.title());'

# List all sessions (or: list active / list destroyed)
evocrawl browser list

# Close the active session
evocrawl browser close

Opções do navegador

CLI

# Launch with custom TTL (10 minutes) and live view
evocrawl browser launch-session --ttl 600 --stream

# Launch with inactivity timeout
evocrawl browser launch-session --ttl 120 --ttl-inactivity 60

# comandos agent-browser (padrão - "agent-browser" é prefixado automaticamente)
evocrawl browser execute "open https://news.ycombinator.com"
evocrawl browser execute "snapshot"
evocrawl browser execute "click @e3"
evocrawl browser execute "scrape"

# Playwright Python - navigate, interact, extract
evocrawl browser execute --python '
await page.goto("https://news.ycombinator.com")
items = await page.query_selector_all(".titleline > a")
for item in items[:5]:
    print(await item.text_content())
'

# Playwright JavaScript - same page object
evocrawl browser execute --node '
await page.goto("https://example.com");
const title = await page.title();
console.log(title);
'

# Explicit bash mode - runs in the sandbox
evocrawl browser execute --bash "agent-browser snapshot"

# Target a specific session
evocrawl browser execute --session <id> --python 'print(await page.title())'

# Save output to file
evocrawl browser execute "scrape" -o result.txt

# Close a specific session
evocrawl browser close --session <id>

# List sessions (all / active / destroyed)
evocrawl browser list
evocrawl browser list active --json

Subcomandos:

Subcommand	Description
`launch-session`	Inicia uma nova sessão de navegador na nuvem (retorna o ID da sessão, a URL CDP e a URL de visualização ao vivo)
`execute <code>`	Executa código Playwright Python/JS ou comandos bash em uma sessão
`list [status]`	Lista sessões de navegador (filtra por `active` ou `destroyed`)
`close`	Encerra uma sessão de navegador

Opções de execução:

Option	Description
`--bash`	Executa comandos bash remotamente no sandbox (padrão). O agent-browser (40+ comandos) vem pré-instalado e com prefixo automático. `CDP_URL` é injetado automaticamente para que o agent-browser se conecte à sua sessão automaticamente. Melhor abordagem para agentes de IA.
`--python`	Executa como código Playwright Python. Um objeto `page` do Playwright está disponível — use `await page.goto()`, `await page.title()`, etc.
`--node`	Executa como código Playwright JavaScript. Mesmo objeto `page` disponível.
`--session <id>`	Usa uma sessão específica (padrão: sessão ativa)

Opções de inicialização:

Option	Description
`--ttl <seconds>`	TTL total da sessão (padrão: 600, intervalo: 30–3600)
`--ttl-inactivity <seconds>`	Fecha automaticamente após inatividade (intervalo: 10–3600)
`--profile <name>`	Nome de um perfil (salva e reutiliza o estado do navegador entre sessões)
`--no-save-changes`	Carrega dados de perfil existentes sem salvar as alterações de volta
`--stream`	Habilita streaming de visualização ao vivo

Opções comuns:

Option	Description
`--output <path>`	Salva a saída em arquivo
`--json`	Saída em formato JSON

Crawl

Rastreia um site inteiro a partir de uma URL.

CLI

# Inicia um crawl (retorna o ID do job imediatamente)
evocrawl crawl https://example.com

# Aguarda a conclusão do crawl
evocrawl crawl https://example.com --wait

# Aguarda com indicador de progresso
evocrawl crawl https://example.com --wait --progress

Verificar status do crawl

CLI

# Verificar o status do crawl usando o ID do job
evocrawl crawl <job-id>

# Exemplo com um ID de job real
evocrawl crawl 550e8400-e29b-41d4-a716-446655440000

Opções de Crawl

CLI

# Limit crawl depth and pages
evocrawl crawl https://example.com --limit 100 --max-depth 3 --wait

# Include only specific paths
evocrawl crawl https://example.com --include-paths /blog,/docs --wait

# Exclude specific paths
evocrawl crawl https://example.com --exclude-paths /admin,/login --wait

# Include subdomains
evocrawl crawl https://example.com --allow-subdomains --wait

# Crawl entire domain
evocrawl crawl https://example.com --crawl-entire-domain --wait

# Rate limiting
evocrawl crawl https://example.com --delay 1000 --max-concurrency 2 --wait

# Intervalo de polling e timeout personalizados
evocrawl crawl https://example.com --wait --poll-interval 10 --timeout 300

# Save results to file
evocrawl crawl https://example.com --wait --pretty -o results.json

Opções disponíveis:

Opção	Descrição
`--url <url>`	URL para rastrear (alternativa ao argumento posicional)
`--wait`	Aguardar a conclusão do crawl
`--progress`	Mostrar indicador de progresso enquanto aguarda
`--poll-interval <seconds>`	Intervalo de consulta (polling) (padrão: 5)
`--timeout <seconds>`	Tempo limite ao aguardar
`--status`	Verificar o status de uma tarefa de crawl existente
`--limit <number>`	Número máximo de páginas a rastrear
`--max-depth <number>`	Profundidade máxima do crawl
`--include-paths <paths>`	Caminhos a incluir (separados por vírgula)
`--exclude-paths <paths>`	Caminhos a excluir (separados por vírgula)
`--sitemap <mode>`	Tratamento de sitemap: `include`, `skip`, `only`
`--allow-subdomains`	Incluir subdomínios
`--allow-external-links`	Seguir links externos
`--crawl-entire-domain`	Rastrear o domínio inteiro
`--ignore-query-parameters`	Tratar URLs com parâmetros diferentes como iguais
`--delay <ms>`	Atraso entre requisições
`--max-concurrency <n>`	Máximo de requisições concorrentes
`--output <path>`	Salvar resultado em arquivo
`--pretty`	Imprimir saída JSON formatada

Agent

Busque e colete dados na web usando prompts em linguagem natural.

CLI

# Basic usage - URLs are optional
evocrawl agent "Encontre as 5 principais startups de IA e seus valores de financiamento" --wait

# Focus on specific URLs
evocrawl agent "Compare pricing plans" --urls https://slack.com/pricing,https://teams.microsoft.com/pricing --wait

# Use a schema for structured output
evocrawl agent "Get company information" --urls https://example.com --schema '{"name": "string", "founded": "number"}' --wait

# Use schema from a file
evocrawl agent "Get product details" --urls https://example.com --schema-file schema.json --wait

Opções do Agente

CLI

# Use Spark 1 Pro for higher accuracy
evocrawl agent "Competitive analysis across multiple domains" --model spark-1-pro --wait

# Set max credits to limit costs
evocrawl agent "Gather contact information from company websites" --max-credits 100 --wait

# Check status of an existing job
evocrawl agent <job-id> --status

# Intervalo de polling e timeout personalizados
evocrawl agent "Summarize recent blog posts" --wait --poll-interval 10 --timeout 300

# Save output to file
evocrawl agent "Find pricing information" --urls https://example.com --wait -o pricing.json --pretty

Opções disponíveis:

Option	Description
`--urls <urls>`	Lista opcional de URLs nas quais o agente deve focar (separadas por vírgula)
`--model <model>`	Modelo a ser usado: `spark-1-mini` (padrão, 60% mais barato) ou `spark-1-pro` (maior precisão)
`--schema <json>`	Esquema JSON para saída estruturada (string JSON inline)
`--schema-file <path>`	Caminho para o arquivo de esquema JSON para saída estruturada
`--max-credits <number>`	Máximo de créditos a consumir (a tarefa falha se o limite for atingido)
`--status`	Verificar o status de uma tarefa de agente existente
`--wait`	Aguardar o agente concluir antes de retornar os resultados
`--poll-interval <seconds>`	Intervalo de polling enquanto aguarda (padrão: 5)
`--timeout <seconds>`	Tempo limite (timeout) enquanto aguarda (padrão: sem limite)
`--output <path>`	Salvar a saída em arquivo
`--json`	Saída em formato JSON

Uso de créditos

Verifique o saldo de créditos e o uso pela sua equipe.

CLI

# Ver uso de créditos
evocrawl credit-usage

# Saída em JSON
evocrawl credit-usage --json --pretty

Versão

Exibe a versão da CLI.

CLI

evocrawl version
# ou
evocrawl --version

Opções globais

Essas opções estão disponíveis para todos os comandos:

Opção	Atalho	Descrição
`--status`		Exibe a versão, autenticação, concorrência e créditos
`--api-key <key>`	`-k`	Substitui a chave de API armazenada para este comando
`--api-url <url>`		Usa uma URL de API personalizada (para self-hosting/desenvolvimento local)
`--help`	`-h`	Exibe a ajuda de um comando
`--version`	`-V`	Exibe a versão da CLI

Manipulação da saída

A CLI envia a saída para stdout por padrão, facilitando o uso de pipes ou redirecionamentos:

CLI

# Pipe markdown para outro comando
evocrawl https://example.com | head -50

# Redirecionar para um arquivo
evocrawl https://example.com > output.md

# Salvar JSON com formatação legível
evocrawl https://example.com --format markdown,links --pretty -o data.json

Comportamento dos formatos

Formato único: Retorna o conteúdo bruto (texto markdown, HTML, etc.)
Múltiplos formatos: Retorna um JSON com todos os dados solicitados

CLI

# Raw markdown output
evocrawl https://example.com --format markdown

# Saída JSON com múltiplos formatos
evocrawl https://example.com --format markdown,links

Exemplos

Raspagem rápida

CLI

# Obter conteúdo markdown de uma URL (use --only-main-content para saída limpa)
evocrawl https://docs.evocrawl.com --only-main-content

# Get HTML content
evocrawl https://example.com --html -o page.html

Rastreamento completo do site

CLI

# Rastreia um site de docs com limites
evocrawl crawl https://docs.example.com --limit 50 --max-depth 2 --wait --progress -o docs.json

Descoberta de sites

CLI

# Encontre todas as postagens do blog
evocrawl map https://example.com --search "blog" -o blog-urls.txt

Fluxo de Pesquisa

CLI

# Buscar e raspar resultados para pesquisa
evocrawl search "machine learning best practices 2024" --scrape --scrape-formats markdown --pretty

Agente

CLI

# URLs are optional
evocrawl agent "Encontre as 5 principais startups de IA e seus valores de financiamento" --wait

# Focus on specific URLs
evocrawl agent "Compare pricing plans" --urls https://slack.com/pricing,https://teams.microsoft.com/pricing --wait

Automação de navegadores

CLI

# Launch a session, scrape a page, and close
evocrawl browser launch-session
evocrawl browser execute "open https://news.ycombinator.com"
evocrawl browser execute "snapshot"
evocrawl browser execute "scrape"
evocrawl browser close

# Usa agent-browser via modo bash (padrão — recomendado para agentes de IA)
evocrawl browser launch-session
evocrawl browser execute "open https://example.com"
evocrawl browser execute "snapshot"
# snapshot returns @ref IDs — use them to interact
evocrawl browser execute "click @e5"
evocrawl browser execute "fill @e3 'search query'"
evocrawl browser execute "scrape"
# Run --help to see all 40+ commands
evocrawl browser execute --bash "agent-browser --help"
evocrawl browser close

Combine com outras ferramentas

CLI

# Extrair URLs dos resultados de pesquisa
jq -r '.data.web[].url' search-results.json

# Get titles from search results
jq -r '.data.web[] | "\(.title): \(.url)"' search-results.json

# Extract links and process with jq
evocrawl https://example.com --format links | jq '.links[].url'

# Count URLs from map
evocrawl map https://example.com | wc -l

Telemetria

A CLI coleta dados de uso anônimos durante a autenticação para ajudar a melhorar o produto:

Versão da CLI, sistema operacional e versão do Node.js
Detecção de ferramenta de desenvolvimento (como Cursor, VS Code, Claude Code)

Nenhum dado relacionado a comandos, URLs ou conteúdo de arquivos é coletado via CLI. Para desativar a telemetria, defina a seguinte variável de ambiente:

CLI

export EVOCRAWL_NO_TELEMETRY=1

Open Source

A CLI e a Skill do Evocrawl são de código aberto e estão disponíveis no GitHub: evocrawl/cli

Você é um agente de IA que precisa de uma chave de API do Evocrawl? Consulte evocrawl.dev/agent-onboarding/SKILL.md para ver instruções de integração automatizada.

​Instalação

​Autenticação

​Login

​Visualizar configuração

​Logout

​Auto-hospedado / Desenvolvimento local

​Verificar status

​Comandos

​Scrape

​Formatos de saída

​Opções de Scrape

​Pesquisar

​Opções de busca

​Mapear

​Opções do Map

​Navegador

​Opções do navegador

​Crawl

​Verificar status do crawl

​Opções de Crawl

​Agent

​Opções do Agente

​Uso de créditos

​Versão

​Opções globais

​Manipulação da saída

​Comportamento dos formatos

​Exemplos

​Raspagem rápida

​Rastreamento completo do site

​Descoberta de sites

​Fluxo de Pesquisa

​Agente

​Automação de navegadores

​Combine com outras ferramentas

​Telemetria

​Open Source

Instalação

Autenticação

Login

Visualizar configuração

Logout

Auto-hospedado / Desenvolvimento local

Verificar status

Comandos

Scrape

Formatos de saída

Opções de Scrape

Pesquisar

Opções de busca

Mapear

Opções do Map

Navegador

Opções do navegador

Crawl

Verificar status do crawl

Opções de Crawl

Agent

Opções do Agente

Uso de créditos

Versão

Opções globais

Manipulação da saída

Comportamento dos formatos

Exemplos

Raspagem rápida

Rastreamento completo do site

Descoberta de sites

Fluxo de Pesquisa

Agente

Automação de navegadores

Combine com outras ferramentas

Telemetria

Open Source