ResearchFlow

workflow
Guvenlik Denetimi
Uyari
Health Uyari
  • License — License: MIT
  • Description — Repository has a description
  • Active repo — Last push 0 days ago
  • Low visibility — Only 5 GitHub stars
Code Uyari
  • network request — Outbound network request in .claude/skills/papers-collect-from-web/scripts/paper_collector_online/collect_from_urls.py
Permissions Gecti
  • Permissions — No dangerous permissions requested
Purpose
This tool acts as a semi-automated research assistant, transforming academic papers, PDFs, and notes into a structured local knowledge base that AI agents (like Claude Code or Codex CLI) can read to help with ideation, coding, and writing.

Security Assessment
Overall risk: Low. The tool does not request any inherently dangerous system permissions. It operates primarily on local files, reading and indexing Markdown and PDFs to build its knowledge base. There are no hardcoded secrets detected in the codebase. There is a low-severity warning regarding a single outbound network request found in a script designed to collect papers from URLs. Because fetching web content is an expected feature for a research tool, this request is standard behavior. However, users should still inspect the script if they plan to use it, to ensure no unexpected telemetry or data is transmitted.

Quality Assessment
The project is very new and has minimal community visibility, currently sitting at only 5 GitHub stars. This indicates a low community trust level and a small user base, meaning bugs might go unreported. Despite the low adoption, the repository is actively maintained with a recent push made today. It also uses a permissive MIT license, making it fully open source and legally safe to integrate, modify, and use in personal or commercial projects.

Verdict
Use with caution — the code is open, safe, and actively maintained, but lacks the community testing and visibility of a highly trusted tool.
SUMMARY

Semi-automated research assistant and local knowledge base for paper analysis, ideation, coding, experiments, writing, and publication workflows.

README.md

ResearchFlow logo

ResearchFlow

Semi-automated local research knowledge base and research assistant for paper analysis, ideation, coding, experiments, writing, and publication workflows.

English | Chinese

Semi-automated Knowledge base Claude Code compatible Codex CLI compatible Obsidian optional MIT license


ResearchFlow turns paper lists, PDFs, and structured analysis notes into shared local research memory that Claude Code, Codex CLI, and other AI research tools can reuse, and provides a coordinated skill layer that helps across ideation, framework design, coding, experimentation, writing, and publication.

collect paper list -> paper analysis -> build index -> research assist

It can serve three usage modes at the same time:

  • Claude Code / Cursor: via .claude/skills
  • Codex CLI: via AGENTS.md, which routes into .claude/skills
  • Other AI research tools: by directly reading local Markdown, PDFs, and indexes

Its focus is not just "paper management". The real goal is to turn local literature accumulation into an agent-ready knowledge base that can be retrieved, compared, reused for ideation, and linked to a code repository.

Domain Fork

ResearchFlow is not limited to academic research. With the domain-fork skill, you can migrate the same architecture into other professional domains while preserving the ideas of local knowledge accumulation, structured indexing, workflow skills, and downstream execution.

Typical examples include frontend development, accounting, journalism, policy analysis, legal workflows, or any domain that benefits from a shared local memory plus semi-automated assistance.

If you want a neutral starter name for your own fork, you are also welcome to try YourAnyFlow.

/domain-fork
Fork ResearchFlow into a frontend engineering version.
Keep the local knowledge base + workflow architecture, but remap papers, venues, and analysis notes to frontend references, implementation patterns, bug cases, and framework comparisons.
Generate the adapted repository structure, renamed skills, and README.
You are also welcome to try YourAnyFlow!

What It Can Do

  • Collect candidate papers for a topic from conference pages, blogs, and GitHub awesome repositories
  • Turn local PDFs into structured paper analysis notes with reusable fields such as core_operator, primary_logic, tags, venue, and year
  • Automatically rebuild indexes organized by task, technique, and venue
  • After build index, use the knowledge base for comparison, question lists, idea generation, reviewer-style critique, and paper retrieval before implementation
  • Let multiple agents, research projects, and code repositories reuse the same local knowledge base

Usage Examples

Below are several prompt examples.

  • The first line of each block explicitly names the recommended skill.
  • For the knowledge-base construction workflow, it is better to run the stages one by one instead of merging collect / download / analyze / build into one giant prompt.

1. Build a topic-specific knowledge base from scratch

If you do not yet have a good paper source, you can first ask the agent to find a better awesome repository or curated list for intake.

I want to build a knowledge base for controllable human motion generation.
Please search for relevant GitHub awesome repositories or curated paper lists first, and recommend the 2 most suitable options.

After selecting the source, run the following four prompts stage by stage.

(1) Build the paper candidate list

/papers-collect-from-github-awesome
Collect papers related to controllable human motion generation from this GitHub awesome repository: <URL>
Keep only items related to diffusion, controllability, real-time generation, or long-form motion.
Organize the result into a candidate list suitable for the downstream download workflow, and mark which entries should be kept or skipped.

(2) Download papers

/papers-download-from-list
Download the papers that are still marked as `Wait` in the current candidate list.
If a link is broken or a download fails, mark it as `Missing` and provide a short failure reason.
After finishing, return the counts of successful downloads, failures, and skipped items.

