create-academic-research 0.1.0 → 0.1.1
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/README.md +19 -3
- package/dist/src/cli.js +11 -2
- package/dist/src/project.js +1 -1
- package/dist/src/stack.js +7 -2
- package/package.json +1 -1
- package/template/README.md +6 -0
- package/template/package.json +1 -1
package/README.md
CHANGED
|
@@ -41,7 +41,7 @@ specific target recognized by the `skills` CLI, such as `claude-code`,
|
|
|
41
41
|
By default, the wizard:
|
|
42
42
|
|
|
43
43
|
- creates the repository structure;
|
|
44
|
-
-
|
|
44
|
+
- installs the project-local `VincenzoImp/academic-research-skills` package;
|
|
45
45
|
- enables the scholarly MCP records for `arxiv`, `semantic-scholar`, and
|
|
46
46
|
`openalex`;
|
|
47
47
|
- writes `configs/capabilities.yaml`;
|
|
@@ -50,6 +50,10 @@ By default, the wizard:
|
|
|
50
50
|
- appends the onboarding event to `wiki/log.md`;
|
|
51
51
|
- does not install external MCP tools unless explicitly requested.
|
|
52
52
|
|
|
53
|
+
Use `--preset enhanced` when you also want the curated complementary external
|
|
54
|
+
skill bundles for agent engineering, frontend work, testing, document formats,
|
|
55
|
+
and PDF conversion.
|
|
56
|
+
|
|
53
57
|
## Non-Interactive Create
|
|
54
58
|
|
|
55
59
|
```bash
|
|
@@ -71,6 +75,7 @@ npx academic-research doctor
|
|
|
71
75
|
npx academic-research rename --title "New Title" --slug new-title --package new_title
|
|
72
76
|
npx academic-research skills presets
|
|
73
77
|
npx academic-research skills install --preset default
|
|
78
|
+
npx academic-research skills install --preset enhanced
|
|
74
79
|
npx academic-research skills list
|
|
75
80
|
npx academic-research skills status
|
|
76
81
|
npx academic-research skills remove source-ingestion
|
|
@@ -129,6 +134,17 @@ context. They are not automatic capabilities of every raw model API.
|
|
|
129
134
|
Use `--agent <agent>` for explicit multi-tool setup; reserve `--agent '*'` for
|
|
130
135
|
cases where you intentionally want every local agent loader populated.
|
|
131
136
|
|
|
137
|
+
Preset intent:
|
|
138
|
+
|
|
139
|
+
| Preset | Intent |
|
|
140
|
+
|---|---|
|
|
141
|
+
| `minimal` | Academic research skills only, no MCP records. |
|
|
142
|
+
| `default` | Academic research skills plus core scholarly MCP records. |
|
|
143
|
+
| `enhanced` | `default` plus curated external complementary skill bundles. |
|
|
144
|
+
| `literature` | SOTA and systematic-review work with citation-library MCP records. |
|
|
145
|
+
| `writing` | Paper-writing and Overleaf-oriented work. |
|
|
146
|
+
| `full` | Broad optional connector and specialist setup. |
|
|
147
|
+
|
|
132
148
|
## Validate This Package
|
|
133
149
|
|
|
134
150
|
```bash
|
|
@@ -145,8 +161,8 @@ Releases are tag-driven. Update `package.json` and `package-lock.json`, commit
|
|
|
145
161
|
the change, create `vX.Y.Z`, and push the tag:
|
|
146
162
|
|
|
147
163
|
```bash
|
|
148
|
-
git tag -a v0.1.
|
|
149
|
-
git push origin main v0.1.
|
|
164
|
+
git tag -a v0.1.1 -m "v0.1.1"
|
|
165
|
+
git push origin main v0.1.1
|
|
150
166
|
```
|
|
151
167
|
|
|
152
168
|
Once the GitHub repository is public, the release workflow validates the tag
|
package/dist/src/cli.js
CHANGED
|
@@ -36,7 +36,7 @@ async function createMain(argv) {
|
|
|
36
36
|
return 0;
|
|
37
37
|
}
|
|
38
38
|
if (!target) {
|
|
39
|
-
|
|
39
|
+
printMissingTargetHelp();
|
|
40
40
|
return 1;
|
|
41
41
|
}
|
|
42
42
|
if (flagBool(parsed.flags, "install-skills") && flagBool(parsed.flags, "no-install-skills")) {
|
|
@@ -394,7 +394,7 @@ function printCreateHelp() {
|
|
|
394
394
|
" --title <name> Project title. Default: title-cased project name.",
|
|
395
395
|
" --slug <name> Repository/package slug. Default: normalized project name.",
|
|
396
396
|
" --package <name> Python package name. Default: normalized project name.",
|
|
397
|
-
" --preset <name> Capability preset: minimal, default, literature, writing, full.",
|
|
397
|
+
" --preset <name> Capability preset: minimal, default, enhanced, literature, writing, full.",
|
|
398
398
|
" --profile <name> Project profile metadata. Default: academic-general.",
|
|
399
399
|
" --agent <name> Agent target. Default: auto-detect.",
|
|
400
400
|
" --install-skills Install project-local skills without prompting.",
|
|
@@ -404,6 +404,15 @@ function printCreateHelp() {
|
|
|
404
404
|
" -v, --version Show package version."
|
|
405
405
|
].join("\n"));
|
|
406
406
|
}
|
|
407
|
+
function printMissingTargetHelp() {
|
|
408
|
+
console.error([
|
|
409
|
+
"Please specify the project directory.",
|
|
410
|
+
"",
|
|
411
|
+
"Usage:",
|
|
412
|
+
" npm create academic-research@latest my-research-project",
|
|
413
|
+
" npx create-academic-research@latest my-research-project"
|
|
414
|
+
].join("\n"));
|
|
415
|
+
}
|
|
407
416
|
function printLifecycleHelp() {
|
|
408
417
|
console.log([
|
|
409
418
|
"Usage: academic-research <doctor|rename|skills|mcp>",
|
package/dist/src/project.js
CHANGED
|
@@ -205,7 +205,7 @@ async function writeGeneratedPackageJson(root, { slug }) {
|
|
|
205
205
|
const path = join(root, "package.json");
|
|
206
206
|
const data = await readJson(path);
|
|
207
207
|
const existingSpec = data.devDependencies?.["create-academic-research"];
|
|
208
|
-
const packageSpec = process.env.CREATE_ACADEMIC_RESEARCH_PACKAGE_SPEC ?? existingSpec ?? "^0.1.
|
|
208
|
+
const packageSpec = process.env.CREATE_ACADEMIC_RESEARCH_PACKAGE_SPEC ?? existingSpec ?? "^0.1.1";
|
|
209
209
|
data.name = slug;
|
|
210
210
|
data.devDependencies = {
|
|
211
211
|
...(data.devDependencies ?? {}),
|
package/dist/src/stack.js
CHANGED
|
@@ -56,12 +56,17 @@ export const AGENT_STACK = {
|
|
|
56
56
|
},
|
|
57
57
|
presets: {
|
|
58
58
|
minimal: {
|
|
59
|
-
description: "
|
|
59
|
+
description: "Academic research skills only, no MCP records.",
|
|
60
60
|
skill_bundles: ["academic_research"],
|
|
61
61
|
mcp_servers: []
|
|
62
62
|
},
|
|
63
63
|
default: {
|
|
64
|
-
description: "
|
|
64
|
+
description: "Clean academic research setup with core scholarly MCP records.",
|
|
65
|
+
skill_bundles: ["academic_research"],
|
|
66
|
+
mcp_servers: ["arxiv", "semantic-scholar", "openalex"]
|
|
67
|
+
},
|
|
68
|
+
enhanced: {
|
|
69
|
+
description: "Default academic setup plus complementary agent engineering, document, frontend, testing, and doc conversion skills.",
|
|
65
70
|
skill_bundles: ["academic_research", "default_complementary", "docling"],
|
|
66
71
|
mcp_servers: ["arxiv", "semantic-scholar", "openalex"]
|
|
67
72
|
},
|
package/package.json
CHANGED
package/template/README.md
CHANGED
|
@@ -53,6 +53,7 @@ Project-local skills and MCP records are managed with:
|
|
|
53
53
|
```bash
|
|
54
54
|
npx academic-research skills presets
|
|
55
55
|
npx academic-research skills install --preset default
|
|
56
|
+
npx academic-research skills install --preset enhanced
|
|
56
57
|
npx academic-research skills list
|
|
57
58
|
npx academic-research skills status
|
|
58
59
|
npx academic-research mcp enable arxiv semantic-scholar openalex
|
|
@@ -66,3 +67,8 @@ available install presets. `mcp enable` changes project records. `mcp commands`
|
|
|
66
67
|
prints external install commands without running them. `mcp install` runs
|
|
67
68
|
external tool installation commands and should be used only after reviewing the
|
|
68
69
|
selected MCP.
|
|
70
|
+
|
|
71
|
+
`default` installs the companion academic research skill package and keeps the
|
|
72
|
+
MCP records focused on core scholarly discovery. `enhanced` adds complementary
|
|
73
|
+
external skills for agent engineering, frontend work, testing, document
|
|
74
|
+
formats, and PDF conversion.
|