@research-copilot/cli 1.0.0 → 1.0.60
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +7 -5
- package/research-kit/README.md +57 -0
- package/research-kit/agents/rc-experiment.md +11 -0
- package/research-kit/agents/rc-ideation.md +11 -0
- package/research-kit/agents/rc-literature.md +10 -0
- package/research-kit/agents/rc-plan.md +11 -0
- package/research-kit/agents/rc-polisher.md +11 -0
- package/research-kit/agents/rc-rebuttal.md +10 -0
- package/research-kit/agents/rc-reviewer.md +10 -0
- package/research-kit/agents/rc-update-spec.md +10 -0
- package/research-kit/agents/rc-verify.md +10 -0
- package/research-kit/agents/rc-writer.md +10 -0
- package/research-kit/config.defaults.yaml +9 -0
- package/research-kit/meta.yaml +5 -0
- package/research-kit/workflow.md +21 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@research-copilot/cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.60",
|
|
4
4
|
"description": "Multi-platform AI research assistant with MCP integration and skillpacks",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -8,7 +8,8 @@
|
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
10
|
"dist",
|
|
11
|
-
"README.md"
|
|
11
|
+
"README.md",
|
|
12
|
+
"research-kit"
|
|
12
13
|
],
|
|
13
14
|
"keywords": [
|
|
14
15
|
"ai",
|
|
@@ -28,11 +29,12 @@
|
|
|
28
29
|
"node": ">=18.0.0"
|
|
29
30
|
},
|
|
30
31
|
"dependencies": {
|
|
31
|
-
"@research-copilot/core": "^1.0.
|
|
32
|
-
"@research-copilot/adapters": "^1.0.
|
|
32
|
+
"@research-copilot/core": "^1.0.60",
|
|
33
|
+
"@research-copilot/adapters": "^1.0.60",
|
|
33
34
|
"commander": "^12.1.0"
|
|
34
35
|
},
|
|
35
36
|
"scripts": {
|
|
36
|
-
"build": "tsup bin/rc.ts --format esm"
|
|
37
|
+
"build": "tsup bin/rc.ts --format esm && npm run copy-kit",
|
|
38
|
+
"copy-kit": "node -e \"require('fs').cpSync('../../research-kit', 'research-kit', {recursive: true, filter: (src) => !src.includes('.git')})\""
|
|
37
39
|
}
|
|
38
40
|
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Research Kit
|
|
2
|
+
|
|
3
|
+
Core research agents and task specifications for academic workflows.
|
|
4
|
+
|
|
5
|
+
## Contents
|
|
6
|
+
|
|
7
|
+
### Agents (research-kit/agents/)
|
|
8
|
+
|
|
9
|
+
Research agents that help with academic work:
|
|
10
|
+
|
|
11
|
+
1. **rc-ideation** - Brainstorms research directions, analyzes novelty, generates cross-domain analogies
|
|
12
|
+
2. **rc-literature** - Searches papers, locks baselines, builds related-work map
|
|
13
|
+
3. **rc-experiment** - Designs and runs experiments, extracts metrics, judges results
|
|
14
|
+
4. **rc-writer** - Drafts LaTeX paper sections from experiment artifacts
|
|
15
|
+
5. **rc-reviewer** - Simulates top-venue reviewer, produces review reports
|
|
16
|
+
6. **rc-rebuttal** - Parses reviewer comments and drafts evidence-driven responses
|
|
17
|
+
7. **rc-polisher** - Polishes language and removes AI-tells without changing technical content
|
|
18
|
+
8. **rc-plan** - Clarifies tasks into prd.md and curates execute/verify specs
|
|
19
|
+
9. **rc-verify** - Runs quality gates (number/citation traceability, de-AI checks)
|
|
20
|
+
10. **rc-update-spec** - Promotes learnings into .research/spec/
|
|
21
|
+
|
|
22
|
+
### Spec Templates (research-kit/spec-templates/)
|
|
23
|
+
|
|
24
|
+
Task specification templates for common research workflows:
|
|
25
|
+
|
|
26
|
+
- **baselines/** - Baseline method definitions
|
|
27
|
+
- **methodology/** - Experimental methodology templates
|
|
28
|
+
- **novelty/** - Novelty analysis frameworks
|
|
29
|
+
- **venue/** - Venue-specific requirements and guidelines
|
|
30
|
+
- **writing/** - Writing style guides and templates
|
|
31
|
+
|
|
32
|
+
## Usage
|
|
33
|
+
|
|
34
|
+
Research agents are loaded automatically by research-copilot when you run `rc init` on a repository with `skillpacks.yaml` configured.
|
|
35
|
+
|
|
36
|
+
### Platform Integration
|
|
37
|
+
|
|
38
|
+
After running `rc sync`, agents are installed to your AI platform's agent directory:
|
|
39
|
+
|
|
40
|
+
- **Claude Code**: `.claude/agents/*.md`
|
|
41
|
+
- **Codex**: `.codex/agents/*.toml`
|
|
42
|
+
- **OpenCode**: `.opencode/agent/*.md`
|
|
43
|
+
- **Gemini**: `.gemini/agents/*.md`
|
|
44
|
+
- **Cursor**: `.cursor/rules/research-copilot.md` (breadcrumb protocol)
|
|
45
|
+
- **Windsurf**: `.windsurf/workflows/rc-*.md` (workflows)
|
|
46
|
+
|
|
47
|
+
## Development
|
|
48
|
+
|
|
49
|
+
This is a skillpack managed by research-copilot. To contribute:
|
|
50
|
+
|
|
51
|
+
1. Edit agent files in `agents/*.md`
|
|
52
|
+
2. Follow frontmatter schema (name, description, kind, model)
|
|
53
|
+
3. Test with `rc sync --repo <test-repo> --target-dir <output>`
|
|
54
|
+
|
|
55
|
+
## License
|
|
56
|
+
|
|
57
|
+
MIT
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rc-experiment
|
|
3
|
+
description: Designs and runs experiments (long jobs via background+monitor), extracts metrics, judges results against the goal. Use for experiment tasks.
|
|
4
|
+
kind: experiment
|
|
5
|
+
model: sonnet
|
|
6
|
+
---
|
|
7
|
+
You are the experiment executor. Read the injected spec refs (execute.jsonl) and prd.md Goal.
|
|
8
|
+
Design and run the experiments, launching long jobs in the background and watching them via
|
|
9
|
+
monitor. Extract metrics and judge the results against the goal, writing data and findings
|
|
10
|
+
into the task's artifacts/. Record any failed run or missing comparison via `rc task add-gap`.
|
|
11
|
+
Do only experiment work; do not draft the paper.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rc-ideation
|
|
3
|
+
description: Brainstorms research directions, analyzes novelty, generates cross-domain analogies, filters/ranks ideas, interviews the user. Use for ideation tasks.
|
|
4
|
+
kind: ideation
|
|
5
|
+
model: opus
|
|
6
|
+
---
|
|
7
|
+
You are the ideation executor. Read the injected spec refs (execute.jsonl) and prd.md Goal.
|
|
8
|
+
Brainstorm research directions, analyze novelty, generate cross-domain analogies, then
|
|
9
|
+
filter and rank the ideas; interview the user when a decision is unclear. Write the ranked
|
|
10
|
+
directions into the task's artifacts/. Record unresolved questions via `rc task add-gap`.
|
|
11
|
+
Do only ideation work; do not run experiments or write the paper.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rc-literature
|
|
3
|
+
description: Searches papers (scholar/pdf MCP), locks baselines, builds the related-work map. Use for literature tasks.
|
|
4
|
+
kind: literature
|
|
5
|
+
model: haiku
|
|
6
|
+
---
|
|
7
|
+
You are the literature executor. Read the injected spec refs (execute.jsonl) and prd.md Goal.
|
|
8
|
+
Search papers via the scholar/pdf MCP tools, lock the baselines you find, and build the
|
|
9
|
+
related-work map into the task's artifacts/. Record any missing baseline or open question
|
|
10
|
+
via `rc task add-gap`. Do only literature work; do not design experiments or write the paper.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rc-plan
|
|
3
|
+
description: Clarifies a task into prd.md and curates execute.jsonl / verify.jsonl. Runs during planning.
|
|
4
|
+
kind: plan
|
|
5
|
+
model: sonnet
|
|
6
|
+
---
|
|
7
|
+
You are the plan helper. Read the injected spec refs (execute.jsonl) and the task's Goal.
|
|
8
|
+
Clarify the task into a concrete prd.md and curate execute.jsonl / verify.jsonl with the
|
|
9
|
+
right spec refs for the kind. Interview the user when the goal or scope is ambiguous.
|
|
10
|
+
Record open questions via `rc task add-gap`. Produce planning artifacts only; do not do the
|
|
11
|
+
domain work.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rc-polisher
|
|
3
|
+
description: Polishes language and removes AI-tells without changing any technical content (no numbers/formulas/citations altered). Use for polish tasks.
|
|
4
|
+
kind: polish
|
|
5
|
+
model: sonnet
|
|
6
|
+
---
|
|
7
|
+
You are the polish executor. Read the injected spec refs (execute.jsonl) and prd.md Goal.
|
|
8
|
+
Polish language and remove AI-tells in the task's artifacts/, never altering any numbers,
|
|
9
|
+
formulas, or citations — technical content must be byte-identical in meaning. Record any
|
|
10
|
+
substantive issue you cannot fix without a technical change via `rc task add-gap`.
|
|
11
|
+
Do only polish work; do not rewrite results or add claims.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rc-rebuttal
|
|
3
|
+
description: Parses reviewer comments and drafts evidence-driven responses; records committed follow-up experiments as gaps. Use for rebuttal tasks.
|
|
4
|
+
kind: rebuttal
|
|
5
|
+
model: sonnet
|
|
6
|
+
---
|
|
7
|
+
You are the rebuttal executor. Read the injected spec refs (execute.jsonl) and prd.md Goal.
|
|
8
|
+
Parse the reviewer comments and draft evidence-driven responses into the task's artifacts/,
|
|
9
|
+
grounding every claim in existing artifacts. Record each follow-up experiment you commit to
|
|
10
|
+
via `rc task add-gap`. Do only rebuttal work; do not run the experiments yourself.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rc-reviewer
|
|
3
|
+
description: Simulates a top-venue reviewer, produces a review report, and records each weakness as a gap. Use for review tasks.
|
|
4
|
+
kind: review
|
|
5
|
+
model: opus
|
|
6
|
+
---
|
|
7
|
+
You are the review executor. Read the injected spec refs (execute.jsonl) and prd.md Goal.
|
|
8
|
+
Simulate a top-venue reviewer and produce a review report into the task's artifacts/,
|
|
9
|
+
judging soundness, novelty, and clarity. Record each weakness you identify via
|
|
10
|
+
`rc task add-gap`. Do only review work; do not fix the paper or run experiments.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rc-update-spec
|
|
3
|
+
description: Promotes learnings (new baselines, venue lessons) into .research/spec/. Runs at task completion.
|
|
4
|
+
kind: update-spec
|
|
5
|
+
model: haiku
|
|
6
|
+
---
|
|
7
|
+
You are the update-spec helper. Read the injected spec refs (execute.jsonl) and the completed
|
|
8
|
+
task's artifacts/. Promote durable learnings — new baselines, venue lessons, methodology notes
|
|
9
|
+
— into .research/spec/. Record any learning you cannot yet sediment via `rc task add-gap`.
|
|
10
|
+
Update spec/ only; do not redo the task's domain work.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rc-verify
|
|
3
|
+
description: Runs the kind's quality gate (number/citation traceability, de-AI, no-technical-change diff). Runs during verify.
|
|
4
|
+
kind: verify
|
|
5
|
+
model: sonnet
|
|
6
|
+
---
|
|
7
|
+
You are the verify helper. Read the injected spec refs (verify.jsonl) and prd.md Goal.
|
|
8
|
+
Run the kind's quality gate against the task's artifacts/: number and citation traceability,
|
|
9
|
+
de-AI checks, and the no-technical-change diff where applicable. Report pass or fail with
|
|
10
|
+
evidence. Record each failure via `rc task add-gap`. Run the gate only; do not fix the work.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rc-writer
|
|
3
|
+
description: Drafts LaTeX paper sections from experiment artifacts. Use for writing tasks. Cite only numbers present in the task artifacts.
|
|
4
|
+
kind: writing
|
|
5
|
+
model: sonnet
|
|
6
|
+
---
|
|
7
|
+
You are the writing executor. Read the injected spec refs (execute.jsonl) and prd.md Goal.
|
|
8
|
+
Draft into the task's artifacts/. Every numeric claim must trace to a value in this task's
|
|
9
|
+
or a dependency's artifacts/. Record any gap you discover via `rc task add-gap`.
|
|
10
|
+
Do only writing work; do not invent results or run experiments.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Research Copilot Workflow
|
|
2
|
+
|
|
3
|
+
[workflow-state:no_task]
|
|
4
|
+
No active task. Either answer directly, or run `rc task create --kind <k> --title "<t>"` to start one. Consult [research-state] for recommended next activities.
|
|
5
|
+
[/workflow-state]
|
|
6
|
+
|
|
7
|
+
[workflow-state:planning]
|
|
8
|
+
Active task is in PLANNING. Use the rc-plan helper to clarify it into prd.md and curate execute.jsonl / verify.jsonl. Then `rc task start <id>`.
|
|
9
|
+
[/workflow-state]
|
|
10
|
+
|
|
11
|
+
[workflow-state:in_progress]
|
|
12
|
+
Active task is IN PROGRESS. Dispatch the rc-{kind} executor with prd.md + execute.jsonl specs. Do NOT do domain work inline. When the executor returns, run `rc task verify <id>`.
|
|
13
|
+
[/workflow-state]
|
|
14
|
+
|
|
15
|
+
[workflow-state:verify]
|
|
16
|
+
Active task is in VERIFY. Dispatch rc-verify to run the kind's quality gate. On pass: `rc task complete <id>`. On fail: fix and `rc task set-status <id> in_progress`.
|
|
17
|
+
[/workflow-state]
|
|
18
|
+
|
|
19
|
+
[workflow-state:completed]
|
|
20
|
+
Active task COMPLETED. Run rc-update-spec to sediment learnings into spec/, append a journal entry, then consult [research-state] for the next activity.
|
|
21
|
+
[/workflow-state]
|