Skip to content

docs(ai-onboarding, cli): update AI agent support and installation in… #937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
erikengervall wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(ai-onboarding, cli): update AI agent support and installation in… #937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ai-onboarding.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ og:description: "Everything you need to onboard your AI agent to Firecrawl. Skil
sidebarTitle: "Build with AI"
---

If you're developing with AI, Firecrawl offers several resources to improve your experience. Firecrawl ships with **skills** — self-contained knowledge packs that AI coding agents discover and use automatically. One install command gives agents CLI tools for live web work and build skills for integrating Firecrawl into application code. Agents like Claude Code, Cursor, Antigravity, and OpenCode can self-onboard with a single command — no human setup required after the API key exists.
If you're developing with AI, Firecrawl offers several resources to improve your experience. Firecrawl ships with **skills** — self-contained knowledge packs that AI coding agents discover and use automatically. One install command gives agents CLI tools for live web work and build skills for integrating Firecrawl into application code. Agents like Claude Code, Cursor, Antigravity, OpenCode, and OpenAI Codex can self-onboard after the API key exists — for Codex, use the [Firecrawl Codex plugin](https://github.com/firecrawl/firecrawl-codex-plugin) or [Codex MCP](/quickstarts/codex-cli) as in [Skills + CLI](/sdks/cli#installation); for other harnesses, use the `npx` install below.

- [Prerequisite: Create an API Key](#prerequisite-create-an-api-key)
- [Skills + CLI](#skills-cli)
Expand Down Expand Up @@ -34,7 +34,7 @@ Currently, we require a human to create a Firecrawl account. Once you have an ac

The [Firecrawl CLI](/sdks/cli) lets your agent search, scrape, interact, crawl, map, extract, and run agent jobs from the terminal. It's built for humans, AI agents, and CI/CD pipelines.

The Firecrawl **skills** are self-contained knowledge packs that AI coding agents like Claude Code, Antigravity, and OpenCode discover and use automatically. A single install command sets up everything — the CLI tools for live web work and the build skills for integrating Firecrawl into application code:
The Firecrawl **skills** are self-contained knowledge packs that AI coding agents like Claude Code, Antigravity, OpenCode, and OpenAI Codex discover and use automatically. **OpenAI Codex:** install the [Firecrawl Codex plugin](https://github.com/firecrawl/firecrawl-codex-plugin) or wire MCP only — see [Skills + CLI — Installation](/sdks/cli#installation) and [Codex CLI](/quickstarts/codex-cli). **Other agents:** one install command sets up the CLI tools for live web work and the build skills for integrating Firecrawl into application code:

```bash
npx -y firecrawl-cli@latest init --all --browser
Expand Down
16 changes: 14 additions & 2 deletions sdks/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Skills + CLI"
description: "Firecrawl skills are an easy way for AI agents such as Claude Code, Antigravity and OpenCode to use Firecrawl through the CLI."
description: "Firecrawl skills are an easy way for AI agents such as Claude Code, Antigravity, OpenCode, and OpenAI Codex to use Firecrawl through the CLI or Codex plugins."
og:title: "CLI | Firecrawl"
og:description: "Firecrawl skills are an easy way for AI agents to use Firecrawl through the CLI. AI agents can get web data through a better and more context efficient interface"
---
Expand All @@ -24,10 +24,12 @@ import AgentBasic from "/snippets/v2/cli/agent/basic.mdx";
import AgentOptions from "/snippets/v2/cli/agent/options.mdx";
import InteractCLI from "/snippets/v2/interact/quickstart/cli.mdx";

Search, scrape, interact, crawl, map, and run agent jobs directly from the terminal. The Firecrawl CLI works standalone or with skills that AI coding agents like Claude Code, Antigravity, and OpenCode can discover and use automatically.
Search, scrape, interact, crawl, map, and run agent jobs directly from the terminal. The Firecrawl CLI works standalone or with skills that AI coding agents like Claude Code, Antigravity, OpenCode, and OpenAI Codex can discover and use automatically.

## Installation

### Other AI coding agents (Claude Code, Antigravity, OpenCode, …)

If you are using an AI agent like Claude Code, you can install the Firecrawl skills below and the agent will set them up for you.

```bash
Expand All @@ -41,6 +43,16 @@ npx -y firecrawl-cli@latest init --all --browser
After installing the skills, restart your agent for it to discover them.
</Note>

### OpenAI Codex (CLI and Codex app)

Codex installs **plugins** from the Plugin Directory (or from a configured marketplace). Use the official **Firecrawl** Codex plugin when it appears in the directory, or install from source while it is in review:

1. Clone [`firecrawl/firecrawl-codex-plugin`](https://github.com/firecrawl/firecrawl-codex-plugin) and add a [local marketplace entry](https://developers.openai.com/codex/plugins/build#install-a-local-plugin-manually) that points `source.path` at the plugin folder (see the repo’s `examples/marketplace.json`).
2. Restart Codex, open Plugins (or `/plugins` in Codex CLI), install **Firecrawl**, and enable it.
3. Install the Firecrawl CLI and authenticate so bundled skills can run terminal workflows: `npm install -g firecrawl-cli` then `firecrawl login --browser` (or set `FIRECRAWL_API_KEY`). The plugin also bundles the Firecrawl MCP server; set `FIRECRAWL_API_KEY` for that server in your Codex MCP configuration as described in the plugin README.

For **MCP-only** setup in Codex (no plugin), follow [MCP Web Search & Scrape in Codex CLI](/quickstarts/codex-cli).

You can also manually install the Firecrawl CLI globally using npm:

<InstallationCLI />
Expand Down