docs(skills): fix command examples that fail or mislead - #190
Open
chenxin-yan wants to merge 2 commits into
Open
docs(skills): fix command examples that fail or mislead#190chenxin-yan wants to merge 2 commits into
chenxin-yan wants to merge 2 commits into
Conversation
Make download examples safe for non-interactive flows and correct agent JSON guidance in the README. Include skill Markdown in Prettier scripts so formatting drift is caught.
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.
Skill docs are agent-facing: agents copy these commands verbatim, so a wrong flag either hard-fails (unknown option) or silently produces the wrong output. Every fix below was verified against the Commander definitions in
src/index.ts.Fixes
firecrawl-downloadfirecrawl downloadfirecrawl x downloaddownloadis only registered under theexperimental/xgroup — bare form errors outfirecrawl-download-y-yaddedfirecrawl-download--redact-pii,-Q,--profile, …) don't exist on downloadfirecrawl-interact--language <lang>--node(default) /--python/--bash--languagedoesn't existfirecrawl-scrape-H= "Include HTTP headers"-H, --html= raw-HTML shortcutfirecrawl-agent+ README--wait -o file.json/--wait --pretty--json--json,--waitresults are written as human-readable text (no extension inference) and--prettyis silently ignoredGuardrail
package.json: Prettierformat/format:checknow includeskills/**/*.md, so skill-doc formatting drift fails CI instead of only lint-staged (bypassable via--no-verifyor web edits).Validation
pnpm run format:check,pnpm run type-check, andpnpm testall pass. Independently reviewed by three fresh-context reviewers against the CLI source.