Skip to content

firecrawl/firecrawl-obsidian

Repository files navigation

Firecrawl for Obsidian

Scrape, search, and extract web content into your Obsidian vault as clean markdown, powered by Firecrawl.

Features

  • Scrape URL to new note: turn any web page into a markdown note with source metadata in the frontmatter.
  • Scrape URL at cursor and insert: scrape the URL in your selection or current line and insert the markdown inline.
  • Firecrawl search to note: run a web search and save the results as a linked list note.

All network requests use Obsidian's requestUrl, so the plugin works on desktop and mobile without a proxy.

Setup

  1. Install the plugin (see Development below until it is in the community store).
  2. Open Settings -> Firecrawl.
  3. Paste your Firecrawl API key. Get one at firecrawl.dev.
  4. Optionally set the note folder, search limit, and base URL (only change the base URL if you self-host Firecrawl).

Your API key is stored in this vault's data.json in plain text, the same as other Obsidian plugins. Do not sync data.json to untrusted locations.

Usage

Open the command palette and run any of:

  • Firecrawl: Scrape URL to new note
  • Firecrawl: Scrape URL at cursor and insert
  • Firecrawl: Firecrawl search to note

Development

npm install
npm run dev      # watch build, emits main.js

To test in Obsidian, clone this repo into <your-vault>/.obsidian/plugins/firecrawl/, run the dev build, then enable the plugin under Community plugins. Use a dedicated development vault, never your main one.

npm run build    # typecheck + production build

Release

Bump the version with npm version <patch|minor|major> (updates manifest.json and versions.json), then push the tag. The GitHub Action builds and attaches main.js, manifest.json, and styles.css to the release.

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors