CLI Reference
Every command StudentSync ships with — both the shell CLI and the Telegram bot commands.
Shell commands
| Command | Description |
|---|---|
studentsync onboard | Interactive wizard to set up identity, LLM provider, Telegram and Google. |
studentsync | Start the bot in foreground mode. Logs to stdout. |
npm run start:daemon | From source: build + pm2 start. |
npm run stop:daemon | From source: pm2 stop + delete. |
pm2 logs student-daemon | Follow live logs + LLM traces when running under PM2. |
studentsync portals add | Save credentials for a Moodle/Canvas/custom portal. |
studentsync resume history <name> | Browse previous tailored versions of a resume template. |
studentsync doctor | Environment + integration health check. Prints which providers are reachable and which tokens are valid. |
Telegram bot commands
| Command | Description |
|---|---|
/start | Welcome + onboarding for first-time users. |
/solve | Solve an assignment from text, PDF, or image. |
/submit | Upload and turn in the last generated artifact. |
/resume <template> <jd> | Tailor a resume template to a job description. |
/status | What Scuba is currently working on. |
/cancel | Abort the in-flight task. |
/model <provider>/<model> | Switch LLM provider per-chat. |
Environment variables
bash
# coreTELEGRAM_BOT_TOKEN=xxxx# llm — pick oneOPENAI_API_KEY=sk-...GEMINI_API_KEY=...OPENROUTER_API_KEY=...# google (optional)GOOGLE_CLIENT_ID=...GOOGLE_CLIENT_SECRET=...# tuningSTUDENTSYNC_LOG_LEVEL=info # debug|info|warn|errorSTUDENTSYNC_DATA_DIR=~/.studentsyncShell completion
Enable zsh/bash completion with
studentsync completion >> ~/.zshrc.Exit codes
The CLI follows conventional exit codes — 0 on success, 1 on generic failure, 2 on misuse, 3 on auth errors, 4 on network errors.