Telegram Bot Setup

Create a bot with BotFather, drop the token into StudentSync, and open your first chat.

1. Create the bot

  • Open Telegram and search @BotFather.
  • Send /newbot.
  • Give it a name (e.g. My StudentSync) and a username that ends in bot (e.g. ayush_studentsync_bot).
  • BotFather replies with an HTTP API token. Copy it.

2. Configure StudentSync

bash
studentsync onboard --telegram

Paste the token when prompted. It's written to ~/.env:

bash
TELEGRAM_BOT_TOKEN=1234567890:ABC-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

3. Start the daemon

bash
pm2 restart student-daemon

4. Verify

  • Open your bot's chat (the username you picked).
  • Send /start.
  • Scuba responds with the onboarding wizard for first-time users.

Recommended BotFather settings

Enable Inline Mode, and set a bot description + profile pic so your chat list doesn't look like 1999. Also set a command menu so you get autocomplete:
bash
# paste into BotFather's /setcommands
start - show welcome + onboarding
solve - solve an assignment from text, pdf or image
submit - upload & turn in the last artifact
resume - tailor your resume for a job
status - what scuba is currently working on

Multi-user mode

By default the bot only responds to the Telegram user ID who onboarded it. To allow more users (e.g. classmates), add their numeric IDs to scholar.json:

json
{
"telegram": {
"allowedUserIds": [123456789, 987654321]
}
}