Skip to main content

Instalação

Instale globalmente a CLI do Firecrawl com npm:
CLI
Se você estiver usando em algum agente de IA, como o Claude Code, poderá instalar a skill do Firecrawl abaixo, e o agente conseguirá configurá-la para você.
  • --all instala a skill do Firecrawl em todos os agentes de código de IA detectados
  • --browser abre o navegador automaticamente para autenticar o Firecrawl
Depois de instalar a skill, reinicie o Claude Code para que ele reconheça a nova skill.

Autenticação

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

Login

CLI

Visualizar configuração

CLI

Logout

CLI

Auto-hospedado / Desenvolvimento local

Para instâncias auto-hospedadas do Firecrawl ou para desenvolvimento local, use a opção --api-url:
CLI
Ao usar uma URL de API personalizada (qualquer endereço diferente de https://api.firecrawl.dev), 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
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

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

Formatos de saída

CLI

Opções de Scrape

CLI
Opções disponíveis:
Pesquise na web e, opcionalmente, faça o scraping dos resultados.
CLI

Opções de busca

CLI
Opções disponíveis:

Mapear

Descubra rapidamente todas as URLs de um site.
CLI

Opções do Map

CLI
Opções disponíveis:

Crawl

Rastreia um site inteiro a partir de uma URL.
CLI

Verificar status do crawl

CLI

Opções de Crawl

CLI
Opções disponíveis:

Agent

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

Opções do Agente

CLI
Opções disponíveis:

Browser

Inicie sessões de navegador na nuvem e execute código Python, JavaScript ou Bash remotamente. Cada sessão roda uma instância completa do Chromium — sem precisar instalar um navegador local. O código é executado no servidor com um objeto page do Playwright pré-configurado e pronto para uso.
CLI

Opções do navegador

CLI
Subcomandos: Opções de execução: Opções de inicialização: Opções comuns:

Uso de créditos

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

Versão

Exibe a versão da CLI.
CLI

Opções globais

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

Manipulação da saída

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

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

Exemplos

Raspagem rápida

CLI

Rastreamento completo do site

CLI

Descoberta de sites

CLI

Fluxo de Pesquisa

CLI

Agente

CLI

Automação de navegadores

CLI

Combine com outras ferramentas

CLI

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

Open Source

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