docs(cli): state scrape defaults in help - #169
Open
sshkeda wants to merge 1 commit into
Open
Conversation
The scrape help described multi-URL behavior but not what a single URL does, the -o flag did not say it applies to one URL only, and -f never named its default format. This adds the three missing facts to the description strings. No behavior changes.
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.
Why
firecrawl scrapeis the command that downloads a web page. Its help text leaves out three facts a first-time user needs.Here is the current help, and what each line does not say:
This describes what many URLs do. It never says what one URL does: the page prints to stdout. A user who scrapes one page and expects a file gets nothing on disk and no explanation.
This says where one URL goes. It never says the flag only applies to a single URL.
This lists eleven formats. It never states which one you get by default: markdown.
Summary
The same three lines, after:
Test Plan
pnpm run buildsucceeds andpnpm run format:checkpasses on this exact commit..firecrawl/, and a bare scrape returns markdown.scrape --helpbefore their first scrape. With this commit, two of the four went straight to a correct scrape without it. All eight sessions and the comparison: full transcripts.