Firecrawl.Cli 1.0.1

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet tool install --global Firecrawl.Cli --version 1.0.1                
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local Firecrawl.Cli --version 1.0.1                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Firecrawl.Cli&version=1.0.1                
nuke :add-package Firecrawl.Cli --version 1.0.1                

Firecrawl

Nuget package dotnet License: MIT Discord

Features 🔥

  • Fully generated C# SDK based on official Firecrawl OpenAPI specification using OpenApiGenerator
  • Same day update to support new features
  • Updated and supported automatically if there are no breaking changes
  • All modern .NET features - nullability, trimming, NativeAOT, etc.
  • Support .Net Framework/.Net Standard 2.0

Usage

using Firecrawl;

using var api = new FirecrawlApp(apiKey);

// Scrape
var response = await api.Scraping.ScrapeAsync("https://docs.firecrawl.dev/features/scrape");

string markdown = response.Data.Markdown;

// Crawl
var response = await api.Crawling.CrawlUrlsAsync(
    url: "https://docs.firecrawl.dev/",
    crawlerOptions: new CrawlUrlsRequestCrawlerOptions
    {
        Limit = 3,
    },
    pageOptions: new CrawlUrlsRequestPageOptions
    {
        OnlyMainContent = true,
    });

var jobResponse = await api.Crawl.WaitJobAsync(
    jobId: response.JobId);

foreach (var data in jobResponse.Data)
{
    Console.WriteLine($"URL: {data.Metadata.SourceURL}");
    Console.WriteLine($"Output file: {data.Markdown}");
}

CLI

dotnet tool install -g Firecrawl.Cli
firecrawl auth <API_KEY>
firecrawl scrape https://docs.firecrawl.dev/features/scrape // saves it to output.md
firecrawl crawl https://docs.firecrawl.dev/ --limit 5 // saves all .md files to docs.firecrawl.dev folder

Support

Priority place for bugs: https://github.com/tryAGI/Firecrawl/issues
Priority place for ideas and general questions: https://github.com/tryAGI/Firecrawl/discussions
Discord: https://discord.gg/Ca2xhfBf3v

Acknowledgments

JetBrains logo

This project is supported by JetBrains through the Open Source Support Program.

CodeRabbit logo

This project is supported by CodeRabbit through the Open Source Support Program.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.0.2-dev.4 55 9/26/2024
1.0.2-dev.2 38 9/8/2024
1.0.2-dev.1 35 9/8/2024
1.0.1 124 9/8/2024
1.0.1-dev.1 35 9/8/2024
1.0.0 97 9/8/2024