npm Global Install

Install StudentSync directly from npm as a global binary. Recommended if you already manage your own process supervisor.

Install

bash

npm install -g studentsync

This adds the studentsync binary to your globalnpm bin directory (usually /usr/local/bin on macOS / Linux).

bash

studentsync onboard

The wizard writes .env and .config/scholar.json to your home directory. See Onboarding Wizard for the full list of prompts.

Useful when you want to watch logs flow in real time, or while debugging a new LLM provider:

bash

studentsync

The recommended way to keep StudentSync up 24/7:

bash

npm install -g pm2
pm2 start studentsync --name student-daemon
pm2 save
pm2 startup   # generates the OS-level startup hook

On Windows, use pm2-windows-startup instead of pm2 startup.

bash

npm install -g studentsync@latest
pm2 restart student-daemon

Release cadence

Releases are cut automatically from main on every tagged commit via GitHub Actions with NPM provenance.