Skip to main content

CLI

Les skills Firecrawl permettent simplement aux agents IA comme Codex, Claude Code, Cursor et OpenCode d’utiliser Firecrawl via la CLI.
12 min read

Recherchez, scrapez, interagissez, lancez des crawls, cartographiez et exécutez des tâches d’agent directement depuis le terminal. Le CLI Firecrawl fonctionne seul ou avec des skills que des agents IA de codage comme Codex, Claude Code, Cursor et OpenCode peuvent découvrir et utiliser automatiquement.

Installation#

Si vous utilisez un agent IA comme Codex, Claude Code, Cursor ou OpenCode, vous pouvez installer les skills Firecrawl ci-dessous et l’agent les configurera pour vous.

  • --all ignore la sélection d’agent et initialise tous les agents détectés
  • --browser ouvre automatiquement le navigateur pour l’authentification Firecrawl
Note

Après avoir installé les skills, redémarrez votre agent pour qu’il les détecte.

Vous pouvez également installer manuellement la CLI Firecrawl au niveau global avec npm :

CLI

Authentification#

Avant d’utiliser la CLI, vous devez vous authentifier avec votre clé API Firecrawl.

Note

Certaines commandes CLI fonctionnent sans vous connecter. Si aucune clé API n’est configurée, les commandes prises en charge utilisent le niveau gratuit sans clé — gratuit, mais limité par IP. Voir Limites de débit pour la liste actuelle des commandes sans clé et les points à connaître. Inscrivez-vous pour obtenir une clé gratuite et bénéficier de 1 000 crédits ainsi que de limites plus élevées ; la CLI l’utilise automatiquement une fois configurée.

Connexion#

CLI

Afficher la configuration#

CLI

Déconnexion#

CLI

Connecter la CLI à Firecrawl auto-hébergé#

Commencez par réussir un scrape en suivant le guide d’auto-hébergement. Pointez ensuite la CLI vers cette API avec --api-url ou FIRECRAWL_API_URL :

CLI

Lorsque vous utilisez une URL d’API personnalisée au lieu de https://api.firecrawl.dev, la CLI ignore l’authentification par clé API de Firecrawl Cloud. Cela correspond au démarrage rapide sur réseau de confiance, où USE_DB_AUTHENTICATION=false.

Warning

Conservez une API non authentifiée sur un réseau de confiance. Si vous ajoutez un proxy d’authentification ou une autre couche de contrôle d’accès, vérifiez que la CLI peut envoyer les identifiants requis par cette couche avant de vous appuyer sur cette méthode.

La CLI ne peut appeler que les fonctionnalités activées dans votre déploiement. Consultez la prise en charge des fonctionnalités auto-hébergées avant d’utiliser des commandes réservées au Cloud ou dépendantes d’un fournisseur.

Vérifier l'état#

Vérifiez l'installation, l'authentification et affichez les limites de débit :

CLI

Sortie une fois prête :

  • Concurrence : Nombre maximal de tâches en parallèle. Exécutez des opérations parallèles au plus près de cette limite, sans la dépasser.
  • Crédits : Crédits API restants. Chaque opération de scrape/crawl consomme des crédits.

Commandes#

Note

La commande masquée firecrawl browser est dépréciée pour les workflows d’agents. Utilisez d’abord firecrawl scrape <url>, puis firecrawl interact ... avec la session de scrape ainsi obtenue.

Scrape#

Analysez une seule URL et extrayez son contenu dans différents formats.

Tip

Utilisez --only-main-content pour obtenir un résultat propre sans navigation, pied de page ni publicités. C'est recommandé pour la plupart des cas d'usage où vous souhaitez uniquement l'article ou le contenu principal de la page.

CLI

Formats de sortie#

CLI

Options de Scrape#

CLI

Options disponibles :

