Agent skill

GitHub Deep Research

by bytedance in bytedance/deer-flow

Researches a GitHub repository over four rounds using the GitHub API and web search, then writes a structured markdown report with timeline, metrics and Mermaid diagrams.

MITAuto-check passedResearch & Science

Install GitHub Deep Research

skills CLI
$ npx skills add bytedance/deer-flow --skill github-deep-research -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install bytedance/deer-flow github-deep-research --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/bytedance/deer-flow.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/public/github-deep-research .claude/skills/github-deep-research && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
github-deep-research
GitHub stars
83k
Used in
5 other repos
Token cost
~1.3k tokens
SKILL.md length
403 words
Files
3 (incl. scripts, assets)
Skills in repo
23
Repo updated
First seen
Licence
MIT

At a glance

Researches a GitHub repository over four rounds using the GitHub API and web search, then writes a structured markdown report with timeline, metrics and Mermaid diagrams.

  • Works in 5 steps: Official docs/repos (highest weight) → Technical blogs (Medium, Dev.to) → News articles (verified outlets) → …
  • Investigating the history and direction of an open source project
  • SKILL.md covers Research Workflow, Core Methodology, Report Structure and Confidence Scoring, plus 2 more sections
  • Runs Python scripts from its folder; calls python; reaches github.com and langchain.com

What it does

Research happens in four rounds on a GitHub repository or open source project. Round 1 calls a bundled script, scripts/github_api.py, which can return a repo summary, info, README, file tree, languages, contributors, commits, issues, PRs and releases. Round 2 runs a handful of web searches to find the overview, the official site and the main competitors.

Round 3 adds more searches and fetches full pages for architecture details, key events and community sentiment, and Round 4 goes back to the commit history, issues, pull requests and contributor activity to reconstruct a timeline and see how features evolved. Sources are ranked, with official docs and repositories first and social media last, used mainly for sentiment.

The report follows assets/report_template.md: metadata, executive summary, chronological timeline, topic deep dives, metrics and comparison tables, strengths and weaknesses, categorized sources, a confidence assessment and methodology. Mermaid Gantt and flowchart diagrams are included where they help.

When your agent uses it

  • Investigating the history and direction of an open source project
  • Comparing a repository with its competitors
  • Reconstructing a project timeline from commits, issues and pull requests

Example prompts

  • “Research the BurntSushi/ripgrep repository in depth and give me a timeline of key releases.”
  • “Compare this project with its main alternatives using the GitHub API and web sources.”
  • “Reconstruct how the feature set of this repo evolved from its commits and issues.”

Requirements

  • Python to run scripts/github_api.py
  • Web search and fetch tools
  • Network access to the GitHub API

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Official docs/repos (highest weight)
  2. Technical blogs (Medium, Dev.to)
  3. News articles (verified outlets)
  4. Community discussions (Reddit, HN)
  5. Social media (lowest weight, for sentiment)

What it can do on your machine

Read from SKILL.md and the folder at commit 35cdcab. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 1 file in scripts/ (Python), which the agent can run.

    Shell commands in SKILL.md call:

    • python

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • github.com
    • langchain.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

GitHub Deep Research loads about 1.3k tokens when it runs. Until then it costs about 98 tokens; SKILL.md has 403 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~98
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

The full file from bytedance/deer-flow at commit 35cdcab, republished under its MIT licence (© bytedance). 403 words, ~1,260 tokens.

Download SKILL.mdSave it as .claude/skills/github-deep-research/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
github-deep-research
description
Conduct multi-round deep research on any GitHub Repo. Use when users request comprehensive analysis, timeline reconstruction, competitive analysis, or in-depth investigation of GitHub. Produces structured markdown reports with executive summaries, chronological timelines, metrics analysis, and Mermaid diagrams. Triggers on Github repository URL or open source projects.

GitHub Deep Research Skill

Multi-round research combining GitHub API, web_search, web_fetch to produce comprehensive markdown reports.

