Wilma Skill
Overview
Wilma is the Finnish school information system used by schools and municipalities to share messages, news, exams, schedules, homework, and other student-related updates with parents/guardians.
Use the wilma / wilmai CLI in non-interactive mode to retrieve Wilma data for AI agents. Prefer --json outputs and avoid interactive prompts.
Quick start
Install
CODEBLOCK0
- 1. Ensure the user has run the interactive CLI once to create
~/.config/wilmai/config.json. - Use non-interactive commands with
--json.
Core tasks
Daily briefing (start here)
wilma summary --student <id|name> --json
wilma summary --all-students --json
Returns today's and tomorrow's schedule, upcoming exams, recent homework, recent news, and recent messages in one call. This is the best starting point for any parent-facing summary.
Schedule
wilma schedule list --when today --student <id|name> --json
wilma schedule list --when tomorrow --student <id|name> --json
wilma schedule list --when week --student <id|name> --json
wilma schedule list --date 2026-03-10 --student <id|name> --json
wilma schedule list --weekday thu --student <id|name> --json
--weekday also accepts Finnish short forms:
ma,
ti,
ke,
to,
pe,
la,
su. Use
--date or
--weekday, not both.
Homework
CODEBLOCK3
Upcoming exams
CODEBLOCK4
Exam grades
CODEBLOCK5
List students
CODEBLOCK6
News and messages
CODEBLOCK7
Fetch data for all students
All list commands support
--all-students:
CODEBLOCK8
You can also pass a name fragment for --student (fuzzy match).
MFA (Multi-Factor Authentication)
If the Wilma account has MFA/TOTP enabled:
Interactive setup (recommended): Run wilma interactively. When MFA is detected, choose "Save TOTP secret for automatic login" and paste your TOTP secret or otpauth:// URI. Future logins will auto-authenticate.
Non-interactive (one-off): Pass the TOTP secret directly:
wilma schedule list --totp-secret <base32-key> --student "Stella" --json
wilma schedule list --totp-secret 'otpauth://totp/...' --student "Stella" --json
If the TOTP secret has been saved via interactive setup,
--totp-secret is not needed — the CLI auto-authenticates from the stored config.
Notes
- - If no
--student is provided, the CLI uses the last selected student from ~/.config/wilmai/config.json (or $XDG_CONFIG_HOME/wilmai/config.json). - If multiple students exist and no default is set, the CLI will print a helpful error with the list of students.
- When the account has multiple students,
--student is required for read commands. - If auth expires or the CLI says no saved profile, re-run
wilma interactively or use wilma config clear to reset. - Run
wilma update to update the CLI to the latest version.
Actionability guidance (for parents)
Wilma contains a mix of urgent items and general info. When summarizing for parents, prioritize actionable items:
Include items that:
- - Require action or preparation (forms, replies, permissions, materials to bring).
- Announce a deadline or time-specific requirement.
- Describe a schedule deviation or noteworthy event (trips, themed days, school closures, exams).
- Mention homework, exams, or upcoming deadlines.
De-prioritize items that:
- - Are purely informational with no action, deadline, or schedule impact.
- Are generic announcements unrelated to the target period.
When in doubt, include and let the parent decide. Prefer a short, structured summary with dates and IDs.
Scripts
Use scripts/wilma-cli.sh for a stable wrapper around the CLI.
Links
- - GitHub: https://github.com/aikarjal/wilmai
- Website: https://wilm.ai
Wilma 技能
概述
Wilma 是芬兰学校信息系统，供学校和市政当局与家长/监护人分享消息、新闻、考试、课程表、家庭作业及其他与学生相关的更新信息。
使用 wilma / wilmai 命令行工具的非交互模式，为 AI 代理检索 Wilma 数据。优先使用 --json 输出，避免交互式提示。
快速开始
安装
bash
npm i -g @wilm-ai/wilma-cli
- 1. 确保用户已运行一次交互式 CLI，以创建 ~/.config/wilmai/config.json。
- 使用带 --json 的非交互命令。
核心任务
每日简报（从此处开始）
bash
wilma summary --student
--json
wilma summary --all-students --json
一次调用即可返回今天和明天的课程表、即将到来的考试、近期家庭作业、近期新闻和近期消息。这是面向家长的任何摘要的最佳起点。
课程表
bash
wilma schedule list --when today --student --json
wilma schedule list --when tomorrow --student --json
wilma schedule list --when week --student --json
wilma schedule list --date 2026-03-10 --student --json
wilma schedule list --weekday thu --student --json
--weekday 也接受芬兰语缩写形式：ma、ti、ke、to、pe、la、su。使用 --date 或 --weekday，不可同时使用。
家庭作业
bash
wilma homework list --student --json
即将到来的考试
bash
wilma exams list --student --json
考试成绩
bash
wilma grades list --student --json
列出学生
bash
wilma kids list --json
新闻和消息
bash
wilma news list --student --json
wilma news read --student --json
wilma messages list --student --folder inbox --json
wilma messages read --student --json
获取所有学生的数据
所有列表命令均支持 --all-students：
bash
wilma summary --all-students --json
wilma homework list --all-students --json
wilma exams list --all-students --json
您也可以为 --student 传递名称片段（模糊匹配）。
多因素认证
如果 Wilma 账户启用了 MFA/TOTP：
交互式设置（推荐）： 以交互方式运行 wilma。检测到 MFA 时，选择保存 TOTP 密钥以自动登录，然后粘贴您的 TOTP 密钥或 otpauth:// URI。后续登录将自动进行身份验证。
非交互式（一次性）： 直接传递 TOTP 密钥：
bash
wilma schedule list --totp-secret --student Stella --json
wilma schedule list --totp-secret otpauth://totp/... --student Stella --json
如果已通过交互式设置保存了 TOTP 密钥，则无需 --totp-secret——CLI 会从存储的配置中自动进行身份验证。
注意事项
- - 如果未提供 --student，CLI 将使用 ~/.config/wilmai/config.json（或 $XDGCONFIGHOME/wilmai/config.json）中最后选择的学生。
- 如果存在多个学生且未设置默认学生，CLI 将打印包含学生列表的有用错误信息。
- 当账户有多个学生时，读取命令必须使用 --student。
- 如果身份验证过期或 CLI 提示没有已保存的配置文件，请重新以交互方式运行 wilma，或使用 wilma config clear 重置。
- 运行 wilma update 将 CLI 更新至最新版本。
可操作指南（面向家长）
Wilma 包含紧急事项和一般信息。在为家长总结时，优先考虑可操作事项：
包含以下事项：
- - 需要操作或准备的事项（表格、回复、许可、需携带的材料）。
- 宣布截止日期或特定时间要求的事项。
- 描述课程表变更或值得注意的事件（旅行、主题日、学校停课、考试）。
- 提及家庭作业、考试或即将到来的截止日期。
降低优先级的事项：
- - 纯粹提供信息，无操作、截止日期或课程表影响的事项。
- 与目标时段无关的通用公告。
如有疑问，请包含，让家长自行决定。优先使用包含日期和 ID 的简短结构化摘要。
脚本
使用 scripts/wilma-cli.sh 作为 CLI 的稳定封装。
链接
- - GitHub： https://github.com/aikarjal/wilmai
- 网站： https://wilm.ai
