Docs: rewrite the README to match the Claude plugin#1
Closed
rakshith48 wants to merge 2 commits into
Closed
Conversation
- Fix stale org links (mendableai/* -> firecrawl/*) - Replace the partial/drifting CLI command table with a link to the canonical docs (docs.firecrawl.dev/cli) - List the actual shipped capabilities/skills (adds interact, agent, monitor, parse, download — previously missing or inaccurate) - Clarify install: add plugin -> install CLI -> sign in (browser, with API-key/env alternatives) - Add a Configuration table (incl. FIRECRAWL_NO_TELEMETRY opt-out) and tidy Resources/Support - Set license to MIT for consistency with the manifest and sibling plugins Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThe README is completely rewritten to establish Firecrawl for Cursor as a CLI-driven plugin providing web scraping with anti-bot handling. Installation now spans Cursor plugin setup, global CLI installation, and authentication. Capabilities expand with new features and usage examples demonstrate real workflows. Configuration tables and self-hosting guidance round out the documentation. ChangesREADME Documentation Update
🎯 2 (Simple) | ⏱️ ~8 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
/add-plugin and the Cursor plugin Marketplace aren't available to users yet. The supported install today is the Firecrawl CLI's init, which installs the skills into Cursor (.cursor/skills) and authenticates: npx -y firecrawl-cli@latest init --all --browser Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 55-60: The fenced code block containing the usage/demo lines is
missing a language tag causing MD040; update that fenced block (the
triple-backtick block that contains the four sample tasks like "Search for 'best
practices for React testing'..." and the other three lines) by adding a language
identifier (e.g., text) immediately after the opening ``` so it becomes ```text
to ensure proper linting and rendering.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Owner
Author
|
Migrated to the upstream repo: firecrawl#30 |
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
1 participant
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.
Brings the Cursor plugin README up to parity with the Claude plugin and fixes factual errors.
Fixes
github.com/mendableai/firecrawl-cli→firecrawl/cliskills/firecrawl/SKILL.md; the repo actually ships 10 skillsnpx -y firecrawl-cli@latest init --all --browser(installs skills into.cursor/skillsand signs in via browser). Earlier I'd written/add-plugin, but Cursor's in-editor plugin install / Marketplace isn't available to users yet.plugin.json)🤖 Generated with Claude Code
Summary by CodeRabbit