Research Workflow

  • Round 1: GitHub API
  • Round 2: Discovery
  • Round 3: Deep Investigation
  • Round 4: Deep Dive

Core Methodology

Query Strategy

Broad to Narrow: Start with GitHub API, then general queries, refine based on findings.

Round 1: GitHub API
Round 2: "{topic} overview"
Round 3: "{topic} architecture", "{topic} vs alternatives"
Round 4: "{topic} issues", "{topic} roadmap", "site:github.com {topic}"

Source Prioritization:

  1. Official docs/repos (highest weight)
  2. Technical blogs (Medium, Dev.to)
  3. News articles (verified outlets)
  4. Community discussions (Reddit, HN)
  5. Social media (lowest weight, for sentiment)
Research Rounds

Round 1 - GitHub API Directly execute scripts/github_api.py without read_file():

bash
python /path/to/skill/scripts/github_api.py <owner> <repo> summary
python /path/to/skill/scripts/github_api.py <owner> <repo> readme
python /path/to/skill/scripts/github_api.py <owner> <repo> tree

Available commands (the last argument of github_api.py):

  • summary
  • info
  • readme
  • tree
  • languages
  • contributors
  • commits
  • issues
  • prs
  • releases

Round 2 - Discovery (3-5 web_search)

  • Get overview and identify key terms
  • Find official website/repo
  • Identify main players/competitors

Round 3 - Deep Investigation (5-10 web_search + web_fetch)

  • Technical architecture details
  • Timeline of key events
  • Community sentiment
  • Use web_fetch on valuable URLs for full content

Round 4 - Deep Dive

  • Analyze commit history for timeline
  • Review issues/PRs for feature evolution
  • Check contributor activity

Report Structure

Follow template in assets/report_template.md:

  1. Metadata Block - Date, confidence level, subject
  2. Executive Summary - 2-3 sentence overview with key metrics
  3. Chronological Timeline - Phased breakdown with dates
  4. Key Analysis Sections - Topic-specific deep dives
  5. Metrics & Comparisons - Tables, growth charts
  6. Strengths & Weaknesses - Balanced assessment
  7. Sources - Categorized references
  8. Confidence Assessment - Claims by confidence level
  9. Methodology - Research approach used
Mermaid Diagrams

Include diagrams where helpful:

Timeline (Gantt):

mermaid
gantt
    title Project Timeline
    dateFormat YYYY-MM-DD
    section Phase 1
    Development    :2025-01-01, 2025-03-01
    section Phase 2
    Launch         :2025-03-01, 2025-04-01

Architecture (Flowchart):

mermaid
flowchart TD
    A[User] --> B[Coordinator]
    B --> C[Planner]
    C --> D[Research Team]
    D --> E[Reporter]

Comparison (Pie/Bar):

mermaid
pie title Market Share
    "Project A" : 45
    "Project B" : 30
    "Others" : 25
Show full SKILL.md (162 more words)Show less

Confidence Scoring

Assign confidence based on source quality:

ConfidenceCriteria
High (90%+)Official docs, GitHub data, multiple corroborating sources
Medium (70-89%)Single reliable source, recent articles
Low (50-69%)Social media, unverified claims, outdated info

Output

Save report as: research_{topic}_{YYYYMMDD}.md

Formatting Rules
  • Chinese content: Use full-width punctuation(,。:;!?)
  • Technical terms: Provide Wiki/doc URL on first mention
  • Tables: Use for metrics, comparisons
  • Code blocks: For technical examples
  • Mermaid: For architecture, timelines, flows

Best Practices

  1. Start with official sources - Repo, docs, company blog
  2. Verify dates from commits/PRs - More reliable than articles
  3. Triangulate claims - 2+ independent sources
  4. Note conflicting info - Don't hide contradictions
  5. Distinguish fact vs opinion - Label speculation clearly
  6. CRITICAL: Always include inline citations - Use [citation:Title](URL) format immediately after each claim from external sources
  7. Extract URLs from search results - web_search returns {title, url, snippet} - always use the URL field
  8. Update as you go - Don't wait until end to synthesize
