Skip to content

SpannDaMan/sumscript-obsidian-plugin

Repository files navigation

SumScript (Obsidian Plugin)

SumScript is a transcript-first YouTube research plugin for Obsidian.

For one YouTube URL at a time, it:

  • captures source metadata
  • attempts transcript extraction with explicit status
  • generates adaptive key takeaways
  • generates fallback summary only when transcript is unavailable
  • computes related-note suggestions from a local embedding index
  • supports review actions: accept, reject, postpone

Commands

  • Analyze YouTube Link (SumScript)
  • Review Related Note Suggestions (SumScript)
  • Reset SumScript Local Index

Local Development

cd "C:\Users\Raspa\Agent Smith Projects\sumscript-obsidian-plugin"
npm install
npm run check
npm run build

Manual Install (Immediate Use)

Use your vault path in place of <VAULT>.

$repo = "C:\Users\Raspa\Agent Smith Projects\sumscript-obsidian-plugin"
$pluginDir = "<VAULT>\\.obsidian\\plugins\\sumscript"
New-Item -ItemType Directory -Force -Path $pluginDir | Out-Null
Copy-Item "$repo\\manifest.json" "$pluginDir\\manifest.json" -Force
Copy-Item "$repo\\main.js" "$pluginDir\\main.js" -Force
Copy-Item "$repo\\styles.css" "$pluginDir\\styles.css" -Force

Then in Obsidian:

  1. Open Settings -> Community plugins.
  2. Turn off Safe mode if needed.
  3. Enable SumScript.
  4. Open a note and run Analyze YouTube Link (SumScript) from command palette.

One-Command Local Install

cd "C:\Users\Raspa\Agent Smith Projects\sumscript-obsidian-plugin"
npm run build
powershell -ExecutionPolicy Bypass -File ".\scripts\install-local.ps1" -VaultPath "C:\Users\Raspa\Agent Smith Projects\sumscript-dev-vault"

Manual Update Workflow

cd "C:\Users\Raspa\Agent Smith Projects\sumscript-obsidian-plugin"
npm run check
npm run build

$pluginDir = "<VAULT>\\.obsidian\\plugins\\sumscript"
Copy-Item ".\\manifest.json" "$pluginDir\\manifest.json" -Force
Copy-Item ".\\main.js" "$pluginDir\\main.js" -Force
Copy-Item ".\\styles.css" "$pluginDir\\styles.css" -Force

Reload Obsidian or disable/enable SumScript.

OpenAI Fallback Defaults

  • Fallback mode default: openai-compatible
  • Default model: gpt-5.4
  • Base URL default: https://api.openai.com/v1/chat/completions
  • API key is configured in plugin settings and stored in Obsidian plugin data.

Notes

  • Baseline metadata + transcript path does not require OpenAI.
  • Fallback summary is used only when transcript is unavailable or failed.
  • Target-note edits are off by default and require explicit setting toggle.

About

SumScript Obsidian plugin: transcript-first YouTube research notes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors