sonoseco / Kmart

A Mac command-line tool that generates kick-ass Jamf Pro reports.

KMART - Kick-Ass Mac Admin Reporting Tool

A command-line utility that generates kick-ass Jamf Pro reports:

Optionally sent via Slack:

Features

• Reporting on the following Jamf Pro objects:
  • 💻 Mac
    • Advanced Searches
    • Applications
    • Configuration Profiles
    • Devices
    • Directory Bindings
    • Disk Encryptions
    • Dock Items
    • Extension Attributes
    • Packages
    • Patch Management Software Titles
    • Patch Policies
    • Policies
    • Printers
    • Restricted Software
    • Scripts
    • Smart Groups
    • Static Groups
  • 📱 Mobile
    • Advanced Searches
    • Applications
    • Configuration Profiles
    • Devices
    • Extension Attributes
    • Smart Groups
    • Static Groups
  • 🏢 Buildings
  • 📂 Categories
  • 🏬 Departments
  • 📚 eBooks
  • 🅱️ iBeacons
  • 📶 Network Segments
• 📒 Customise reporting options via JSON, Property List or YAML configuration files
• 📋 Output reports as JSON, Property List, YAML, Markdown or HTML files
• 🗄️ Send reports via Slack

Usage

OVERVIEW: Kick-Ass Mac Admin Reporting Tool

Generate kick-ass Jamf Pro reports.

USAGE: kmart [--json <json>] [--plist <plist>] [--yaml <yaml>]

OPTIONS:
  -j, --json <json>       JSON configuration file.
  -p, --plist <plist>     Property List configuration file.
  -y, --yaml <yaml>       YAML configuration file.
  --version               Show the version.
  -h, --help              Show help information.

Configuration

• See Sample Configs for all configuration options.

  Note: Use the following command to encode your credentials in the configuration file:

  printf 'username:password' | iconv --to-code ISO-8859-1 | base64

• For Slack integration, read Basic app setup to create a Slack app with a Bot token.

  Note: The Bot token will require the chat:write and files:write permission scopes.

Privileges

Kmart requires the following user privileges in order to report correctly.

Recommendations:

• Create a separate Jamf Pro User Account
• Do not just add these permissions to an existing account
• If you are not reporting on everything, only enable the privileges that are required

Privilege	Create	Read	Update	Delete
Advanced Computer Searches	-	✅	-	-
Advanced Mobile Device	-	✅	-	-
Buildings	-	✅	-	-
Categories	-	✅	-	-
Computer Extension Attributes	-	✅	-	-
Computers	-	✅	-	-
Departments	-	✅	-	-
Directory Bindings	-	✅	-	-
Disk Encryption Configurations	-	✅	-	-
Dock Items	-	✅	-	-
eBooks	-	✅	-	-
iBeacons	-	✅	-	-
Mac App Store Apps	-	✅	-	-
macOS Configuration Profiles	-	✅	-	-
Mobile Device Apps	-	✅	-	-
Mobile Device Configuration Profiles	-	✅	-	-
Mobile Device Extension Attributes	-	✅	-	-
Mobile Devices	-	✅	-	-
Network Segments	-	✅	-	-
Packages	-	✅	-	-
Patch Management Software Titles	-	✅	-	-
Patch Policies	-	✅	-	-
Policies	-	✅	-	-
Printers	-	✅	-	-
Restricted Software Records	-	✅	-	-
Scripts	-	✅	-	-
Smart Computer Groups	-	✅	-	-
Smart Mobile Device Groups	-	✅	-	-
Static Computer Groups	-	✅	-	-
Static Mobile Device Groups	-	✅	-	-

Build Requirements

• Swift 5.5.
• Runs on macOS Monterey 12 and later.

Download

• Grab the latest version of KMART from the releases page.
• Note: Versions 1.3 and later require macOS Monterey or later.
  • If you need to run KMART on an older operating system, you can still use version 1.2.

Credits / Thank You

• Project created and maintained by Nindi Gill (ninxsoft).
• Apple (apple) for Swift Argument Parser, used to perform command-line argument and flag operations.
• JP Simard (jpsim) for Yams, used to export YAML.
• John Sundell (JohnSundell) for Ink, used to generate HTML from Markdown.
• David Mohundro (drmohundro) for SWXMLHash, used to decode XML.
• Sindre Sorhus (sindresorhus) for github-markdown-css, used to make the HTML output prettier.

License

Copyright © 2024 Nindi Gill

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.