@thuanphan2208/paper-pilot 1.0.0 → 1.0.2

package/README.md

@@ -1,2 +1,127 @@
-# Claude_Skills-for-Research
-A collection of Claude Code skills for writing CS/IT research papers — from brainstorming to draft. Includes teach + write skills for every section (Introduction, Related Work, Methodology, Experiments, Results, Conclusion, Abstract), with a complete phishing detection demo paper.
+# paper-pilot
+
+> Claude Code skills for writing research papers — from brainstorming to final draft.  
+> Works across all academic majors. Supports LaTeX, Word, and Markdown.
+
+## Quick Start
+
+Make sure you have [Claude Code](https://claude.ai/code) installed, then run:
+
+```bash
+npx @thuanphan2208/paper-pilot init
+```
+
+That's it. Open the project in Claude Code and start with:
+
+```
+/paper:explore
+```
+
+---
+
+## What Gets Installed
+
+```
+your-project/
+├── .claude/
+│   ├── commands/paper/     ← /paper:explore, plan, teach, write, review
+│   └── skills/             ← 17 skill files
+└── paper/
+    ├── sections/           ← your drafts go here
+    └── notes/
+```
+
+---
+
+## The Writing Flow
+
+```
+/paper:explore              Find your topic and research gap
+      ↓
+/paper:plan                 Plan structure, generate outline
+      ↓
+/paper:teach <section>      Learn how to write each section
+      ↓
+/paper:write <section>      Draft with guided Q&A
+      ↓
+/paper:review <section>     Get reviewer-style feedback
+```
+
+### Sections supported
+
+`intro` · `related` · `method` · `experiment` · `results` · `conclusion` · `abstract`
+
+> Write **abstract last** — it summarizes everything else.
+
+---
+
+## Paper Types Supported
+
+| Type | What it is |
+|------|-----------|
+| `empirical` | Runs experiments, collects data, compares methods |
+| `review` | Surveys and synthesizes existing literature |
+| `theoretical` | Proposes a framework, model, or theory |
+| `mixed` | Combines empirical work with theoretical framing |
+
+---
+
+## Writing Formats Supported
+
+| Format | How to write |
+|--------|-------------|
+| `latex` | Overleaf or `.tex` files |
+| `word` | Microsoft Word or Google Docs |
+| `markdown` | Obsidian, Notion, Pandoc |
+
+Set your format once during `/paper:plan` — all sections will use it automatically.
+
+---
+
+## Requirements
+
+- [Claude Code](https://claude.ai/code) installed
+- Node.js ≥ 18
+
+---
+
+## Install Options
+
+**One-time use (recommended):**
+```bash
+npx @thuanphan2208/paper-pilot init
+```
+
+**Global install:**
+```bash
+npm install -g @thuanphan2208/paper-pilot
+paper-pilot init
+```
+
+**Preview what will be installed:**
+```bash
+npx @thuanphan2208/paper-pilot init --dry-run
+```
+
+---
+
+## Updating to the Latest Version
+
+If you installed via **global install**:
+```bash
+npm install -g @thuanphan2208/paper-pilot@latest
+paper-pilot init
+```
+
+If you used **npx**:
+```bash
+npx @thuanphan2208/paper-pilot@latest init
+```
+
+> `init` uses a merge strategy — it only adds new or updated files, never overwrites your existing `paper/` drafts or `context.yaml`.
+
+---
+
+## License
+
+MIT

package/bin/cli.js

@@ -1,46 +1,46 @@
-#!/usr/bin/env node
-'use strict';
-
-const { init } = require('../src/init');
-
-const args = process.argv.slice(2);
-const command = args[0];
-const flags = args.slice(1);
-const dryRun = flags.includes('--dry-run');
-
-const BOLD = '\x1b[1m';
-const RESET = '\x1b[0m';
-
-switch (command) {
-  case 'init':
-    init({ dryRun });
-    break;
-
-  case '--version':
-  case '-v': {
-    const pkg = require('../package.json');
-    console.log(pkg.version);
-    break;
-  }
-
-  case '--help':
-  case '-h':
-  case undefined:
-    console.log(`
-${BOLD}paper-pilot${RESET} — Install Claude Code paper-writing skills into your project
-
-Usage:
-  npx paper-pilot init           Install skills into current directory
-  npx paper-pilot init --dry-run Preview what would be installed
-  npx paper-pilot --version      Show version
-  npx paper-pilot --help         Show this help
-
-After init, open Claude Code and run /paper:explore to get started.
-`);
-    break;
-
-  default:
-    console.error(`Unknown command: ${command}`);
-    console.error('Run "npx paper-pilot --help" for usage.');
-    process.exit(1);
-}
+#!/usr/bin/env node
+'use strict';
+
+const { init } = require('../src/init');
+
+const args = process.argv.slice(2);
+const command = args[0];
+const flags = args.slice(1);
+const dryRun = flags.includes('--dry-run');
+
+const BOLD = '\x1b[1m';
+const RESET = '\x1b[0m';
+
+switch (command) {
+  case 'init':
+    init({ dryRun });
+    break;
+
+  case '--version':
+  case '-v': {
+    const pkg = require('../package.json');
+    console.log(pkg.version);
+    break;
+  }
+
+  case '--help':
+  case '-h':
+  case undefined:
+    console.log(`
+${BOLD}paper-pilot${RESET} — Install Claude Code paper-writing skills into your project
+
+Usage:
+  npx paper-pilot init           Install skills into current directory
+  npx paper-pilot init --dry-run Preview what would be installed
+  npx paper-pilot --version      Show version
+  npx paper-pilot --help         Show this help
+
+After init, open Claude Code and run /paper:explore to get started.
+`);
+    break;
+
+  default:
+    console.error(`Unknown command: ${command}`);
+    console.error('Run "npx paper-pilot --help" for usage.');
+    process.exit(1);
+}

package/package.json

@@ -1,29 +1,36 @@
-{
-  "name": "@thuanphan2208/paper-pilot",
-  "version": "1.0.0",
-  "description": "Install Claude Code paper-writing skills into any project with one command.",
-  "keywords": ["claude", "claude-code", "research", "paper", "skills", "academic"],
-  "homepage": "https://github.com/ThuanPne/Claude_Skills-for-Research",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ThuanPne/Claude_Skills-for-Research.git"
-  },
-  "license": "MIT",
-  "bin": {
-    "paper-pilot": "./bin/cli.js"
-  },
-  "files": [
-    "bin/",
-    "src/",
-    ".claude/"
-  ],
-  "scripts": {
-    "test": "node bin/cli.js init --dry-run"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  }
-}
+{
+  "name": "@thuanphan2208/paper-pilot",
+  "version": "1.0.2",
+  "description": "Install Claude Code paper-writing skills into any project with one command.",
+  "keywords": [
+    "claude",
+    "claude-code",
+    "research",
+    "paper",
+    "skills",
+    "academic"
+  ],
+  "homepage": "https://github.com/ThuanPne/Claude_Skills-for-Research",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ThuanPne/Claude_Skills-for-Research.git"
+  },
+  "license": "MIT",
+  "bin": {
+    "paper-pilot": "./bin/cli.js"
+  },
+  "files": [
+    "bin/",
+    "src/",
+    ".claude/"
+  ],
+  "scripts": {
+    "test": "node bin/cli.js init --dry-run"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/init.js

@@ -1,111 +1,111 @@
-const fs = require('fs');
-const path = require('path');
-
-const GREEN = '\x1b[32m';
-const YELLOW = '\x1b[33m';
-const CYAN = '\x1b[36m';
-const BOLD = '\x1b[1m';
-const RESET = '\x1b[0m';
-
-function log(msg) { process.stdout.write(msg + '\n'); }
-function success(msg) { log(`${GREEN}✓${RESET} ${msg}`); }
-function skip(msg) { log(`${YELLOW}─${RESET} ${msg} (already exists, skipped)`); }
-function info(msg) { log(`${CYAN}  ${msg}${RESET}`); }
-
-function copyDirMerge(src, dest, dryRun = false) {
-  const entries = fs.readdirSync(src, { withFileTypes: true });
-  let copied = 0;
-  let skipped = 0;
-
-  for (const entry of entries) {
-    const srcPath = path.join(src, entry.name);
-    const destPath = path.join(dest, entry.name);
-
-    if (entry.isDirectory()) {
-      if (!dryRun && !fs.existsSync(destPath)) {
-        fs.mkdirSync(destPath, { recursive: true });
-      }
-      const result = copyDirMerge(srcPath, destPath, dryRun);
-      copied += result.copied;
-      skipped += result.skipped;
-    } else {
-      if (fs.existsSync(destPath)) {
-        skip(path.relative(process.cwd(), destPath));
-        skipped++;
-      } else {
-        if (!dryRun) {
-          fs.mkdirSync(dest, { recursive: true });
-          fs.copyFileSync(srcPath, destPath);
-        }
-        success(path.relative(process.cwd(), destPath));
-        copied++;
-      }
-    }
-  }
-
-  return { copied, skipped };
-}
-
-function ensureDir(dirPath, dryRun = false) {
-  if (fs.existsSync(dirPath)) {
-    skip(path.relative(process.cwd(), dirPath) + '/');
-  } else {
-    if (!dryRun) fs.mkdirSync(dirPath, { recursive: true });
-    success(path.relative(process.cwd(), dirPath) + '/');
-  }
-}
-
-function init({ dryRun = false } = {}) {
-  const packageRoot = path.join(__dirname, '..');
-  const destRoot = process.cwd();
-
-  log('');
-  log(`${BOLD}paper-pilot init${RESET}${dryRun ? ' (dry run)' : ''}`);
-  log('─'.repeat(50));
-
-  // 1. Copy .claude/ (skills + commands)
-  const claudeSrc = path.join(packageRoot, '.claude');
-  const claudeDest = path.join(destRoot, '.claude');
-
-  if (!fs.existsSync(claudeSrc)) {
-    log(`\x1b[31mError: .claude/ not found in package. Reinstall paper-pilot.\x1b[0m`);
-    process.exit(1);
-  }
-
-  log(`\nInstalling skills into ${CYAN}.claude/${RESET}`);
-  const { copied, skipped } = copyDirMerge(claudeSrc, claudeDest, dryRun);
-
-  // 2. Create paper/sections/ directory
-  log(`\nCreating paper workspace`);
-  ensureDir(path.join(destRoot, 'paper'), dryRun);
-  ensureDir(path.join(destRoot, 'paper', 'sections'), dryRun);
-
-  // 3. Create paper/notes/.gitkeep if not present
-  const notesDir = path.join(destRoot, 'paper', 'notes');
-  const notesKeep = path.join(notesDir, '.gitkeep');
-  if (!fs.existsSync(notesKeep)) {
-    if (!dryRun) {
-      fs.mkdirSync(notesDir, { recursive: true });
-      fs.writeFileSync(notesKeep, '');
-    }
-    success('paper/notes/');
-  } else {
-    skip('paper/notes/');
-  }
-
-  // 4. Summary
-  log('');
-  log('─'.repeat(50));
-  log(`${copied} file(s) installed, ${skipped} skipped`);
-  log('');
-  log(`${BOLD}You're ready! Open Claude Code and run:${RESET}`);
-  log('');
-  info('/paper:explore   ← find your research topic');
-  info('/paper:plan      ← plan your paper structure');
-  info('/paper:teach     ← learn how to write each section');
-  info('/paper:write     ← draft each section with AI guidance');
-  info('/paper:review    ← get feedback on your drafts');
-  log('');
-}
-
-module.exports = { init };
+const fs = require('fs');
+const path = require('path');
+
+const GREEN = '\x1b[32m';
+const YELLOW = '\x1b[33m';
+const CYAN = '\x1b[36m';
+const BOLD = '\x1b[1m';
+const RESET = '\x1b[0m';
+
+function log(msg) { process.stdout.write(msg + '\n'); }
+function success(msg) { log(`${GREEN}✓${RESET} ${msg}`); }
+function skip(msg) { log(`${YELLOW}─${RESET} ${msg} (already exists, skipped)`); }
+function info(msg) { log(`${CYAN}  ${msg}${RESET}`); }
+
+function copyDirMerge(src, dest, dryRun = false) {
+  const entries = fs.readdirSync(src, { withFileTypes: true });
+  let copied = 0;
+  let skipped = 0;
+
+  for (const entry of entries) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      if (!dryRun && !fs.existsSync(destPath)) {
+        fs.mkdirSync(destPath, { recursive: true });
+      }
+      const result = copyDirMerge(srcPath, destPath, dryRun);
+      copied += result.copied;
+      skipped += result.skipped;
+    } else {
+      if (fs.existsSync(destPath)) {
+        skip(path.relative(process.cwd(), destPath));
+        skipped++;
+      } else {
+        if (!dryRun) {
+          fs.mkdirSync(dest, { recursive: true });
+          fs.copyFileSync(srcPath, destPath);
+        }
+        success(path.relative(process.cwd(), destPath));
+        copied++;
+      }
+    }
+  }
+
+  return { copied, skipped };
+}
+
+function ensureDir(dirPath, dryRun = false) {
+  if (fs.existsSync(dirPath)) {
+    skip(path.relative(process.cwd(), dirPath) + '/');
+  } else {
+    if (!dryRun) fs.mkdirSync(dirPath, { recursive: true });
+    success(path.relative(process.cwd(), dirPath) + '/');
+  }
+}
+
+function init({ dryRun = false } = {}) {
+  const packageRoot = path.join(__dirname, '..');
+  const destRoot = process.cwd();
+
+  log('');
+  log(`${BOLD}paper-pilot init${RESET}${dryRun ? ' (dry run)' : ''}`);
+  log('─'.repeat(50));
+
+  // 1. Copy .claude/ (skills + commands)
+  const claudeSrc = path.join(packageRoot, '.claude');
+  const claudeDest = path.join(destRoot, '.claude');
+
+  if (!fs.existsSync(claudeSrc)) {
+    log(`\x1b[31mError: .claude/ not found in package. Reinstall paper-pilot.\x1b[0m`);
+    process.exit(1);
+  }
+
+  log(`\nInstalling skills into ${CYAN}.claude/${RESET}`);
+  const { copied, skipped } = copyDirMerge(claudeSrc, claudeDest, dryRun);
+
+  // 2. Create paper/sections/ directory
+  log(`\nCreating paper workspace`);
+  ensureDir(path.join(destRoot, 'paper'), dryRun);
+  ensureDir(path.join(destRoot, 'paper', 'sections'), dryRun);
+
+  // 3. Create paper/notes/.gitkeep if not present
+  const notesDir = path.join(destRoot, 'paper', 'notes');
+  const notesKeep = path.join(notesDir, '.gitkeep');
+  if (!fs.existsSync(notesKeep)) {
+    if (!dryRun) {
+      fs.mkdirSync(notesDir, { recursive: true });
+      fs.writeFileSync(notesKeep, '');
+    }
+    success('paper/notes/');
+  } else {
+    skip('paper/notes/');
+  }
+
+  // 4. Summary
+  log('');
+  log('─'.repeat(50));
+  log(`${copied} file(s) installed, ${skipped} skipped`);
+  log('');
+  log(`${BOLD}You're ready! Open Claude Code and run:${RESET}`);
+  log('');
+  info('/paper:explore   ← find your research topic');
+  info('/paper:plan      ← plan your paper structure');
+  info('/paper:teach     ← learn how to write each section');
+  info('/paper:write     ← draft each section with AI guidance');
+  info('/paper:review    ← get feedback on your drafts');
+  log('');
+}
+
+module.exports = { init };