Skip to content

docs(cli): document CLI request attribution and agent origin #1675

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

Closed
mintlify wants to merge 2 commits into from
Closed

docs(cli): document CLI request attribution and agent origin #1675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c428dc7
docs(cli): document FIRECRAWL_INTEGRATION for CLI wrappers
mintlify[bot] Oct 20, 2026
dc2631a
docs(cli): document the coding agent request origin and its opt-out
mintlify[bot] Oct 24, 2026
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
2 changes: 1 addition & 1 deletion api-reference/v2-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9444,7 +9444,7 @@
"integration": {
"type": "string",
"nullable": true,
"description": "Optional integration identifier. When omitted, a valid `X-Integration` request header is used instead; the body value takes precedence."
"description": "Optional integration identifier. When omitted, `null` or `cli`, a valid `X-Integration` request header is used instead. Any other body value takes precedence over the header."
},
"auditMetadata": {
"$ref": "#/components/schemas/AuditMetadata"
Expand Down
18 changes: 18 additions & 0 deletions sdks/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,24 @@ firecrawl https://example.com --format links --json | jq -r '.links[]'
firecrawl map https://example.com | wc -l
```

## Request attribution

Requests from the CLI are tagged with `integration: cli`. If you build a tool that wraps the CLI, set `FIRECRAWL_INTEGRATION` to attribute its requests to your tool instead:

```bash CLI
export FIRECRAWL_INTEGRATION=_my-tool
```

The CLI sends the value as the `X-Integration` header on every API request. Firecrawl attributes the request to that value when it is a recognized integration name or starts with an underscore. Firecrawl ignores any other value, and the request still succeeds.

Supported CLI requests also carry an origin of `cli@<version>`. When a coding agent runs the CLI, the origin names the agent too, for example `cli.codex@<version>`. The CLI detects Claude Code, Codex, Cursor, Gemini CLI, opencode, Goose and Cline from environment variables those agents set in the commands they run. Requests the CLI sends through the SDK include the agent only once the SDK version the CLI pins supports the origin option. The `integration: cli` tag does not change.

To send plain `cli@<version>` instead, set `FIRECRAWL_CLI_DISABLE_AGENT_ORIGIN` to `1`, `true`, `yes` or `on`:

```bash CLI
export FIRECRAWL_CLI_DISABLE_AGENT_ORIGIN=1
```

## Telemetry

The CLI collects anonymous usage data during authentication to help improve the product:
Expand Down
Loading