(3) Analyze papers

Because each session has limited context, it is recommended to process no more than 8 papers at a time, and continue in a new session when the context is getting full.

/papers-analyze-pdf
Analyze the PDFs under `paperPDFs/` that were newly downloaded but do not yet have corresponding analysis notes.
Write the analysis results into `paperAnalysis/`, and make sure the frontmatter includes title, venue, year, tags, core_operator, and primary_logic.
When finished, tell me which papers were newly added into the knowledge base in this round.

(4) Build indexes

Each analyzed paper carries tags. Index building organizes the tags across all papers so later research-assist steps can retrieve relevant papers more quickly.

/papers-build-collection-index
Rebuild `paperCollection/` based on the latest `paperAnalysis/`.
When finished, briefly summarize the current coverage of the knowledge base by task, technique, and venue.

2. Incrementally refresh the knowledge base after new PDFs arrive

/papers-analyze-pdf, /papers-build-collection-index
Process the items in `paperAnalysis/analysis_log.csv` that still need work.
After the analysis is done, rebuild `paperCollection/`.
Finally summarize:
- which papers were newly added this time
- which new method tags and technique tags were introduced

3. Compare papers for a design decision

/papers-compare-table
Compare DART, OmniControl, MoMask, and ReactDance, with a focus on their representation design.
Based on the core thinking, applicable scenarios, and capability characteristics of each design, analyze whether they can support <XXX>.
Save the analysis result into `paperIDEAs/`.

4. Use the knowledge base for idea generation instead of generic brainstorming

(1) Use the agent to generate initial ideas from a rough direction

/research-brainstorm-from-kb, /reviewer-stress-test
I want to study long-audio temporal localization.
Please first identify the first-principles challenges of this task, then combine the local knowledge base with necessary external search, borrow recent developments from video understanding, and organize several rounds of discussion between an author perspective and a CVPR/ICLR reviewer perspective.
Finally propose 3 viable ideas.
Each idea should include:
- the problem entry point
- why it is feasible
- which existing papers provide technical support and evidence
- whether the supporting papers have open-source code, how credible that support is, and how strongly it matches the current idea
- the minimum viable experiment
- the most likely reviewer objection
Write the final result into `paperIDEAs/`.

(2) Refine an initial idea with the agent

/idea-focus-coach
I designed a new motion representation in @paperIDEAs/2026-10-08_new_motion_representation_raw.md, and the goal is to support high generation quality, strong instruction following, and long-horizon consistency at the same time. I still need to further determine the following parts:
1. XXXX
2. XXXXX
3. ...
Write the result back into the markdown file.

(3) Once the idea is more mature, let the agent act as a reviewer for a pre-mortem

/reviewer-stress-test /research-question-bank
I designed a new motion representation in @paperIDEAs/2026-10-10_new_motion_representation.md, and the goal is to support high generation quality, strong instruction following, and long-horizon consistency at the same time.
Please act like a top-tier conference reviewer, point out the main weaknesses of the current plan, its overlap with related work, the core evaluation criteria, and major risks, and write the result back into the markdown file.

5. Link the knowledge base with a code repository

After linking ./ResearchFlow into a code repository, the agent can retrieve relevant papers before changing code, which makes the implementation more faithful to the idea or roadmap.

/code-context-paper-retrieval
Please implement the code changes according to @paperIDEAs/2026-10-12_new_motion_representation_roadmap.md. Before editing, retrieve relevant KB materials if needed.
Summarize:
- transferable operators
- key implementation constraints
- points that may conflict with the current code structure
- which designs best match our current idea / roadmap
Then provide the code modification plan and start implementing.
If the current knowledge base does not provide enough evidence, please point that out clearly before continuing.
Output a handling summary, and if there is progress, update @paperIDEAs/2026-10-12_new_motion_representation_roadmap.md.

6. Link the knowledge base with automation tools

ResearchFlow can serve as a high-quality local knowledge base and be combined with existing automated research tools, such as Deep Researcher Agent.

/papers-query-knowledge-base
Treat `ResearchFlow/` as the shared research memory and evidence layer for multiple agents in this project.
Follow these conventions while working:
- start retrieval from `paperCollection/`
- then look for evidence in `paperAnalysis/`
- write new question lists into `QuestionBank/`
- write new research ideas into `paperIDEAs/`
- if the local knowledge base already covers the relevant papers, do not restate the whole literature chain from scratch
- before proposing a new idea or code change, first check whether the local knowledge base already contains reusable operators, baselines, or reviewer concerns
- when returning results to the automation system, prioritize concise, traceable, evidence-based summaries instead of generic brainstorming

Core Workflow

Phase Goal Main outputs
Collect paper list Collect candidate papers from web pages or GitHub lists candidate list aligned with the local workflow
Paper analysis Download PDFs and convert them into structured analysis notes paperPDFs/, paperAnalysis/, analysis_log.csv
Build index Rebuild retrieval entries from analysis notes paperCollection/ organized by task, technique, and venue
Research assist Query, compare, generate ideas, run reviewer stress tests, and connect to code answers, tables, QuestionBank/, paperIDEAs/, implementation plans

