-
Notifications
You must be signed in to change notification settings - Fork 1
Home
Welcome to the Wiki of Patcher, an innovative tool designed for Mac Admins. Leveraging the Jamf Pro API, Patcher streamlines the process of fetching patch management data and generating comprehensive reports, facilitating efficient tracking and reporting on software update compliance across macOS devices managed through Jamf Pro.
Patcher is crafted with the needs of Mac Admins in mind, offering a streamlined approach to the often complex and time-consuming task of patch management. By automating the extraction and formatting of patch data, Patcher not only saves time but also ensures accuracy and consistency in the management of software updates.
- Real-Time Patch Information Export: Quickly extract up-to-date patch data for analysis.
- Excel Spreadsheet Integration: Seamlessly export patch information into Excel for in-depth analysis and record-keeping.
- PDF Reporting: Generate neatly formatted PDFs for easy sharing and documentation of patch statuses.
- Customization Options: Tailor the tool to meet your specific reporting and analysis needs.
Ensure you have Python 3.10 or higher, Git, and access to a Jamf Pro instance with administrator privileges. It is required to create a dedicated API client for Patcher use, with the following roles:
- Read Patch Management Software Titles
- Read Patch Policies
- Read Mobile Devices
- Read Mobile Device Inventory Collection
- Read Mobile Device Applications
- Read API Integrations
- Read API Roles
- Read Patch Management Settings
Note
We are developing functionality to have Patcher automatically create the necessary roles and client for simplicity.
Refer to the Jamf Pro Documentation on API Roles and Clients for more information.
🎉 Patcher can now be installed via pip 🎉
Please note that while Patcher is installed as a package, it is meant to be used as a command line tool and not as an imported library.
Important
The pip package is called patcherctl because the name patcher was already taken on PyPI. Despite this, the project itself is referred to as Patcher.
To generate reports, simply specify the output directory with --path. Add --pdf or -f if you wish to generate PDF reports alongside Excel files.
patchertctl --path '/path/to/output/directory' [--pdf]To see a list of all available command options, visit the Command Options page.
Patcher is co-authored by Andrew Speciale (@liquidz00) and Chris Ball (@ball42). Contributions are warmly welcomed, whether they are pull requests, bug reports, questions, or suggestions for new features.