Pesquise, faça scraping, interaja, rastreie, mapeie e execute jobs de agente diretamente do terminal. A CLI do Firecrawl funciona de forma independente ou com skills que agentes de codificação de IA, como Codex, Claude Code, Cursor e OpenCode, podem descobrir e usar automaticamente.
Instalação#
Se você estiver usando um agente de IA, como o Codex, Claude Code, Cursor ou OpenCode, poderá instalar as skills do Firecrawl abaixo, e o agente as configurará para você.
--allpula a seleção de agentes e inicializa todos os agentes detectados--browserabre o navegador automaticamente para autenticação do Firecrawl
Após instalar as skills, reinicie seu agente para que ele as descubra.
Você também pode instalar manualmente a CLI do Firecrawl globalmente usando npm:
Autenticação#
Antes de usar a CLI, você precisa se autenticar com sua chave de API do Firecrawl.
Alguns comandos da CLI funcionam sem login. Sem uma chave de API configurada, os comandos compatíveis recorrem ao plano gratuito sem chave — grátis, mas com limite de taxa por IP. Consulte Limites de taxa para ver a lista atual de comandos sem chave e as ressalvas. Cadastre-se para obter uma chave gratuita e ganhar 1.000 créditos e limites mais altos; a CLI a usa automaticamente assim que ela é configurada.
Login#
Visualizar configuração#
Logout#
Conecte a CLI ao Firecrawl auto-hospedado#
Primeiro, faça um scraping funcionar seguindo o guia de auto-hospedagem. Em seguida, aponte a CLI para essa API usando --api-url ou FIRECRAWL_API_URL:
Ao usar uma URL de API personalizada em vez de https://api.firecrawl.dev, a CLI ignora a autenticação por chave de API do Firecrawl Cloud. Isso corresponde ao guia de início rápido para redes confiáveis, em que USE_DB_AUTHENTICATION=false.
Mantenha uma API sem autenticação em uma rede confiável. Se você adicionar um proxy de autenticação ou outra camada de controle de acesso, verifique se a CLI consegue enviar as credenciais exigidas por essa camada antes de depender dessa abordagem.
A CLI só pode chamar os recursos habilitados na sua implantação. Consulte o suporte a recursos auto-hospedados antes de usar comandos exclusivos da Cloud ou dependentes de provedor.
Verificar status#
Verifique se a instalação e a autenticação estão corretas e consulte os limites de taxa:
Resultado quando estiver pronto:
- 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#
O comando oculto firecrawl browser foi descontinuado para fluxos de trabalho com agentes. Use primeiro firecrawl scrape <url> e depois firecrawl interact ... com a sessão de scraping resultante.
Scraping#
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.
Formatos de saída#
Opções de scraping#
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 | |
--full-page-screenshot | Fazer uma captura de tela da página inteira | |
--include-tags <tags> | Tags HTML a incluir (separadas por vírgula) | |
--exclude-tags <tags> | Tags HTML a excluir (separadas por vírgula) | |
--schema <json> | schema JSON para extração estruturada | |
--schema-file <path> | Caminho para o arquivo de schema JSON | |
--actions <json> | Array JSON de ações a serem executadas durante o scraping | |
--actions-file <path> | Caminho para o arquivo JSON de ações | |
--proxy <proxy> | Modo de proxy para scraping (por exemplo, auto ou basic) | |
--redact-pii | Ocultar informações de identificação pessoal do conteúdo retornado | |
--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.
Opções de busca#
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: research, pdf, developer (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 Firecrawl |
--scrape | Fazer scraping dos resultados de busca |
--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 | Resultado em JSON |
--output <path> | Salvar resultado em arquivo |
--pretty | Imprimir resultado JSON formatado |
Desenvolvedor#
Pesquise no Índice para desenvolvedores — issues, pull requests integrados e READMEs de repositórios públicos de código, além de sites de documentação selecionados.
Opções disponíveis:
| Opção | Descrição |
|---|---|
--limit <number> | Número de resultados a retornar (padrão: 10, máx.: 100) |
--skills-only | Buscar apenas arquivos de skill de agente indexados (padrão: falso) |
--json | Exibir como JSON compacto |
--output <path> | Salvar o resultado em um arquivo |
--pretty | Formatar o resultado JSON para facilitar a leitura |
Mapear#
Descubra rapidamente todas as URLs de um site.
Opções para mapear#
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 limite, em segundos |
--json | Saída em JSON |
--output <path> | Salva a saída em um arquivo |
--pretty | Imprime a saída JSON formatada |
Interact#
Faça scraping de uma página e, em seguida, interaja com ela usando linguagem natural ou código. O Interact usa o scraping mais recente por padrão, ou você pode informar um ID de scraping específico.
Opções disponíveis:
| Option | Description |
|---|---|
-p, --prompt <text> | Prompt de IA (alternativa ao argumento posicional) |
-c, --code <code> | Código para executar na sessão ativa da página |
-s, --scrape-id <id> | ID do job de scraping (padrão: último scraping) |
--python | Executar código como Python/Playwright |
--node | Executar código como Node.js/Playwright (padrão) |
--bash | Executar código como Bash |
--timeout <seconds> | Tempo limite em segundos (1–300, padrão: 30) |
--output <path> | Salvar o resultado em um arquivo |
--json | Resultado em formato JSON |
Crawl#
Rastreia um site inteiro a partir de uma URL.
Verificar status do crawl#
Opções de Crawl#
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 |
--scrape-options <json> | Opções de scraping em JSON passadas para cada página |
--scrape-options-file <path> | Caminho para o arquivo JSON de opções de scraping |
--webhook <url-or-json> | URL ou configuração de Webhook |
--cancel | Cancelar uma tarefa de crawl ativa pelo ID do job |
--output <path> | Salvar resultado em arquivo |
--pretty | Imprimir saída JSON formatada |
Monitor#
Crie operações recorrentes de scraping ou rastreamento que comparem cada execução ao snapshot anterior. Adicione um objetivo quando quiser que o Firecrawl avalie quais páginas alteradas são relevantes para o seu caso de uso.
Os objetivos do monitor devem ser curtos e fiéis à intenção do usuário: diga o que deve acionar um alerta, retome qualquer escopo informado e inclua exclusões apenas quando forem óbvias ou explicitamente solicitadas. Se o usuário pedir "any change", mantenha o objetivo amplo.
Opções disponíveis:
| Opção | Descrição |
|---|---|
--name <name> | Nome do monitor |
--goal <goal> | Objetivo para avaliar mudanças relevantes |
--cron <expression> | Agendamento cron, por exemplo */30 * * * * |
--schedule <text> | Agendamento em linguagem natural, por exemplo hourly |
--timezone <tz> | Fuso horário do agendamento, padrão UTC |
--page <url> | URL de uma única página para fazer scraping a cada verificação |
--scrape-urls <list> | URLs de páginas separadas por vírgula para fazer scraping a cada verificação |
--crawl-url <url> | URL raiz de um alvo de rastreamento |
--webhook-url <url> | Destino do Webhook |
--webhook-events <list> | Eventos do monitor separados por vírgula |
--email <list> | Destinatários de email separados por vírgula |
--retention-days <n> | Janela de retenção de snapshots |
--page-status <state> | Filtrar páginas em monitor check |
--state <state> | Definir o estado do monitor em monitor update: active/paused |
Agent#
Busque e colete dados na web usando prompts em linguagem natural.
Opções do agente#
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. O padrão é spark-2, o modelo usado em todas as execuções. Os modelos Spark 1 estão descontinuados e são direcionados para spark-2 |
--schema <json> | schema JSON para saída estruturada (string JSON inline) |
--schema-file <path> | Caminho para o arquivo de schema JSON para saída estruturada |
--max-credits <number> | Máximo de créditos a consumir (a tarefa falha se o limite for atingido) |
--webhook <url-or-json> | URL do Webhook ou configuração |
--status | Verificar o status de um job de agente existente |
--cancel | Cancelar um job de agente ativo pelo ID do job |
--wait | Aguardar o agente concluir antes de retornar os resultados |
--poll-interval <seconds> | Intervalo de consulta enquanto aguarda (padrão: 5) |
--timeout <seconds> | Tempo limite (timeout) enquanto aguarda (padrão: sem limite) |
--output <path> | Salvar o resultado em arquivo |
--json | Resultado em formato JSON |
Uso de créditos#
Verifique o saldo de créditos e o uso pela sua equipe.
Versão#
Exibe a versão da CLI.
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 auto-hospedado/desenvolvimento local) | |
--help | -h | Exibe a ajuda de um comando |
--version | -V | Exibe a versão da CLI |
O init também aceita --skip-auth, --skip-install, --skip-skills e --agent <name>. Consulte firecrawl init --help.
Manipulação da saída#
A CLI envia a saída para stdout por padrão, facilitando o uso de pipes ou redirecionamentos:
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
Exemplos#
Raspagem rápida#
Rastreamento completo do site#
Descoberta de sites#
Fluxo de Pesquisa#
Agente#
Combine com outras ferramentas#
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:
Open Source#
A CLI do Firecrawl e os três segmentos de skills são de código aberto no GitHub:
firecrawl/cli— a CLI e as skills de CLI (trabalho na web em tempo real)firecrawl/skills— build skills (integre o Firecrawl ao código da aplicação)firecrawl/firecrawl-workflows— skills de fluxo de trabalho (entregáveis repetíveis, como briefs de pesquisa, auditorias de SEO, listas de leads e clones de design)
Você é um agente de IA que precisa de uma chave de API do Firecrawl? Consulte firecrawl.dev/agent-onboarding/SKILL.md para ver instruções de integração automatizada.

