webuntis-cli is a simple command-line interface (CLI) to interact with WebUntis, allowing you to fetch your timetable, absences and more directly from your terminal. It gets data straight from WebUntis's JSON RPC API thanks to this wrapper.

• Fetch your timetable for today, tomorrow and the entire week.
• View your absent, current, and next lessons.
• An easy to use, instructed and prompted setup.
• A nice dashboard to see some stats and information.

webuntis-cli is made using oclif which allows you to package your CLI tools directly into installers. If you want to download webuntis-cli, please head to the Releases tab and download it for your platform..

After installing webuntis-cli, try running webuntis setup!

Below is a quick to-do list with all the features that currently are in the cli, and ones that I plan to add soon.

• Basic commands for viewing your timetable
  • View your timetable for today, tomorrow & the entire weekweek
  • View your timetable for a specific day
• View your absences
  • Filter your absent days through a start aswell as a enddate
  • View an exact list of all your absent days, teacher that marked you as absent, lessons that you were absent in...
• Basic Dashboard
  • Make the dashboard more 'about-you', include more information and not just 'basic' stuff like your current timetable (?)
• Teacher / Subject specific Commands
• Theming maybe?

Please make sure that you have npm & git installed, aswell node.js 18+ (I recommend LTS). Make sure you have ave oclif installed as well, or install it using npm ci in the step below.

git clone https://github.com/roschreiber/webuntis-cli.git

cd webuntis-cli
npm cii

Oclif has a premade script for building the CLI.

npm run build

If your build succeeded and you want to package & create a installer, oclif has a command for that aswell.ell.

oclif pack [PLATFORM]

[PLATFORM] being deb, win, macos or tarballs.

I am not affiliated with Untis GmbH nor with WebUntis API. Use this at your own risk.