Installation

Last modified: 13/02/2026

Option 1 — BRAT (recommended)

1. Install BRAT from Obsidian Community Plugins.
2. In BRAT settings, add ctrlaltwill/Sprout.
3. BRAT installs Sprout and keeps it updated.

Option 2 — Download a release

1. Open Releases and download the latest release.

2. Copy main.js, styles.css, and manifest.json into:

   <Your Vault>/.obsidian/plugins/sprout/

3. Restart Obsidian, then enable Sprout in Settings → Community Plugins.

Option 3 — Build from source

Requires Node.js 18+.

git clone https://github.com/ctrlaltwill/Sprout.git
cd Sprout
npm install
npm run build

The built plugin files are output to dist/. Copy or symlink that folder into your vault:

ln -s "$(pwd)/dist" "<Your Vault>/.obsidian/plugins/sprout"

Restart Obsidian → Settings → Community Plugins → Enable Sprout.

Development scripts

Script	What it does
npm run dev	Watch mode — rebuilds JS + CSS on every file change
npm run build	Production build (minified JS + CSS), copies manifest into dist/