OptionForme courteDescription
--url <url>-uURL à Scrape (alternative à l'argument positionnel)
--format <formats>-fformats de sortie (séparés par des virgules) : markdown, html, rawHtml, links, screenshot, json, images, summary, suiviDesModifications, attributes, branding
--html-HRaccourci pour --format html
--only-main-contentExtraire uniquement le contenu principal
--wait-for <ms>Temps d'attente en millisecondes pour le rendu JS
--screenshotPrendre une capture d'écran
--full-page-screenshotPrendre une capture d'écran de la page entière
--include-tags <tags>Balises HTML à inclure (séparées par des virgules)
--exclude-tags <tags>Balises HTML à exclure (séparées par des virgules)
--schema <json>Schéma JSON pour l'extraction structurée
--schema-file <path>Chemin du fichier de schéma JSON
--actions <json>Tableau JSON des actions à exécuter pendant le Scrape
--actions-file <path>Chemin du fichier JSON des actions
--proxy <proxy>Mode proxy pour le Scrape (par exemple, auto ou basic)
--redact-piiMasquer les informations personnellement identifiables dans le contenu renvoyé
--output <path>-oEnregistrer la sortie dans un fichier
--jsonForcer la sortie JSON même avec un seul format
--prettyAfficher la sortie JSON de manière lisible
--timingAfficher le temps de la requête et d'autres informations utiles

Recherchez sur le Web et, si besoin, extrayez le contenu des résultats.

CLI

Options de recherche#

CLI

Options disponibles :

OptionDescription
--limit <number>Nombre maximal de résultats (par défaut : 5, max : 100)
--sources <sources>Sources à interroger : web, images, news (séparées par des virgules)
--categories <categories>Filtrer par catégorie : research, pdf, developer (séparées par des virgules)
--tbs <value>Filtre temporel : qdr:h (heure), qdr:d (jour), qdr:w (semaine), qdr:m (mois), qdr:y (année)
--location <location>Ciblage géographique (p. ex. "Berlin,Germany")
--country <code>Code de pays ISO (par défaut : US)
--timeout <ms>Délai d'expiration en millisecondes (par défaut : 60000)
--ignore-invalid-urlsExclure les URL invalides pour d'autres endpoints Firecrawl
--scrapeScraper les résultats de recherche
--scrape-formats <formats>Formats pour le contenu extrait (par défaut : markdown)
--only-main-contentInclure uniquement le contenu principal lors du scraping (par défaut : true)
--jsonRésultat au format JSON
--output <path>Enregistrer le résultat dans un fichier
--prettyAffichage JSON formaté

Développeur#

Effectuez des recherches dans le Developer Index — tickets, pull requests fusionnées et fichiers README issus de dépôts de code publics, ainsi que sites de documentation sélectionnés.

CLI

Options disponibles :

OptionDescription
--limit <number>Nombre de résultats à renvoyer (par défaut : 10, max. : 100)
--skills-onlyRechercher uniquement les fichiers de compétences d’agent indexés (par défaut : false)
--jsonAfficher au format JSON compact
--output <path>Enregistrer la sortie dans un fichier
--prettyFormater la sortie JSON pour une meilleure lisibilité

Map#

Découvrez rapidement toutes les URL d’un site.

CLI

Options de la commande Map#

CLI

Options disponibles :

OptionDescription
--url <url>URL à cartographier (alternative à l’argument positionnel)
--limit <number>Nombre maximal d’URL à découvrir
--search <query>Filtrer les URL selon une requête de recherche
--sitemap <mode>Gestion du sitemap : include, skip, only
--include-subdomainsInclure les sous-domaines
--ignore-query-parametersConsidérer les URL avec des paramètres différents comme identiques
--waitAttendre la fin de l’opération de cartographie
--timeout <seconds>Délai d’expiration en secondes
--jsonRésultat au format JSON
--output <path>Enregistrer le résultat dans un fichier
--prettyAffichage JSON mis en forme

Interact#

Scrapez une page, puis interagissez avec elle en langage naturel ou à l’aide de code. Interact utilise par défaut le dernier scrape, ou vous pouvez fournir un ID de scrape spécifique.

CLI

Options disponibles :

OptionDescription
-p, --prompt <text>Prompt IA (alternative à l’argument positionnel)
-c, --code <code>Code à exécuter dans la session active de la page
-s, --scrape-id <id>ID de tâche de scraping (par défaut : dernier scrape)
--pythonExécuter le code en Python/Playwright
--nodeExécuter le code en Node.js/Playwright (par défaut)
--bashExécuter le code en Bash
--timeout <seconds>Délai d’attente en secondes (1-300, par défaut : 30)
--output <path>Enregistrer la sortie dans un fichier
--jsonSortie au format JSON

Crawl#

Lancer un crawl sur l'ensemble d'un site web à partir d'une URL.

CLI

Consulter l'état du crawl#

CLI

Options de crawl#

CLI

Options disponibles :

OptionDescription
--url <url>URL à explorer (alternative à l’argument positionnel)
--waitAttendre la fin du crawl
--progressAfficher un indicateur de progression pendant l’attente
--poll-interval <seconds>Intervalle d’interrogation (par défaut : 5)
--timeout <seconds>Délai d’expiration de l’attente
--statusVérifier l’état d’une tâche de crawl existante
--limit <number>Nombre maximal de pages à explorer
--max-depth <number>Profondeur maximale du crawl
--include-paths <paths>Chemins à inclure (séparés par des virgules)
--exclude-paths <paths>Chemins à exclure (séparés par des virgules)
--sitemap <mode>Gestion du sitemap : include, skip, only
--allow-subdomainsInclure les sous-domaines
--allow-external-linksSuivre les liens externes
--crawl-entire-domainExplorer l’ensemble du domaine
--ignore-query-parametersConsidérer les URL avec des paramètres différents comme identiques
--delay <ms>Délai entre les requêtes
--max-concurrency <n>Nombre maximal de requêtes simultanées
--scrape-options <json>Options de scrape au format JSON transmises à chaque page
--scrape-options-file <path>Chemin vers le fichier JSON des options de scrape
--webhook <url-or-json>URL ou configuration du Webhook
--cancelAnnuler une tâche de crawl active à l’aide de son ID de tâche
--output <path>Enregistrer le résultat dans un fichier
--prettyAfficher la sortie JSON formatée

Monitor#

Créez des scrapes ou crawls récurrents qui comparent chaque exécution à l’instantané précédent. Ajoutez un objectif lorsque vous voulez que Firecrawl évalue quelles pages modifiées sont pertinentes pour votre cas d’usage.

CLI

Les objectifs du monitor doivent rester courts et fidèles à l’intention de l’utilisateur : indiquez ce qui doit déclencher une alerte, reformulez toute portée précisée et n’incluez des exclusions que lorsqu’elles sont évidentes ou explicitement demandées. Si l’utilisateur demande "tout changement", gardez l’objectif large.

Options disponibles :

OptionDescription
--name <name>Nom du monitor
--goal <goal>Objectif pour évaluer les changements significatifs
--cron <expression>Planification cron, par exemple */30 * * * *
--schedule <text>Planification en langage naturel, par exemple hourly
--timezone <tz>Fuseau horaire de la planification, UTC par défaut
--page <url>URL d’une seule page à scraper à chaque vérification
--scrape-urls <list>URL de pages à scraper à chaque vérification, séparées par des virgules
--crawl-url <url>URL racine de la cible de crawl
--webhook-url <url>Destination du Webhook
--webhook-events <list>Événements du monitor séparés par des virgules
--email <list>Destinataires e-mail séparés par des virgules
--retention-days <n>Durée de conservation des instantanés
--page-status <state>Filtrer les pages dans monitor check
--state <state>Définir l’état du monitor dans monitor update : active/paused

Agent#

Recherchez et collectez des données sur le web à l'aide de prompts en langage naturel.

CLI

Options de l'agent#

CLI

Options disponibles :

OptionDescription
--urls <urls>Liste facultative d’URL sur lesquelles concentrer l’agent (séparées par des virgules)
--model <model>Modèle à utiliser. Utilise par défaut spark-2, le modèle utilisé pour chaque exécution. Les modèles Spark 1 sont obsolètes et sont redirigés vers spark-2
--schema <json>Schéma JSON pour la sortie structurée (chaîne JSON intégrée)
--schema-file <path>Chemin vers le fichier de schéma JSON pour la sortie structurée
--max-credits <number>Nombre maximal de crédits à utiliser (la tâche échoue si la limite est atteinte)
--webhook <url-or-json>URL ou configuration du webhook
--statusConsulter l’état d’une tâche d’agent existante
--cancelAnnuler une tâche d’agent active à l’aide de l’ID de tâche
--waitAttendre que l’agent ait terminé avant de renvoyer les résultats
--poll-interval <seconds>Intervalle d’interrogation pendant l’attente (par défaut : 5)
--timeout <seconds>Délai d’attente maximal (par défaut : aucun délai)
--output <path>Enregistrer la sortie dans un fichier
--jsonSortie au format JSON

Utilisation des crédits#

Consultez le solde et l'utilisation des crédits de votre équipe.

CLI

Version#

Afficher la version de la CLI.

CLI

Options globales#

Ces options sont disponibles pour toutes les commandes :

OptionRaccourciDescription
--statusAfficher la version, l’état d’authentification, le niveau de concurrence et les crédits
--api-key <key>-kIgnorer la clé d’API enregistrée pour cette commande
--api-url <url>Utiliser une URL d’API personnalisée (pour l’auto-hébergement ou le développement local)
--help-hAfficher l’aide pour une commande
--version-VAfficher la version de la CLI

init accepte également --skip-auth, --skip-install, --skip-skills et --agent <name>. Voir firecrawl init --help.

Gestion de la sortie#

La CLI écrit sur stdout par défaut, ce qui facilite l’utilisation de pipes ou la redirection :

CLI

Comportement des formats#

  • Un seul format : renvoie le contenu brut (texte markdown, HTML, etc.)
  • Plusieurs formats : renvoie du JSON avec toutes les données demandées
CLI

Exemples#

Scraping rapide#

CLI

Exploration complète du site#

CLI

Découverte de sites web#

CLI

Flux de recherche#

CLI

Agent#

CLI

Combiner avec d'autres outils#

CLI

Télémétrie#

La CLI collecte des données d’utilisation anonymes lors de l’authentification afin d’améliorer le produit :

  • Version de la CLI, système d’exploitation et version de Node.js
  • Détection de l’outil de développement (par exemple, Cursor, VS Code, Claude Code)

Aucune donnée relative aux commandes, aux URL ou au contenu des fichiers n’est collectée via la CLI.

Pour désactiver la télémétrie, définissez la variable d’environnement :

CLI

Open Source#

La CLI Firecrawl et les trois catégories de skills sont open source sur GitHub :

  • firecrawl/cli — la CLI et les skills CLI (travail sur le web en direct)
  • firecrawl/skills — les skills Build (intégrer Firecrawl dans le code d’application)
  • firecrawl/firecrawl-workflows — les skills workflow (livrables reproductibles comme des synthèses de recherche, des audits SEO, des listes de prospects et des clones de design)

Êtes-vous un agent IA qui a besoin d’une clé API Firecrawl ? Consultez firecrawl.dev/agent-onboarding/SKILL.md pour obtenir les instructions d’onboarding automatisé.