08 Jamf School

Jamf School

Use this path when you manage an iOS/iPadOS fleet through Jamf School and want workbook reporting from jamf-cli school data. A connected School profile and a collect are what fill the workbook; a Jamf School device CSV export on its own does not add sheets yet.

It produces a standalone Jamf School workbook with sheets for device inventory, OS versions, device status, stale devices, overview, device groups, users, classes, apps, profiles, and locations, all generated by the native Swift engine.

Prerequisites

Install jamf-cli (v1.18.0 or later, v1.19.0+ recommended; the project tracks v1.31.1 — see Installation). Connect a Jamf School profile from the app — during onboarding choose the Jamf School product, or add it later from the Sources screen. The app runs jamf-cli school setup for you and wires school_cli.enabled/profile into config.yaml.

The relevant config.yaml section (the app manages it):

school_cli:
  enabled: false          # true when using live jamf-cli school commands
  profile: "school"       # must match the jamf-cli school profile

School snapshots are stored under jamf_cli.data_dir with the rest of the workspace's data.

Setting up a School-only workspace

On the app's first-launch Welcome chooser, click Connect Jamf School. This runs a dedicated Jamf School onboarding path — Welcome, Install CLI, Workspace, CSV mapping, Connect School, First report — that skips the Jamf Pro Authenticate, Validate, and Add-products steps entirely. The Connect School step registers a jamf-cli school profile (School URL + Network ID + API key, passed over stdin and cleared) and wires school_cli.enabled/profile into the workspace config, so the first report and every later collect route to the Jamf School engine. jamf-cli must still be installed to pass the Install CLI step (a free Homebrew binary, no server access needed), but you never enter Jamf Pro credentials.

Jamf School support ships community-validated — the maintainer has no Jamf School tenant to test against. If you run Jamf School, please open an issue or pull request with feedback.

Already onboarded as a Jamf Pro workspace, or set up before the Connect Jamf School card existed? You can still connect Jamf School from the Add products step during onboarding or later from Data Sources. In that older flow onboarding runs through the Jamf Pro screens first — the Authenticate/Validate steps accept placeholder Jamf Pro values and let you continue even when the connection check fails (see App Onboarding → Running without jamf-cli credentials).

Jamf School data feeds the standalone workbook described above — it does not appear in the interactive dashboards (Overview, Devices, Security Posture, and the rest), which are Jamf Pro/jamf-cli surfaces; see Dashboards.

CSV export format

Jamf School device exports use a semicolon (;) delimiter, not a comma. Export from Devices > Export in the Jamf School web interface — the app reads the file directly, no conversion needed. The School workbook does not build sheets from the export yet; its sheets come from collected School data.

Using the app

1. Connect a Jamf School profile (onboarding, or Data Sources later).
2. Collect, then generate the Jamf School workbook from the app. Its sheets come from the collected School data.

What jamf-cli school commands are used

A School collect calls school overview, school devices list, school device-groups list, school users list, school classes list, school apps list, school profiles list, school locations list, school ibeacons list, and school dep-devices list.