Skip to main content

Installation

IdLE can be installed either from the PowerShell Gallery (recommended) or directly from the GitHub repository source (useful for contributors and development scenarios).

Requirements​

  • PowerShell 7.x or later (pwsh)

From a PowerShell 7 prompt:

# Install the IdLE meta-module (pulls IdLE.Core and IdLE.Steps.Common as dependencies)
Install-Module -Name IdLE -Scope CurrentUser

# Import the baseline modules
Import-Module -Name IdLE
Command collision during install?

If PowerShellGet reports that a command is already available, prefer a clean reinstall instead of -AllowClobber.

Get-InstalledModule IdLE, IdLE.Core, IdLE.Steps.Common -ErrorAction SilentlyContinue |
  Uninstall-Module -AllVersions -Force

Install-Module -Name IdLE -Scope CurrentUser -Force
Import-Module -Name IdLE

Install optional modules​

Providers and additional step modules are published as separate modules and can be installed independently. See the reference for further details on Steps and Providers.

# Provider modules (examples)
Install-Module -Name IdLE.Provider.AD -Scope CurrentUser
Install-Module -Name IdLE.Provider.EntraID -Scope CurrentUser
Install-Module -Name IdLE.Provider.ExchangeOnline -Scope CurrentUser

# Optional step modules (examples)
Install-Module -Name IdLE.Steps.Mailbox -Scope CurrentUser

# Mock provider (safe, used for tests and walkthroughs)
Install-Module -Name IdLE.Provider.Mock -Scope CurrentUser
tip

If a workflow references a StepType from an optional steps module, that steps module must be installed and imported in the host session.

Install from repository source​

info

This installation method is primarily for fetching full example files, testing, and contributing.

This path is intended for development and contribution scenarios.

git clone https://github.com/blindzero/IdentityLifecycleEngine
cd IdentityLifecycleEngine

# Import meta module
Import-Module ./src/IdLE/IdLE.psd1 -Force
info

The meta module bootstraps module discovery for the repository layout. Avoid using this in parallel with an IdLE installation from the PowerShell Gallery. After importing from source, you can import additional modules by name.

Import-Module IdLE.Provider.Mock -Force
Import-Module IdLE.Steps.Mailbox -Force

Verify installation​

Get-Module IdLE* -ListAvailable | Select-Object Name, Version, Path
# Public-facing user commands
Get-Command -Module IdLE | Sort-Object Name
# Public interface functions from modules
Get-Command -Module IdLE.* | Sort-Object Name

Next​