Repository navigation
docs: add a Firecrawl Local page - #1805
Merged
Merged
Conversation
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>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Firecrawl Local, the single binary in
apps/localthat scrapes, crawls and maps on your own machine, had no docs page. This adds one.What changed
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 withinitor by hand, the local v2 API with curl, Python and Node snippets, the commands, what goes to Firecrawl Cloud and howFIRECRAWL_CLOUDcontrols it, security defaults, Docker, configuration and limits.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 keylessserveand the corrected sign-in hint, so merge this after firecrawl#5841 merges and 0.1.1 is published.Testing
firecrawl-py4.57.0) and Node (firecrawl4.54.0) snippets run as written againstfirecrawl-local servewith no API key.scripts/check-extraction-hostile-markdown.shand the locale literal check (scoped to these files, as in CI) pass.mint broken-linksreports nothing in the new or edited pages.mint devrenders the page and its sidebar entry. Checked at desktop and phone widths.🤖 Generated with Claude Code