PaperSpine

https://github.com/wubing2023/paperspine
Admin
PaperSpine is a contribution-first, reviewer-aware academic paper and report writing system for...
Tokens:105,425
Snippets:1,751
Trust Score:7.5
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install PaperSpine on Windows

Source: https://github.com/wubing2023/paperspine/blob/main/README.en.md

Use PowerShell to clone the repository and execute the installation script.

```powershell
git clone https://github.com/WUBING2023/PaperSpine.git
cd PaperSpine
.\install.ps1
```

--------------------------------

### Install PaperSpine on macOS or Linux

Source: https://github.com/wubing2023/paperspine/blob/main/README.en.md

Use Bash to clone the repository and execute the installation script.

```bash
git clone https://github.com/WUBING2023/PaperSpine.git
cd PaperSpine
bash install.sh
```

--------------------------------

### Manual installation commands

Source: https://github.com/wubing2023/paperspine/blob/main/README.en.md

Commands for performing a clean manual installation of PaperSpine.

```powershell
powershell -File install.ps1 -CleanLegacy
```

```bash
bash install.sh --clean-legacy
```

--------------------------------

### Launch Intake Wizard

Source: https://github.com/wubing2023/paperspine/blob/main/dist/claude/skills/paper-spine/references/intake.md

Executes the interactive intake wizard to generate the required configuration files in the specified output directory.

```bash
python scripts/intake_wizard.py --output-dir paper_rewriting_output
```

--------------------------------

### Launch Configuration Wizard

Source: https://github.com/wubing2023/paperspine/blob/main/README.en.md

Manually trigger the Python intake wizard if the configuration file is missing.

```powershell
python src/scripts/intake_wizard.py
```

--------------------------------

### Install PaperSpine Plugin

Source: https://github.com/wubing2023/paperspine/blob/main/README.en.md

Commands to add and install the PaperSpine plugin within the Claude Code environment.

```text
/plugin marketplace add https://github.com/WUBING2023/PaperSpine
/plugin install paper-spine
/reload-plugins
```

--------------------------------

### Update PaperSpine

Source: https://github.com/wubing2023/paperspine/blob/main/README.en.md

Commands for updating or checking the status of the local PaperSpine installation.

```powershell
python src/scripts/paperspine_update.py --yes
```

```powershell
python src/scripts/paperspine_update.py --check-only
```

--------------------------------

### Launch PaperSpine on Windows

Source: https://github.com/wubing2023/paperspine/blob/main/dist/claude/commands/paperspine.md

Checks for the configuration file and launches the PowerShell intake UI if missing. It waits up to 10 minutes for the configuration to be generated.

```powershell
$config = Join-Path (Get-Location) "paper_rewriting_output\paper_spine_config.json"
$launcher = Join-Path $env:USERPROFILE ".claude\skills\paper-spine\scripts\launch_paperspine_ui.ps1"
if (-not (Test-Path -LiteralPath $launcher)) {
  throw "PaperSpine UI launcher not found at $launcher. Reinstall or resync PaperSpine."
}
if (-not (Test-Path -LiteralPath $config)) {
  powershell.exe -NoProfile -ExecutionPolicy Bypass -File $launcher -OutputDir "paper_rewriting_output"
}
for ($i = 0; $i -lt 120 -and -not (Test-Path -LiteralPath $config); $i++) {
  Start-Sleep -Seconds 5
}
if (-not (Test-Path -LiteralPath $config)) {
  throw "PaperSpine intake config was not created yet. Finish the opened PowerShell UI window, then rerun /paperspine."
}
Get-Content -LiteralPath $config -Raw
```

--------------------------------

### Run Intake Gate Check

Source: https://github.com/wubing2023/paperspine/blob/main/dist/claude/skills/paper-spine/SKILL.md

Verify the intake configuration stage.

```bash
python scripts/progress_check.py paper_rewriting_output --gate intake
```

--------------------------------

### Clean legacy PaperSpine installations

Source: https://github.com/wubing2023/paperspine/blob/main/README.en.md

Remove old folders and worker copies that may cause conflicts.

```powershell
.\install.ps1 -CleanLegacy
```

```bash
bash install.sh --clean-legacy
```

