research
- Repo stars 1
- Author updated Live
- Author repo researchbuddy
- Domain
- Engineering
- Compatible agents
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- Trust score
- 88 / 100 · community maintained
- Author / version / license
- @willemave · no license declared
- Token usage
- Lean
- Setup complexity
- Guided setup
- External API key
- Required · Firecrawl
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No special requirements
- Permissions
-
- Read-only
- Write / modify
- Env read
- Network behavior
- External requests
- Install commands
- 26 variants
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: research
description: Use when a user asks to research something with ResearchBuddy, run web research or deep research…
category: engineering
runtime: no special runtime
---
# research output preview
## PART A: Task fit
- Use case: Use when a user asks to research something with ResearchBuddy, run web research or deep research, produce a source-backed answer, follow up on a saved research session, or install, validate, and troubleshoot the Homebrew-installed researchbuddy CLI. Covers research runs, current-run follow-up, runtime readiness checks, OpenClaw search config reuse, and dependency fixes on a target machine..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “Quick Start / Read These References As Needed / Operating Rules” and do not present inference as author intent.
## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “Use when a user asks to research something with ResearchBuddy, run web research or deep research, produce a source-backed answer, follow up on a saved research session, or install, validate, and troubleshoot the Homebrew-installed researchbuddy CLI. Covers research runs, current-run follow-up, runtime readiness checks, OpenClaw search config reuse, and dependency fixes on a target machine.”.
- **02** When the source has headings, the agent prioritizes “Quick Start / Read These References As Needed / Operating Rules” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files, read environment variables; may access external network resources; requires Firecrawl API keys.
## Running Rules
- read files, write/modify files, read environment variables; may access external network resources; requires Firecrawl API keys.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options. The source mentions slash commands such as `/path`; use them first when your agent supports command triggers.
Name target files or source material, expected output, forbidden changes, and whether network or shell access is allowed. Permission fingerprint: read files, write/modify files, read environment variables.
Start with a small task and check whether the result follows “Quick Start / Read These References As Needed / Operating Rules”. Inspect diffs, logs, previews, or tests before expanding scope.
Confirm the final output includes a concrete result, evidence, and next action. If it stays generic, tighten inputs, boundaries, and acceptance criteria.
---
name: research
description: Use when a user asks to research something with ResearchBuddy, run web research or deep research…
category: engineering
source: willemave/researchbuddy
---
# research
## When to use
- Use when a user asks to research something with ResearchBuddy, run web research or deep research, produce a source-bac…
- Use it when the task has clear inputs, repeatable steps, and validation criteria.
## What to provide
- Target material, scope, expected result, and forbidden changes.
- Whether network, commands, file writes, or external services are allowed.
## Execution rules
- Organize steps around “Quick Start / Read These References As Needed / Operating Rules” and keep inference separate from source facts.
- read files, write/modify files, read environment variables; may access external network resources; requires Firecrawl API keys.
- Validate with a small sample before expanding the task.
## Output requirements
- Return the deliverable, key evidence, validation method, and next action.
- Mark missing information as unknown; do not invent commands, platforms, or dependencies. The author source anchors workflow facts; repository files anchor sources and commands; Fluxly only adds fit, limitations, and quality judgment.
skill "research" {
input -> user goal + target files + boundaries + acceptance criteria
context -> Quick Start / Read These References As Needed / Operating Rules
rules -> SKILL.md triggers / order / output contract
runtime -> no special runtime | read files, write/modify files, read environment variables | may access external network resources
guardrails -> requires Firecrawl API keys + small-sample validation + diff/log review
output -> copyable result + checklist + next iteration
} Research
Use this skill when the task is about using ResearchBuddy for research, installing it with Homebrew, asking questions against saved sessions, or fixing a machine that fails runtime checks.
Quick Start
- Install with
brew tap willemave/researchbuddyandbrew install researchbuddyunless the user explicitly wants a source checkout. - Run
researchbuddy --helpto confirm the installed command surface. - For OpenClaw, install this skill with
researchbuddy skills install openclaw --scope shared, or use--scope workspace --workspace /path/to/workspacefor one workspace only. - In OpenClaw environments, inspect
~/.openclaw/openclaw.jsonbefore asking for search-provider credentials. If it already hasplugins.entries.<provider>.config.webSearch.apiKey, legacytools.web.search.<provider>.apiKey, ortools.web.search.apiKeyforexa,tavily, orfirecrawl, ask once whether ResearchBuddy should reuse it. - If the user approves reuse, do not ask them to paste a duplicate API key. Run
researchbuddy doctor --fix; ResearchBuddy auto-loads OpenClaw config and does not copy provider credentials into local.env. - If OpenClaw has no usable provider config, or the user declines reuse, ask for one provider key and set it through the runtime environment or local
.env, then rerunresearchbuddy doctor --fix. - Start long research jobs with
researchbuddy start "<prompt>" --json; the command returns immediately with the run ID, PID, status command, watch command, and log path. - Use
researchbuddy status,researchbuddy watch, andresearchbuddy followup "<question>"against the current run by default.
Read These References As Needed
- For every public command and option, read
references/commands.md. - For dependency failures and recovery steps, read
references/troubleshooting.md.
Operating Rules
- Prefer the Homebrew-installed
researchbuddycommand. Usescripts/researchbuddyonly inside a source checkout. - During first-time OpenClaw installs, prefer reusing the provider configured in
~/.openclaw/openclaw.jsonover asking the user for a freshEXA_API_KEY,TAVILY_API_KEY, orFIRECRAWL_API_KEY. - Do not copy OpenClaw secrets into skill files, chat logs, docs, command output, or ResearchBuddy
.env. Let ResearchBuddy load them directly from OpenClaw or Hermes. - Before debugging a broken runtime, run
researchbuddy doctor. - For long research work, use
researchbuddy start "<prompt>" --json; do not manually background a worker process. - Use
researchbuddy status --jsonwhen another agent or script needs machine-readable progress. - Use
researchbuddy watch --timeout 900when you need to stream the active worker log until completion. - ResearchBuddy currently ships cleanly as a packaged CLI, not a hosted web service.
- The runtime depends on the external
codexCLI. Ifdoctorfails oncodex, do not treat the environment as production-ready. - If
doctorfails onffmpeg, follow the OS-specific install steps inreferences/troubleshooting.md, verify withffmpeg -version, then rerunresearchbuddy doctor.
Public Commands
researchbuddy startresearchbuddy followupresearchbuddy statusresearchbuddy watchresearchbuddy doctorresearchbuddy skills install openclawresearchbuddy list
Read references/commands.md before using less-common options such as --prompt-file, --result-file, --output-dir, model overrides, --skip-playwright, or JSON output.
Config Model
- ResearchBuddy is env-driven. It reads process environment variables,
~/.hermes/.env,~/.openclaw/.env,~/.openclaw/openclaw.json, and local.env. - Shared agent configs are canonical for search-provider credentials; local
.envis only for manual fallback config. researchbuddy doctor --fixvalidates detected search-provider config, prepares storage/database, installs Playwright browsers, and repairs stale runs. It does not copy provider credentials into.env.- Homebrew installs should not edit files under the Homebrew prefix or uv cache for config.
Outputs
- Run artifacts are written under
~/.researchbuddy/storage/<run_id>/by default. - Key files are
synthesis.md,worker.log,run.log, and thehtml//markdown/crawl artifacts.
Decide Fit First
Design Intent
How To Use It
Boundaries And Review