iructl 1.3.0

Iru Control, a utility for local management of Iru resources.

Iru Control

iructl is a utility for managing resources via the Iru API.

Features

• Create and sync a local repository of custom profiles, scripts, or apps with your Iru tenant
• Import existing profiles, scripts, and app installers without copy/pasting
• List or show details of local and remote resources directly from the command line
• Format output as structured YAML, plist, or JSON for use with other tools
• Declaratively assign resources to Blueprints with ensure_blueprints (experimental preview)
• Build your own integration for managing custom resources with a fully featured Python client module

Installation

Install with one of the following:

# Homebrew
brew tap kandji-inc/iructl https://github.com/kandji-inc/iructl.git
brew install iructl

# uv
uv tool install iructl

# pipx
pipx install iructl

See the Installation wiki page for prerequisites and details.

Quick Start

Follow the steps below to quickly get up and running with a local copy of your Iru Custom Resources.

1. Create a new local repository: iructl new my-repo
2. Change directories: cd my-repo
3. Set your credentials:
   1. export IRUCTL_TENANT=<YOUR_API_URL_HERE>
   2. export IRUCTL_TOKEN=<YOUR_API_TOKEN_HERE>
4. Download your custom profiles from Iru: iructl profile pull --all
5. Download your custom scripts from Iru: iructl script pull --all
6. Download your custom apps and their installers from Iru: iructl app pull --all --download

[!NOTE] Replace <YOUR_API_URL_HERE> and <YOUR_API_TOKEN_HERE> with your API URL and token. See Configuration for authentication details.

Getting Help

Each command and subcommand has its own help screen, accessed by appending --help (e.g., iructl --help, iructl new --help).

Full documentation lives in the iructl wiki. Key pages:

• Getting Started
• Populating Your Local Repository
• Configuration
• Pushing and Syncing
• Custom Profiles
• Custom Scripts
• Custom Apps

License

See LICENSE.