- name
- research-report
- description
- Research technical projects/papers and generate comprehensive reports with PDF export. Modes: lite (analysis + writing) or full (+ environment setup + experiments). Params: iterations, mode, project-path, output. Use for paper analysis, code review, technical reports, research documentation.
- metadata
- {"openclaw": {"requires": {"bins": ["pandoc"]}, "primaryEnv": "", "emoji": "📝"}}
Research Report Generator
Analyze technical projects/papers and produce comprehensive reports with PDF export.
Modes
Lite Mode (default)
- Literature search + paper analysis
- Code reading (local or remote)
- Multi-iteration report writing
- PDF generation via md2pdf skill
- No environment setup or experiment runs
Full Mode
- Everything in lite mode +
- Conda/virtualenv setup
- Dependency installation
- Experiment execution
- Result analysis
Usage
bash {baseDir}/scripts/research-report.sh \
--topic "Spatial Forcing" \
--mode lite \
--iterations 3 \
--output bothParameters
| Parameter | Default | Description |
|---|---|---|
--topic | (required) | Paper/project name or arXiv ID |
--mode | lite | lite or full |
--iterations | 3 | Report revision iterations |
--output | both | md, pdf, or both |
--project-path | (auto) | Local code directory (optional) |
--workspace | (current) | Workspace directory |
Workflow
Phase 1: Discovery
- Search arXiv + project pages
- Fetch related papers (citations + references)
- Identify key technologies and dependencies
Phase 2: Analysis
- Read source code (if
--project-pathprovided) - Analyze architecture from docs/code
- Map technology stack
Phase 3: Report Writing (× iterations)
- Draft outline
- Write sections iteratively
- Add diagrams (Mermaid/ASCII)
- Refine explanations
Phase 4: Export (Full mode only)
- Setup conda env
- Install dependencies
- Run experiments
- Append results to report
Phase 5: PDF Generation
- Call md2pdf skill
- Send to user via Telegram
Output Structure
<workspace>/
├── reports/
│ ├── <topic>_report_v1.md
│ ├── <topic>_report_v2.md
│ ├── <topic>_report_final.md
│ └── <topic>_report_final.pdf
├── memory/YYYY-MM-DD.md (appended)
└── logs/<topic>_research.logReport Template
The generated report follows this structure:
- Executive Summary - 100-word overview
- Motivation - Problem statement + why it matters
- Background - Prerequisites explained intuitively
- Core Method - Technical details with analogies
- Code Analysis - Key files walkthrough
- Experiments - Setup + results (full mode)
- Troubleshooting - Common issues + fixes
- References - Papers + repos + docs
Dependencies
Required:
- pandoc (for PDF export)
- texlive-xetex (CJK + math support)
Full mode only:
- conda/miniconda
- CUDA toolkit (if GPU experiments)
Integration
This skill automatically:
- Uses
md2pdfskill for PDF conversion - Appends to
memory/YYYY-MM-DD.md - Creates structured report directory
Examples
Lite mode, 5 iterations:
research-report --topic "VGGT" --iterations 5 --mode liteFull mode with local code:
research-report --topic "Spatial Forcing" \
--project-path ~/Spatial-Forcing/openvla-SF \
--mode full \
--iterations 3PDF only output:
research-report --topic "OpenVLA" --output pdfTroubleshooting
| Issue | Fix |
|---|---|
| PDF generation fails | Check pandoc --version, install texlive-xetex |
| CJK characters missing | Install fonts-noto-cjk, verify with fc-list :lang=zh |
| Math formulas not rendered | Ensure markdown uses $...$ / $$...$$ syntax |
| Full mode conda fails | Run conda update -n base conda first |