Home

jamf-cli

jamf-cli is a unified command-line interface for the Jamf platform. It supports Jamf Pro, the Jamf Platform API, Jamf Protect, and Jamf School, giving admins direct access to 200+ Jamf Pro API resources, Platform API resources (blueprints, compliance benchmarks, DDM reports), full Jamf Protect configuration management, and Jamf School device and user administration from the terminal — no scripting against raw REST calls, no Postman, no guesswork.

See It in Action

The overview command gives you an instant snapshot of your entire Jamf Pro, Jamf Protect, or Jamf School instance:

$ jamf-cli pro overview
$ jamf-cli protect overview
$ jamf-cli school overview

One command shows instance health, inventory counts, enrollment status, alerts, and more.

A few more examples of what day-to-day usage looks like:

# List all computers in Jamf Pro
jamf-cli pro computers list

# Export your fleet to CSV
jamf-cli pro computers list -o csv --out-file fleet.csv

# Get a specific computer by name
jamf-cli pro computers get --name "Neil's MacBook"

# List blueprints (Platform API)
jamf-cli pro blueprints list

# Check compliance benchmark stats
jamf-cli pro compliance-benchmarks stats "CIS macOS 15"

# List Jamf Protect plans
jamf-cli protect plans list

# Export an analytic to YAML
jamf-cli protect analytics export "My Analytic"

# Download the Jamf Protect installer
jamf-cli protect downloads installer

# List Jamf School devices
jamf-cli school devices list

# Get a School device by serial number
jamf-cli school devices get C02X1234

# List School classes
jamf-cli school classes list

Community Showcase

Jamf community members are already building on jamf-cli — AutoPkg integrations, reporting tools, and more. See the Community Showcase for featured projects, including:

• JamfCLI-Runner by Graham Pugh — an AutoPkg processor that drives jamf-cli from AutoPkg recipes, bringing the CLI's full API coverage into packaging workflows.
• jamf-reports-community by Tony Young — a Python-based reporting tool that generates multi-sheet Excel workbooks (fleet overview, patch compliance, EA coverage, security posture) from live Jamf Pro data via jamf-cli.
• JamfReport by Marco Devliegere — a bash script that produces a self-contained HTML snapshot of a Jamf Pro instance using jamf-cli, with security posture gauges, MDM failure tables, cleanup analysis, and an optional adoption timeline tracked across runs.

If you've built something with jamf-cli, open an issue or PR to get it featured.

Getting Started

New to jamf-cli? Start with the Setup Guide to go from zero to your first command.

For Jamf Pro, platform gateway setup is the recommended path — it routes all Pro API traffic through the Jamf Platform Gateway and unlocks additional Platform API commands (blueprints, compliance benchmarks, DDM reports, and more).

For installation and releases, see the GitHub repository.

Contents

Community

• Community Showcase — Projects, integrations, and write-ups from the Jamf community

Getting Started

• Setup Guide — Installation, interactive setup wizard, shell completion

CLI Reference

• CLI Patterns — Apply, scaffold, pagination, patch, name lookup, dry-run, destructive ops — shared patterns that work across all products
• Output Formats — Table, JSON, CSV, YAML, plain; status indicators, relative timestamps

Product Commands

• Jamf Pro Commands — Fleet inventory, device actions, reports, audit, backup, bulk ops, Classic API, scope management
• Platform API Commands — Blueprints, compliance benchmarks, DDM reports, platform devices and groups
• Jamf Protect Commands — Plans, analytics, detection sets, exception sets, USB control, alerts, insights, audit logs, downloads
• Jamf School Commands — Devices, device groups, users, classes, apps, profiles, locations, iBeacons, DEP devices

Product Workflows

• Pro Workflows — Daily fleet checks, inventory exports, scope management, device actions, multi-instance operations
• Platform Workflows — Blueprint management, profile import, compliance benchmarks, DDM reports
• Protect Workflows — Community analytics import, detection sets, export/import round-trip, USB control, downloads
• School Workflows — Device management, class administration, user management, DEP enrollment

Configuration

• Configuration & Profiles — Config file, auth methods, profile management, global flags, environment variables
• Secrets & Keychain — Secret formats (env:, file:, keychain:), macOS Keychain integration

Reference

• Error Handling & Exit Codes — Exit codes, HTTP error mapping, structured JSON errors, retry logic
• CI/CD & Scripting — Non-interactive mode, GitHub Actions examples, Docker usage
• Architecture & Development — Project structure, code generation, Platform SDK, Protect SDK, contributing