research

Engineering Community

Repo stars 1
Author repo researchbuddy

Interpretation is structured for decision-making; original keeps the upstream SKILL.md unchanged.

Decide Fit First

Core job: Use when a user asks to research something with ResearchBuddy, run web research or deep research, produce a source-backed answer…
Best fit: Use it when the task has reusable inputs, steps, and validation criteria rather than a one-off answer.
Avoid forcing it: If the source lacks commands, platform support, or external-service evidence, keep those fields unknown instead of guessing.

Design Intent

Structure: The skill is organized around “Quick Start”, “Read These References As Needed”, “Operating Rules”, “Public Commands”, showing how the author expects the agent to judge fit, collect context, and produce verifiable output.
Trigger evidence: Prioritize the author’s wording around when to use it, what context to collect, and what output shape to produce.
Evidence boundary: Author text states facts, repository files prove commands and paths, and Fluxly only adds fit, limits, and usage judgment.

How To Use It

Inputs: Provide target material, scope, expected result, forbidden changes, and validation method.
Invocation: Name research directly; if the source includes slash commands, start with the command and then add task context.
Validation: Start small and check whether the result follows “Quick Start / Read These References As Needed / Operating Rules” before expanding.

Boundaries And Review

Dependencies: Prepare Firecrawl API keys before running a full task.
Permissions: Declared permissions include read / write / env-read; ask the agent to state file, command, and rollback boundaries before acting.
Quality bar: A useful result names the deliverable, evidence, and next action. Generic prose means the task needs tighter context.

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/researchbuddy and brew install researchbuddy unless the user explicitly wants a source checkout.
Run researchbuddy --help to confirm the installed command surface.
For OpenClaw, install this skill with researchbuddy skills install openclaw --scope shared, or use --scope workspace --workspace /path/to/workspace for one workspace only.
In OpenClaw environments, inspect ~/.openclaw/openclaw.json before asking for search-provider credentials. If it already has plugins.entries.<provider>.config.webSearch.apiKey, legacy tools.web.search.<provider>.apiKey, or tools.web.search.apiKey for exa, tavily, or firecrawl, 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 rerun researchbuddy 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, and researchbuddy 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 researchbuddy command. Use scripts/researchbuddy only inside a source checkout.
During first-time OpenClaw installs, prefer reusing the provider configured in ~/.openclaw/openclaw.json over asking the user for a fresh EXA_API_KEY, TAVILY_API_KEY, or FIRECRAWL_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 --json when another agent or script needs machine-readable progress.
Use researchbuddy watch --timeout 900 when 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 codex CLI. If doctor fails on codex, do not treat the environment as production-ready.
If doctor fails on ffmpeg, follow the OS-specific install steps in references/troubleshooting.md, verify with ffmpeg -version, then rerun researchbuddy doctor.

Public Commands

researchbuddy start
researchbuddy followup
researchbuddy status
researchbuddy watch
researchbuddy doctor
researchbuddy skills install openclaw
researchbuddy 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 .env is only for manual fallback config.
researchbuddy doctor --fix validates 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 the html/ / markdown/ crawl artifacts.

Fluxly profile Author and license come from source; runtime, permissions, and network are Fluxly detections or estimates

Fluxly category: Engineering
Author-declared agents: No explicit declaration found; this is not inferred or tested compatibility
Static check: 88 / 100 · heuristic scan, not runtime safety proof
Author / version / license: @willemave · no license declared
Fluxly token estimate: Lean
Fluxly setup estimate: Guided setup
External API key: Required · Firecrawl
Detected OS requirements: Unspecified
Runtime requirements: Unspecified
Detected file/system behavior: Read-only
Write / modify
Env read
Detected network behavior: External requests
Install commands: None (reference only)

Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.

Heads up: 未限定 allowed-tools，默认拥有全部工具权限。

Output preview research-504afd6c19.preview

The current SKILL.md does not define a fixed output example.

SKILL.md SKILL.md

# 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

1. Install with `brew tap willemave/researchbuddy` and `brew install researchbuddy` unless the user explicitly wants a source checkout.
2. Run `researchbuddy --help` to confirm the installed command surface.
3. For OpenClaw, install this skill with `researchbuddy skills install openclaw --scope shared`, or use `--scope workspace --workspace /path/to/workspace` for one workspace only.
4. In OpenClaw environments, inspect `~/.openclaw/openclaw.json` before asking for search-provider credentials. If it already has `plugins.entries.<provider>.config.webSearch.apiKey`, legacy `tools.web.search.<provider>.apiKey`, or `tools.web.search.apiKey` for `exa`, `tavily`, or `firecrawl`, ask once whether ResearchBuddy should reuse it.
5. 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`.
6. 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 rerun `researchbuddy doctor --fix`.
7. 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.
8. Use `researchbuddy status`, `researchbuddy watch`, and `researchbuddy followup "<question>"` against the current run by default.

## Read These References As Needed

- For every public command and option, read `references/commands.md`.

…

Evidence boundary and execution chain

Author text anchors workflow facts; Fluxly only indexes current sections, terms, files, and commands.

sections -> Quick Start → Read These References As Needed → Operating Rules → Public Commands → Config Model → Outputs
terms    -> 1. Install with brew tap willemave/researchbuddy and brew install researchbuddy unless the user explicitly wants a source checkout. · - For every public command and option, read references/commands.md. · - Prefer the Homebrew-installed researchbuddy command. · - ResearchBuddy is env-driven. · - Run artifacts are written under ~/.researchbuddy/storage/<runid>/ by default.
files/cmd -> brew tap willemave/researchbuddy · brew install researchbuddy · researchbuddy --help · researchbuddy skills install openclaw --scope shared · --scope workspace --workspace /path/to/workspace · ~/.openclaw/openclaw.json · plugins.entries.<provider>.config.webSearch.apiKey · tools.web.search.<provider>.apiKey
body sha256 -> f6bcbc17d6ae