Skip to content

docs(cli): state scrape defaults in help #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sshkeda wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(cli): state scrape defaults in help #169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ program
function createScrapeCommand(): Command {
const scrapeCmd = new Command('scrape')
.description(
'Scrape one or more URLs. Multiple URLs are scraped concurrently and saved to .firecrawl/'
'Scrape one or more URLs. A single URL prints to stdout by default. Multiple URLs are scraped concurrently and saved to .firecrawl/'
)
.argument('[urls...]', 'URL(s) to scrape')
.option(
Expand All @@ -353,7 +353,7 @@ function createScrapeCommand(): Command {
.option('-H, --html', 'Output raw HTML (shortcut for --format html)')
.option(
'-f, --format <formats>',
'Output format(s). Multiple formats can be specified with commas (e.g., "markdown,links,images"). Available: markdown, html, rawHtml, links, images, screenshot, summary, changeTracking, json, attributes, branding. Single format outputs raw content; multiple formats output JSON.'
'Output format(s) (default: markdown). Multiple formats can be specified with commas (e.g., "markdown,links,images"). Available: markdown, html, rawHtml, links, images, screenshot, summary, changeTracking, json, attributes, branding. Single format outputs raw content; multiple formats output JSON.'
)
.option('--only-main-content', 'Include only main content', false)
.option(
Expand All @@ -371,7 +371,10 @@ function createScrapeCommand(): Command {
'Firecrawl API key (overrides global --api-key)'
)
.option('--api-url <url>', 'API URL (overrides global --api-url)')
.option('-o, --output <path>', 'Output file path (default: stdout)')
.option(
'-o, --output <path>',
'Output file path for a single URL (default: stdout)'
)
.option('--json', 'Output as JSON format', false)
.option('--pretty', 'Pretty print JSON output', false)
.option(
Expand Down