Onboarding Wizard

A single interactive CLI flow collects your identity, your LLM of choice, and your bot token — and writes them to disk in the right places.

Run the wizard

bash

studentsync onboard

You can re-run this anytime. It detects existing values and lets you overwrite them individually.

The prompts

Field	Purpose	Stored in
`rollNumber`	Printed in the footer of every generated PDF.	`scholar.json`
`name`	Your full name on the cover page.	`scholar.json`
`university`	Institution name + auto-picked branding.	`scholar.json`
`llm.provider`	One of openai · gemini · openrouter · ollama.	`scholar.json`
`llm.apiKey`	The secret used to talk to the provider.	`.env`
`telegramBotToken`	From `@BotFather`.	`.env`
`googleClient`	OAuth client for Classroom + Drive.	`.env` + token at `.config/google.json`

Files it writes

~/.config/scholar.json — non-secret configuration (identity, chosen model, formatting preferences).
~/.env — secrets. Never commit this.
~/.config/google.json — the OAuth refresh token, created after the browser-based Google consent flow.

~/.config/scholar.json

{
  "identity": {
    "rollNumber": "21BCE1234",
    "name": "Ayush Vish",
    "university": "VIT Chennai"
  },
  "llm": {
    "provider": "gemini",
    "model": "gemini-1.5-pro",
    "temperature": 0.3
  },
  "formatting": {
    "freezeTheme": "dracula",
    "pdfFont": "Computer Modern"
  }
}

Keep your .env private

The auto-installer enforces chmod 600 on ~/.env. If you install from source, do it yourself.

PreviousLocal Development Next LLM Providers