Skip to content

docs(skills): fix command examples that fail or mislead - #190

Open
chenxin-yan wants to merge 2 commits into
firecrawl:mainfrom
chenxin-yan:skills/fix-broken-examples
Open

docs(skills): fix command examples that fail or mislead#190
chenxin-yan wants to merge 2 commits into
firecrawl:mainfrom
chenxin-yan:skills/fix-broken-examples

Conversation

@chenxin-yan

@chenxin-yan chenxin-yan commented Aug 17, 2026

Copy link
Copy Markdown

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

Doc Was Now Why
firecrawl-download firecrawl download firecrawl x download download is only registered under the experimental/x group — bare form errors out
firecrawl-download 2 examples without -y -y added without it the command blocks on a confirm prompt (hangs/aborts in non-TTY shells)
firecrawl-download "All scrape options work" "Supported scrape options are listed below" several scrape flags (--redact-pii, -Q, --profile, …) don't exist on download
firecrawl-interact --language <lang> --node (default) / --python / --bash --language doesn't exist
firecrawl-scrape -H = "Include HTTP headers" -H, --html = raw-HTML shortcut no headers flag exists
firecrawl-agent + README --wait -o file.json / --wait --pretty added --json without --json, --wait results are written as human-readable text (no extension inference) and --pretty is silently ignored

Guardrail

  • package.json: Prettier format/format:check now include skills/**/*.md, so skill-doc formatting drift fails CI instead of only lint-staged (bypassable via --no-verify or web edits).

Validation

pnpm run format:check, pnpm run type-check, and pnpm test all pass. Independently reviewed by three fresh-context reviewers against the CLI source.

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.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 7 files

Re-trigger cubic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant