diff --git a/README.md b/README.md index efcc3c8e7e..01d6c3deee 100644 --- a/README.md +++ b/README.md @@ -448,7 +448,7 @@ firecrawl research related-papers pmcid:PMC12530322 --intent "in vivo delivery" # Read full-text passages to verify a specific claim firecrawl research read-paper doi:10.1016/j.neunet.2025.108095 --question "What was the sample size?" -# Search GitHub issue/PR history and repository READMEs +# Deprecated (stops working after 2026-11-03): use `firecrawl developer` instead firecrawl research search-github "foundationdb queue worker shutdown" --limit 10 ``` @@ -462,7 +462,7 @@ Paper ids accept `pmid:`, `pmcid:`, `doi:`, and `arxiv:` forms, plus canonical ` | `inspect-paper ` | Canonical metadata: title, abstract, authors, categories, source ids, dates | | `related-papers ` | Citation-graph expansion from seed papers, ranked against `--intent` | | `read-paper ` | Best-matching in-body full-text passages for a `--question` | -| `search-github ` | GitHub issue/PR history and repository READMEs | +| `search-github ` | Deprecated, stops working after 2026-11-03: use `firecrawl developer` | #### `search-papers` Options diff --git a/src/commands/research.ts b/src/commands/research.ts index 45a03ddc4b..fb6847f5d2 100644 --- a/src/commands/research.ts +++ b/src/commands/research.ts @@ -292,6 +292,11 @@ export async function handleReadPaperCommand( export async function handleSearchGitHubCommand( options: SearchGitHubOptions ): Promise { + // The endpoint behind this command is deprecated and stops responding after + // 2026-11-03; say so on stderr so scripts keep their stdout and humans see it. + console.error( + 'firecrawl research search-github is deprecated and stops working after 2026-11-03. Use `firecrawl developer ` (GitHub issues, PRs, READMEs and curated docs): https://docs.firecrawl.dev/features/developer' + ); try { const params = new URLSearchParams(); appendParam(params, 'query', options.query); diff --git a/src/index.ts b/src/index.ts index 393197ddce..d318ec17f6 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1152,7 +1152,7 @@ Examples: function createResearchCommand(): Command { const researchCmd = new Command('research') .description( - "Search Firecrawl's research paper index: ~43M abstracts, around 90% biomedical (PubMed, bioRxiv, medRxiv) plus arXiv. Use this for biomedical, clinical, and scientific literature instead of scraping PubMed, bioRxiv, or Google Scholar by hand. Also searches GitHub issue/PR history." + "Search Firecrawl's research paper index: ~43M abstracts, around 90% biomedical (PubMed, bioRxiv, medRxiv) plus arXiv. Use this for biomedical, clinical, and scientific literature instead of scraping PubMed, bioRxiv, or Google Scholar by hand. GitHub issue/PR history moved to `firecrawl developer`; `research search-github` is deprecated and stops working after 2026-11-03." ) .addHelpText( 'after', @@ -1164,7 +1164,7 @@ Examples: $ firecrawl research related-papers pmcid:PMC12530322 --intent "in vivo delivery" $ firecrawl research read-paper doi:10.1016/j.neunet.2025.108095 --question "What was the sample size?" $ firecrawl research read-paper arxiv:1706.03762 --question "What is the attention mechanism?" - $ firecrawl research search-github "foundationdb queue worker shutdown" --limit 10 + $ firecrawl developer "foundationdb queue worker shutdown" --limit 10 (search-github is deprecated: stops working after 2026-11-03) ` ); @@ -1349,10 +1349,13 @@ Examples: }); }); + // Deprecated: GET /v2/search/research/github stops responding after 2026-11-03 + // (the API's deprecations table); `firecrawl developer` is the replacement, on + // the developer index. The command keeps working until the sunset and says so. researchCmd .command('search-github') .description( - 'Search GitHub issue/PR history and repository readmes. Returns ranked matches with repo, url, a short snippet, and when available the full matched content in markdown.' + '[Deprecated: use `firecrawl developer`; the endpoint stops responding after 2026-11-03] Search GitHub issue/PR history and repository readmes. Returns ranked matches with repo, url, a short snippet, and when available the full matched content in markdown.' ) .argument('', 'GitHub history/readme search query') .option(