Citation Examples

Good - With inline citations:

markdown
The project gained 10,000 stars within 3 months of launch [citation:GitHub Stats](https://github.com/owner/repo).
The architecture uses LangGraph for workflow orchestration [citation:LangGraph Docs](https://langchain.com/langgraph).

Bad - Without citations:

markdown
The project gained 10,000 stars within 3 months of launch.
The architecture uses LangGraph for workflow orchestration.

© bytedance, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 2 other files (scripts, assets) in skills/public/github-deep-research of bytedance/deer-flow.

  • SKILL.md
  • assets/report_template.md
  • scripts/github_api.py

Open the folder on GitHubat commit 35cdcab

Used in 5 other repositories

We found 5 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 5 other GitHub owners. This page covers the copy in bytedance/deer-flow, which our catalogue first saw on October 7, 2026.

Compare with similar skills

GitHub Deep Research next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

GitHub Deep Research compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
GitHub Deep Research this skillbytedance/deer-flow83k5 repos~1.3kAutomated safety check: PassMIT
Rival Search MCPdamionrashford/RivalSearchMCP1321 repos~796Automated safety check: PassMIT
Design Doc MermaidSpillwaveSolutions/design-doc-mermaid1751 repos~5.6kAutomated safety check: PassNone
Deep Research MCP Guidepminervini/deep-research-mcp112—~5.8kAutomated safety check: PassMIT
Inno Code SurveyLigphiDonk/Oh-my--paper738—~3.6kAutomated safety check: PassMIT
Research Workflowmajiayu000/claude-skill-registry6661 repos~684Automated safety check: NotesMIT

Similar skills

  • Rival Search MCP

    damionrashford/RivalSearchMCP

    Deterministic deep research via RivalSearchMCP. An agent skill from damionrashford/RivalSearchMCP.

    132 GitHub starsUsed in 1 repo~796 tokens
    Research & ScienceAuto-check passed
  • Design Doc Mermaid

    SpillwaveSolutions/design-doc-mermaid

    Create Mermaid diagrams (flowchart, sequence, class, ER, state, C4, architecture) from text or source code.

    175 GitHub starsUsed in 1 repo~5.6k tokens
    DevelopmentAuto-check passed
  • Deep Research MCP Guide

    pminervini/deep-research-mcp

    Explains how to run, integrate and debug the deep-research-mcp project through its CLI, Python API or MCP server, with OpenAI, Gemini and DR-Tulu backends.

    112 GitHub stars~5.8k tokensUpdated 9 days ago
    Research & ScienceAuto-check passed
  • Inno Code Survey

    LigphiDonk/Oh-my--paper

    Finds and clones missing code repositories for a chosen research idea, then writes a survey that maps academic concepts to their implementations.

    738 GitHub stars~3.6k tokensUpdated 5 mo ago
    Research & ScienceAuto-check passed
  • Research Workflow

    majiayu000/claude-skill-registry

    Systematic research workflow orchestrating multi-source research operations for comprehensive domain investigation.

    666 GitHub starsUsed in 1 repo~684 tokens
    Research & ScienceAuto-check: notes
  • Horizontal-Vertical Deep Research

    KKKKhazix/khazix-skills

    Runs a two-axis deep research method on a product, company, concept or person: its full history over time, compared with peers today, delivered as a typeset PDF report.

    21k GitHub stars~2.1k tokensUpdated 6 days ago
    Research & ScienceAuto-check passed

More from bytedance/deer-flow

All 23 skills in this repo
  • Vercel Deploy

    bytedance/deer-flow

    Deploys a project to Vercel with one script and no login, then returns a live preview URL and a claim link for moving the deployment into your own Vercel account.

    83k GitHub starsUsed in 10 repos~797 tokens
    Auto-check passed
  • Chart Visualization

    bytedance/deer-flow

    Picks a suitable chart type from 26 options for your data, maps the data to that chart's parameters and generates a chart image through a JavaScript script.

    83k GitHub starsUsed in 2 repos~840 tokens
    Auto-check passed
  • Structured Image Generation

    bytedance/deer-flow

    Turns an image request into a structured JSON prompt and runs a bundled Python script to generate the picture, optionally guided by reference images.

    83k GitHub starsUsed in 5 repos~2.9k tokens
    Auto-check passed
  • Excel and CSV Data Analysis

    bytedance/deer-flow

    Analyzes uploaded Excel and CSV files with SQL through DuckDB, producing schema inspections, statistical summaries and exports to CSV, JSON or Markdown.

    83k GitHub starsUsed in 4 repos~2.2k tokens
    Auto-check passed
  • DeerFlow Smoke Test

    bytedance/deer-flow

    Walks through an end-to-end smoke test of a DeerFlow deployment: pull the latest code, deploy with Docker or locally, verify services, run health checks and write a report.

    83k GitHub stars~2.5k tokensUpdated today
    Auto-check: notes
  • Video Generation

    bytedance/deer-flow

    Generates short videos from a structured JSON prompt, optionally guided by a reference image used as the first or last frame.

    83k GitHub starsUsed in 3 repos~1.4k tokens
    Auto-check passed

Questions about GitHub Deep Research

What does GitHub Deep Research do?

Researches a GitHub repository over four rounds using the GitHub API and web search, then writes a structured markdown report with timeline, metrics and Mermaid diagrams. Research happens in four rounds on a GitHub repository or open source project.py, which can return a repo summary, info, README, file tree, languages, contributors, commits, issues, PRs and releases.

When should I use GitHub Deep Research?

GitHub Deep Research fits situations like: investigating the history and direction of an open source project; comparing a repository with its competitors; reconstructing a project timeline from commits, issues and pull requests.

How do I install GitHub Deep Research in Claude Code?

Run `npx skills add bytedance/deer-flow --skill github-deep-research -a claude-code`. Or copy the skill folder (skills/public/github-deep-research in bytedance/deer-flow) into .claude/skills/github-deep-research in your project. Claude Code loads it when a task matches its description.

How do I install GitHub Deep Research in Codex?

Run `npx skills add bytedance/deer-flow --skill github-deep-research -a codex`. Or copy the skill folder (skills/public/github-deep-research in bytedance/deer-flow) into .agents/skills/github-deep-research in your project. Codex loads it when a task matches its description.

Can I use GitHub Deep Research in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add bytedance/deer-flow --skill github-deep-research -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/github-deep-research, .gemini/skills/github-deep-research, .github/skills/github-deep-research and .opencode/skills/github-deep-research in your project.

What does GitHub Deep Research need to run?

Going by SKILL.md and its folder, GitHub Deep Research needs Python for the scripts in its folder and the command-line tools its instructions call (python). Our summary lists: Python to run scripts/github_api.py; Web search and fetch tools; Network access to the GitHub API.

Does GitHub Deep Research access the network?

SKILL.md names 2 domains. In commands or code: github.com and langchain.com; the agent is likely to contact these when it follows the instructions. This is read from the text; nothing was executed.

Is GitHub Deep Research safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does GitHub Deep Research use?

GitHub Deep Research is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does GitHub Deep Research use?

About 1.3k tokens (SKILL.md is roughly 5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to GitHub Deep Research?

Skills that share tags, products or a category with GitHub Deep Research: Rival Search MCP (damionrashford/RivalSearchMCP, 132 stars), Design Doc Mermaid (SpillwaveSolutions/design-doc-mermaid, 175 stars), Deep Research MCP Guide (pminervini/deep-research-mcp, 112 stars) and Inno Code Survey (LigphiDonk/Oh-my--paper, 738 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains GitHub Deep Research?

bytedance (a GitHub organization) maintains it in bytedance/deer-flow, which has 83,441 GitHub stars. The repository holds 23 skills in this directory. The repository was last updated on October 7, 2026.

Source: bytedance/deer-flow on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.