Download belongs to the intake stage between collect and analysis, but from the repository perspective, the four steps above are the core mainline.

How Research Assist Works After build index

Once paperCollection/ is built, ResearchFlow is no longer just a paper archive directory.

Layer Main directories Role
Retrieval layer paperCollection/ Quickly find candidate papers by task, technique, and venue
Evidence layer paperAnalysis/ Provides structured depth such as operators, logic, links, and tags
Output layer QuestionBank/, paperIDEAs/, linked code repositories Turns knowledge into question lists, ideas, implementation plans, and code decisions

Based on the interaction of these three layers, several forms of research assist naturally emerge:

  • KB -> comparison decision: decide which operator, control mechanism, or training strategy is worth borrowing
  • KB -> question list: organize open problems, evaluation gaps, baseline gaps, and reviewer risks
  • KB -> idea generation: ground ideas in the literature network instead of generic brainstorming
  • KB -> reviewer simulation: run a strict challenge before project kickoff or writing
  • KB -> codebase linkage: retrieve paper evidence before modifying model, loss, network, control, or training code
  • KB -> multi-agent collaboration: let Claude Code, Codex CLI, and other agents share the same local research memory

Claude Code, Codex CLI, and Other Agents

Claude Code / Cursor

ResearchFlow ships with .claude/skills, so tools that support this convention can use skill routing directly.

Codex CLI

ResearchFlow also supports Codex CLI in two layers:

  • AGENTS.md is the stable Codex entry point for repo-level instructions
  • the actual reusable workflow definitions live in .claude/skills/
  • when a task matches a workflow, Codex should open the corresponding .claude/skills/<skill>/SKILL.md

This keeps one canonical skill library in normal tracked files, which works for GitHub clones, Windows setups without symlink support, and GitHub ZIP downloads.

Other AI Research Tools

Even without skill support, this repository still works directly as a local knowledge base:

  • start from paperCollection/ for coarse retrieval
  • enter paperAnalysis/ for detailed evidence
  • open paperPDFs/ when deeper verification is needed
  • write outputs into QuestionBank/, paperIDEAs/, or linked code repositories

Quick Start

git clone https://github.com/<your-username>/ResearchFlow.git
cd ResearchFlow

Optional Obsidian setup:

  1. Download the shared Obsidian package from Google Drive.
  2. Unzip it locally.
  3. Rename the extracted folder to .obsidian.
  4. Place that .obsidian folder at the repository root.

Optional code repository linkage:

ln -s /path/to/ResearchFlow ./ResearchFlow

One code repository can link one ResearchFlow, and multiple code repositories can share the same ResearchFlow.

Repository Structure

ResearchFlow/
├── AGENTS.md
├── LOGO.png
├── .claude/skills/
├── paperAnalysis/
│   └── analysis_log.csv
├── paperCollection/
├── paperPDFs/
├── QuestionBank/
├── paperIDEAs/
├── scripts/
└── obsidian setting/
  • paperCollection/ is the retrieval entry layer
  • paperAnalysis/ is the main knowledge layer
  • QuestionBank/ and paperIDEAs/ are downstream research output layers
  • scripts/ stores maintenance and automation utilities
  • .claude/skills/User_README.md and .claude/skills/User_README_ZN.md provide the quickest bilingual skill map

Notes

  • If analysis notes are added or modified, rebuild the index before using the knowledge base for broader research assistance
  • The main state flow in analysis_log.csv is Wait -> Downloaded -> checked, with Missing and Skip as side states
  • Obsidian is optional; the repository still works as a normal local folder for agents
  • For Codex, prefer AGENTS.md + .claude/skills/ over any symlink-based .agents/ mirror
  • The shared Obsidian package is public-safe and has had private workspace state and share tokens removed
  • If the extracted folder is named obsidian setting, rename it to .obsidian before placing it in the repository root

Skill Usage Details

How to invoke skills

  • Describe the task directly in natural language
  • Name the skill explicitly, such as papers-download-from-list
  • Use slash-style invocation, such as /papers-analyze-pdf

Recommended entry points

  • If you are unsure where to start, begin with research-workflow
  • For KB construction, the usual path is papers-collect-* -> papers-download-from-list -> papers-analyze-pdf -> papers-build-collection-index
  • For retrieval and design work, start from papers-query-knowledge-base or papers-compare-table
  • For ideation, use research-brainstorm-from-kb, research-question-bank, idea-focus-coach, or reviewer-stress-test
  • For code-grounded implementation, use code-context-paper-retrieval before editing model- or method-related code
  • For cross-domain adaptation of the full repository architecture, use domain-fork

Detailed skill references

  • .claude/skills/User_README.md: English user-facing skill selection guide
  • .claude/skills/User_README_ZN.md: Chinese user-facing skill selection guide
  • .claude/skills/README.md: compact skill map by workflow family
  • .claude/skills-config.json: registered skill descriptions and routing metadata

License

MIT

Yorumlar (0)

Sonuc bulunamadi