StudentSync

Quick Install

The 1-minute path — pulls the latest release, configures PM2, and boots Scuba on your machine.

If you just want it to work, run the auto-installer. It installs thestudentsync global binary, sets up PM2 as the process manager, and registers the daemon so it survives reboots.

Run it

bash
curl -sSL https://raw.githubusercontent.com/Ayush-Vish/studentsync/main/install.sh | bash

What this script does

The installer uses sudo for npm -gonly. It never touches your shell profile without printing a diff first. Inspect the script by opening the URL in your browser before piping it to bash if you'd like.

What you get

  • Global CLI: studentsync available in your shell.
  • PM2 daemon: process name student-daemon, auto-restart on boot.
  • Persistent config: written to ~/.config/scholar.json.

First run

After the install completes, kick off the onboarding wizard to supply your identity, pick an LLM, and register your Telegram bot:

bash
studentsync onboard

Manage the daemon

bash
pm2 logs student-daemon     # follow live logs + LLM traces
pm2 restart student-daemon  # after config changes
pm2 stop student-daemon     # pause the bot
pm2 save                    # persist across reboots
Need to tweak behaviour without re-running onboarding? Edit ~/.config/scholar.json directly and pm2 restart student-daemon.

Next

Head to Telegram Bot Setup to create your bot, or jump to Google Classroom Integration to wire up auto-submit.

PreviousIntroductionNext npm Global Install