@wilm-ai/wilma-cli
v1.4.2
Published
Command line interface for Wilma (Finnish school system), built for parents and AI agents.
Readme
@wilm-ai/wilma-cli
Command line interface for Wilma (Finnish school system), built for parents and AI agents.
Install
npm i -g @wilm-ai/wilma-cli
# or
pnpm add -g @wilm-ai/wilma-cliRun
wilma
# or
wilmaiCommands
Daily briefing
wilma summary [--days 7] [--student <id|name>] [--all-students] [--json]Combines today's and tomorrow's schedule, upcoming exams, recent homework, news, and messages into one view. Designed for AI agents to surface what matters.
Schedule
wilma schedule list [--when today|tomorrow|week] [--date YYYY-MM-DD] [--weekday mon|tue|wed|thu|fri|sat|sun] [--student <id|name>] [--all-students] [--json]Examples:
# Specific day by date
wilma schedule list --date 2026-02-25 --student "Stella" --json
# Next Thursday (also accepts Finnish short forms like to/ke/pe)
wilma schedule list --weekday thu --student "Stella" --json
# Tomorrow
wilma schedule list --when tomorrow --student "Stella" --jsonHomework
wilma homework list [--limit 10] [--student <id|name>] [--all-students] [--json]Upcoming exams
wilma exams list [--limit 20] [--student <id|name>] [--all-students] [--json]Exam grades
wilma grades list [--limit 20] [--student <id|name>] [--all-students] [--json]News and messages
wilma news list [--limit 20] [--student <id|name>] [--all-students] [--json]
wilma news read <id> [--student <id|name>] [--json]
wilma messages list [--folder inbox] [--limit 20] [--student <id|name>] [--all-students] [--json]
wilma messages read <id> [--student <id|name>] [--json]Other
wilma kids list [--json]
wilma update
wilma config clearMFA (Multi-Factor Authentication)
If your Wilma account has MFA/TOTP enabled:
Interactive (recommended): Run wilma and choose "Save TOTP secret for automatic login" when prompted. Paste your base32 key or otpauth:// URI from your authenticator app. Future logins auto-authenticate.
Non-interactive: Pass the secret directly:
wilma schedule list --totp-secret <base32-key> --json
wilma schedule list --totp-secret 'otpauth://totp/...' --jsonIf you've saved your TOTP secret via interactive setup, --totp-secret is not needed.
Config
Local config is stored in ~/.config/wilmai/config.json (or $XDG_CONFIG_HOME/wilmai/config.json).
Use wilma config clear to remove it. Override with WILMAI_CONFIG_PATH.
Notes
- Credentials and TOTP secrets are stored with lightweight obfuscation for convenience.
- For multi-child accounts, you can pass
--student <id|name>or--all-students. - All list commands support
--jsonfor agent-friendly structured output.
