Skip to content

docs: add a Firecrawl Local page - #1805

Merged
ericciarla merged 1 commit into
mainfrom
firecrawl-local-docs
Nov 18, 2026
Merged

ericciarla merged 1 commit into
mainfrom
firecrawl-local-docs

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Firecrawl Local, the single binary in apps/local that scrapes, crawls and maps on your own machine, had no docs page. This adds one.

What changed

  • New page contributing/firecrawl-local, in the Contributing group between Open Source vs Cloud and Contributor Setup. It covers when to pick Local, self-hosting or Cloud, install, quick start, MCP setup with init or by hand, the local v2 API with curl, Python and Node snippets, the commands, what goes to Firecrawl Cloud and how FIRECRAWL_CLOUD controls it, security defaults, Docker, configuration and limits.
  • Open Source vs Cloud gets one bullet pointing to it.
  • Nav. English only, per the repo guidelines. Translations come from the pipeline.

It matches the README rewrite in firecrawl/firecrawl#5841.

Merge order

The page leads with cargo install firecrawl-local. crates.io still has 0.1.0, which predates the keyless serve and the corrected sign-in hint, so merge this after firecrawl#5841 merges and 0.1.1 is published.

Testing

  • Every command and snippet on the page was run against Firecrawl Local built from firecrawl#5841. The firecrawl PR lists each check.
  • The Python (firecrawl-py 4.57.0) and Node (firecrawl 4.54.0) snippets run as written against firecrawl-local serve with no API key.
  • scripts/check-extraction-hostile-markdown.sh and the locale literal check (scoped to these files, as in CI) pass.
  • mint broken-links reports nothing in the new or edited pages.
  • mint dev renders the page and its sidebar entry. Checked at desktop and phone widths.

🤖 Generated with Claude Code

Firecrawl Local (apps/local in firecrawl/firecrawl) had no docs. Adds a
page under Contributing, next to Open Source vs Cloud and Self-hosting,
covering install, quick start, MCP setup, the local v2 API with Python
and Node SDK snippets, what runs on Firecrawl Cloud, security defaults
and configuration. Links it from the Open Source vs Cloud page.

English only; translations come from the pipeline.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Nov 18, 2026, 5:10 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

This branch was successfully deployed

1 active deployment
staging — 5ae320e9 Deployed Nov 18, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant