latinium-cli is a command-line interface designed to interact with the Navigium learning platform. It provides a convenient way to manage your learning process directly from your terminal, offering functionalities for authentication, managing vocabulary "boxes," training, word lookups, and viewing account statistics.
- Authentication: Securely log in and out of your Navigium account.
- Account Statistics: View your personal learning statistics and rankings.
- Box Management: Create, remove, and list your learning boxes.
- Vocabulary Training: Start training sessions with various configurable options.
- Word Lookup: Quickly look up vocabulary words.
This project uses bun as its package manager. Make sure you have bun installed on your system.
git clone https://github.com/ls-root/latinium.git
cd latinium-cli
bun installThe main executable for the CLI is cli.ts. You can run it using bun.
Log in to your Navigium account:
bun cli.ts auth <username> <password> [school]
bun cli.ts auth <username> <password> --permanentLog out from your Navigium account:
bun cli.ts logoutView your learning statistics:
bun cli.ts statsView your ranking table:
bun cli.ts stats --rankingList all your learning boxes:
bun cli.ts boxesView details of a specific box (and optionally filter by subject/fach):
bun cli.ts boxes <box-name> [fach-name]Create a new learning box:
bun cli.ts boxes:create <new-box-name>Remove an existing learning box:
bun cli.ts boxes:remove <box-name-to-remove>
# Alias:
bun cli.ts boxes:rm <box-name-to-remove>Start a training session for a specific box:
bun cli.ts train <box-name>Training with advanced options:
bun cli.ts train <box-name> -a
bun cli.ts train <box-name> -d LAT_DT
bun cli.ts train <box-name> -o all
bun cli.ts train <box-name> -e
bun cli.ts train <box-name> -gLook up the definition of a vocabulary word:
bun cli.ts lookup <word-to-lookup>
# Example: bun cli.ts lookup "amicus"