--------------------------------

### Run Planning Gate Check

Source: https://github.com/wubing2023/paperspine/blob/main/dist/claude/skills/paper-spine/SKILL.md

Verify the writing/drafting planning stage.

```bash
python scripts/progress_check.py paper_rewriting_output --gate planning
```

--------------------------------

### Write progress report

Source: https://github.com/wubing2023/paperspine/blob/main/dist/openclaw/skills/paper-spine/references/resume.md

Generate the authoritative resume map file.

```bash
progress_check.py --write
```

--------------------------------

### Launch PaperSpine UI on macOS/Linux

Source: https://github.com/wubing2023/paperspine/blob/main/dist/codex/prompts/paperspine.md

Locates and executes the shell launcher script to generate the required configuration file.

```bash
CONFIG="paper_rewriting_output/paper_spine_config.json"
LAUNCHER="$HOME/.codex/skills/paper-spine/scripts/launch_paperspine_ui.sh"
[ -f "$LAUNCHER" ] || LAUNCHER="$HOME/.claude/skills/paper-spine/scripts/launch_paperspine_ui.sh"
if [ ! -f "$LAUNCHER" ]; then
  echo "PaperSpine UI launcher not found. Reinstall or resync PaperSpine." >&2; exit 1
fi
if [ ! -f "$CONFIG" ]; then
  chmod +x "$LAUNCHER"; bash "$LAUNCHER" "paper_rewriting_output"
fi
for i in $(seq 1 120); do [ -f "$CONFIG" ] && break; sleep 5; done
if [ ! -f "$CONFIG" ]; then
  echo "PaperSpine intake config not created yet. Finish the opened terminal, then rerun /paperspine." >&2; exit 1
fi
cat "$CONFIG"
```

--------------------------------

### Launch PaperSpine on macOS/Linux

Source: https://github.com/wubing2023/paperspine/blob/main/dist/claude/commands/paperspine.md

Checks for the configuration file and executes the shell script intake UI if missing. It polls for the configuration file for up to 10 minutes.

```bash
CONFIG="paper_rewriting_output/paper_spine_config.json"
LAUNCHER="$HOME/.claude/skills/paper-spine/scripts/launch_paperspine_ui.sh"

if [ ! -f "$LAUNCHER" ]; then
  echo "PaperSpine UI launcher not found at $LAUNCHER. Reinstall or resync PaperSpine." >&2
  exit 1
fi

if [ ! -f "$CONFIG" ]; then
  chmod +x "$LAUNCHER"
  bash "$LAUNCHER" "paper_rewriting_output"
fi

for i in $(seq 1 120); do
  if [ -f "$CONFIG" ]; then break; fi
  sleep 5
done

if [ ! -f "$CONFIG" ]; then
  echo "PaperSpine intake config was not created yet. Finish the opened terminal window, then rerun /paperspine." >&2
  exit 1
fi

cat "$CONFIG"
```

--------------------------------

### Run Motivation Confirmation Gate Check

Source: https://github.com/wubing2023/paperspine/blob/main/dist/claude/skills/paper-spine/SKILL.md

Verify the motivation confirmation stage.

```bash
python scripts/progress_check.py paper_rewriting_output --gate motivation_confirmation
```

--------------------------------

### Run Reference Inventory Script

Source: https://github.com/wubing2023/paperspine/blob/main/README.en.md

Executes the reference inventory script to index materials from the current directory into the specified output folder.

```powershell
python src/scripts/reference_inventory.py . --output-dir paper_rewriting_output --mode local_first
```

--------------------------------

### Run Translation Guard

Source: https://github.com/wubing2023/paperspine/blob/main/dist/claude/skills/paper-spine/references/audit.md

Verify the quality and completeness of the Chinese translation package.

```bash
python scripts/translate_guard.py paper_rewriting_output --markdown --write
```

--------------------------------

### Run Material Inventory Script

Source: https://github.com/wubing2023/paperspine/blob/main/dist/claude/skills/paper-spine/references/build.md

Executes the material inventory script to generate the source inventory before making claims.

```bash
python scripts/material_inventory.py <materials_dir> --output-dir paper_rewriting_output
```
Tokens:
Raw