ipmhub Docs

About

Mon, 22 May 2023 00:34:57 +0100

About IPMHub

IPMHub is a modern package management platform designed to simplify and streamline Infrastructure as Code (IaC) distribution. Founded in 2024, we focus on making infrastructure code sharing and management effortless, whether within your organization or across your customer base.

Our Solution

IPMHub, along with our CLI client IPM (Infrastructure Package Manager), provides a robust ecosystem for cloud engineers, DevOps practitioners, and platform engineers to share, manage, and deploy infrastructure code efficiently. What sets us apart is our innovative “Tracked Workspaces” feature, which provides unprecedented visibility into your infrastructure code usage across your organization. This functionality enables teams to monitor workspace status through our portal (https://portal.ipmhub.io), tracking package usage, version status, and change history with precision.

prep-ipm

Thu, 12 Mar 2026 00:00:00 +0000

prep-ipm

Downloads and installs the IPM CLI for the runner’s OS and architecture, then exposes it on PATH. Safe to call multiple times within a job — it skips the download if the requested version is already installed.

This action is used internally by ipm-init, ipm-sync, and ipm-status. You only need to use it directly if you want to run IPM CLI commands manually in a subsequent step.

Usage

- uses: ipmhubio/ipm-actions/.github/actions/prep-ipm@v1
  with:
    version: ''          # Optional: specific version without 'v' prefix (default: latest)
    alias-name: 'ipm'   # Optional: alias exposed on PATH (default: 'ipm')

Inputs

Input	Required	Default	Description
`version`	No	latest	Specific IPM version to install, without the `v` prefix (e.g. `0.12.0`). Omit or leave empty for latest.
`alias-name`	No	`ipm`	The name of the binary alias exposed on `PATH`.
`alias-per-version`	No	`false`	When `true`, the alias becomes `<alias-name>-<version>` so multiple versions can coexist in the same job.
`install-root`	No	`${{ runner.temp }}/ipm-bin`	Root directory used to cache installs across steps within the job.

Outputs

Output	Description
`bin_dir`	Directory containing the installed binary.
`alias_path`	Full path to the binary alias.
`alias`	Alias name that was added to `PATH`.
`version_key`	Normalized version key (e.g. `0.12.0` or `latest`).

Supported Platforms

OS	Architectures
Ubuntu	x64, arm, arm64
macOS	x64, arm64
Windows	x86, x64, arm64

Examples

Install latest and use in a subsequent step

- name: Install IPM
  id: ipm
  uses: ipmhubio/ipm-actions/.github/actions/prep-ipm@v1

- name: Run custom IPM command
  run: ipm info myorg/mypackage --non-interactive
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Pin a specific version

- name: Install IPM 0.12.0
  uses: ipmhubio/ipm-actions/.github/actions/prep-ipm@v1
  with:
    version: '0.12.0'

Run two IPM versions in the same job

- name: Install IPM latest
  uses: ipmhubio/ipm-actions/.github/actions/prep-ipm@v1
  with:
    alias-per-version: 'true'

- name: Install IPM 0.10.0
  uses: ipmhubio/ipm-actions/.github/actions/prep-ipm@v1
  with:
    version: '0.10.0'
    alias-per-version: 'true'

- name: Compare outputs
  run: |
    ipm-latest --version
    ipm-0.10.0 --version

Integrate with GitHub

Thu, 08 Feb 2024 22:32:19 +0000

Integrate IPM with GitHub Workflows

This guide explains how to integrate IPM into your GitHub workflows. IPM can be installed dynamically within your workflows for tasks such as package management and status monitoring. Common use cases include downloading packages, publishing updates, and running status checks to enhance observability.

Installing IPM in Your Workflow

Add the following step to your workflow to install the latest version of IPM:

- name: Install IPM CLI
  shell: bash
  run: |
      curl -Lo ipm-cli.tar.gz "https://github.com/ipmhubio/ipm/releases/download/0.7.0/ipm-linux-x64-full.tar.gz"
      tar -xzf ipm-cli.tar.gz
      rm -f ipm-cli.tar.gz 
      sudo mv ./ipm /usr/local/bin/ipm

Authentication Setup

To use IPM in your workflows, you’ll need to authenticate using the --non-interactive parameter and a client secret. You can provide authentication either through environment variables or command-line parameters. For more details about non-interactive mode, see the

IPM CLI

Third Party Licenses

Mon, 22 May 2023 00:34:57 +0100

Autofac

Project Url: https://github.com/autofac/Autofac
License: MIT
Copyright © 2014 Autofac Project

CommandLineParser

Project Url: https://github.com/commandlineparser/commandline
License: MIT
Copyright © 2005 - 2015 Giacomo Stelluti Scala & Contributors

Access organizations

Thu, 08 Feb 2024 22:32:19 +0000

Overview

This guide walks you through the process of creating an IPMHub account and joining an organization after receiving an invitation.

Prerequisites

An email invitation from an IPMHub organization administrator
The unique invitation code from the email
A valid email address

Steps

1. Create Your IPMHub Account

Click the invitation link in your email or visit IPMHub Portal
Create an account, more information can be found
GETTING STARTED

Integrate with Azure DevOps

Thu, 08 Feb 2024 22:32:19 +0000

Integrate IPM with Azure DevOps Pipelines

This guide explains how to integrate IPM into your Azure DevOps pipelines. IPM can be installed dynamically within your pipeline jobs for tasks such as package management and status monitoring. Common use cases include downloading packages, publishing updates, and running status checks to enhance observability.

Installing IPM in Your Pipeline

Add the following step to your pipeline to install the latest version of IPM:

ipm-init

Thu, 12 Mar 2026 00:00:00 +0000

ipm-init

Initializes a new IPM workspace in the specified directory by running ipm init. Use this action when your workflow needs to set up a fresh workspace before adding or syncing packages.

This action does not require authentication.

Usage

- uses: ipmhubio/ipm-actions/.github/actions/ipm-init@v1
  with:
    working-directory: '.'   # Optional: directory to initialize (default: '.')

Inputs

Input	Required	Default	Description
`working-directory`	No	`.`	Directory where `ipm init` will run.
`hide-banner`	No	`false`	Set to `true` to suppress the IPM CLI banner in the log output.
`ipm-version`	No	latest	Specific IPM version to use, without the `v` prefix. Omit for latest.

Examples

Initialize a workspace at the repo root

- uses: actions/checkout@v4

- name: Init IPM workspace
  uses: ipmhubio/ipm-actions/.github/actions/ipm-init@v1

Initialize in a subdirectory

- name: Init workspace
  uses: ipmhubio/ipm-actions/.github/actions/ipm-init@v1
  with:
    working-directory: ./infrastructure

Use a pinned IPM version with a clean log

- name: Init workspace
  uses: ipmhubio/ipm-actions/.github/actions/ipm-init@v1
  with:
    working-directory: ./infrastructure
    ipm-version: '0.12.0'
    hide-banner: 'true'

info

`ipm-init` only needs to run once per workspace. If your workspace already has an `ipmhub.json`, you can skip this action and go straight to `ipm-sync`.

ipm-sync

Thu, 12 Mar 2026 00:00:00 +0000

ipm-sync

Synchronizes packages in an existing IPM workspace by running ipm sync. This is the primary action for downloading and updating packages in your CI/CD pipeline.

Authentication is required via the IPM_CLIENT_SECRETS environment variable.

Usage

- uses: ipmhubio/ipm-actions/.github/actions/ipm-sync@v1
  with:
    working-directory: '.'            # Optional
    sync-mode: 'KeepAllChanges'       # Optional
    package-name: ''                  # Optional
    package-names: ''                 # Optional
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Inputs

Input	Required	Default	Description
`working-directory`	No	`.`	Directory containing the IPM workspace.
`sync-mode`	No	`KeepAllChanges`	Controls how local file changes are handled during sync. See Sync Modes below.
`package-name`	No	—	Sync a single specific package by name.
`package-names`	No	—	Sync multiple packages. Separate names with semicolons, commas, or spaces.
`hide-banner`	No	`false`	Set to `true` to suppress the IPM CLI banner in the log output.
`ipm-version`	No	latest	Specific IPM version to use, without the `v` prefix.

warning

Use either `package-name` or `package-names`, not both. If neither is set, all packages in the workspace are synchronized.

Sync Modes

Mode	Behavior
`KeepAllChanges`	Preserves all local modifications (default).
`KeepChangesOnly`	Preserves modified files, removes locally added files.
`KeepNewFilesOnly`	Keeps locally added files, overwrites modified files.
`Clean`	Removes all local changes and downloads a fresh copy.

Examples

Sync all packages in the workspace

- name: Sync IPM packages
  uses: ipmhubio/ipm-actions/.github/actions/ipm-sync@v1
  with:
    working-directory: ./infrastructure
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Sync with a clean slate

- name: Sync packages (clean)
  uses: ipmhubio/ipm-actions/.github/actions/ipm-sync@v1
  with:
    working-directory: ./infrastructure
    sync-mode: Clean
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Sync a specific package

- name: Sync network module
  uses: ipmhubio/ipm-actions/.github/actions/ipm-sync@v1
  with:
    working-directory: ./infrastructure
    package-name: 'myorg/virtual-networks'
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Sync multiple specific packages

- name: Sync network packages
  uses: ipmhubio/ipm-actions/.github/actions/ipm-sync@v1
  with:
    working-directory: ./infrastructure
    package-names: 'myorg/virtual-networks; myorg/storage-accounts'
    sync-mode: Clean
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Multi-platform sync

jobs:
  sync:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Sync packages
        uses: ipmhubio/ipm-actions/.github/actions/ipm-sync@v1
        with:
          working-directory: ./infrastructure
        env:
          IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Link Entra

Thu, 08 Feb 2024 22:32:19 +0000

info

We assume that you have have an Microsoft Entra account.

check_circle

We support personal and business accounts.

Go to portal.ipmhub.io and select the Microsoft logo.

ipm-status

Thu, 12 Mar 2026 00:00:00 +0000

ipm-status

Checks the status of packages in an existing IPM workspace by running ipm status. Use this to verify that packages are in sync or to detect drift as part of a pipeline or scheduled check.

Authentication is required via the IPM_CLIENT_SECRETS environment variable.

Usage

- uses: ipmhubio/ipm-actions/.github/actions/ipm-status@v1
  with:
    working-directory: '.'   # Optional
    package-name: ''         # Optional
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Inputs

Input	Required	Default	Description
`working-directory`	No	`.`	Directory containing the IPM workspace.
`package-name`	No	—	Check status for a single specific package. If omitted, all packages in the workspace are checked.
`hide-banner`	No	`false`	Set to `true` to suppress the IPM CLI banner in the log output.
`ipm-version`	No	latest	Specific IPM version to use, without the `v` prefix.

Examples

Check status of all packages

- name: IPM status
  uses: ipmhubio/ipm-actions/.github/actions/ipm-status@v1
  with:
    working-directory: ./infrastructure
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Check status of a single package

- name: Check network module status
  uses: ipmhubio/ipm-actions/.github/actions/ipm-status@v1
  with:
    working-directory: ./infrastructure
    package-name: 'myorg/virtual-networks'
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Drift detection in a scheduled workflow

name: Nightly drift check

on:
  schedule:
    - cron: '0 6 * * *'

jobs:
  drift:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Check package status
        uses: ipmhubio/ipm-actions/.github/actions/ipm-status@v1
        with:
          working-directory: ./infrastructure
        env:
          IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Use alongside sync in a deploy pipeline

- name: Sync packages
  uses: ipmhubio/ipm-actions/.github/actions/ipm-sync@v1
  with:
    working-directory: ./infrastructure
    sync-mode: KeepAllChanges
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

- name: Verify status after sync
  uses: ipmhubio/ipm-actions/.github/actions/ipm-status@v1
  with:
    working-directory: ./infrastructure
  env:
    IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

Link GitHub

Thu, 08 Feb 2024 22:32:19 +0000

info

We assume that you have have an GitHub account.

Go to portal.ipmhub.io and select the GitHub logo.

Click the image to enlarge

pin-your-bicep

Thu, 12 Mar 2026 00:00:00 +0000

pin-your-bicep

Installs and pins a specific Bicep CLI version on the runner, then adds it to PATH so subsequent steps can use bicep directly. If the requested version is already present on the agent, the download is skipped.

This action does not require authentication.

Usage

- uses: ipmhubio/ipm-actions/.github/actions/pin-your-bicep@v1
  with:
    version: 'latest'   # Optional: specific version or 'latest' (default: latest)

Inputs

Input	Required	Default	Description
`version`	No	`latest`	Bicep version to install. Accepts `latest` or a specific version with or without the `v` prefix (e.g. `0.38.3` or `v0.38.3`).

Outputs

Output	Description
`installed`	`true` if Bicep was downloaded; `false` if the requested version was already present.
`resolved_version`	The actual version that was installed (normalized, no leading `v`).
`path`	Install directory added to `PATH`, if a download occurred.

Supported Platforms

OS	Architectures
Ubuntu	x64, arm64
macOS	x64, arm64
Windows	x64, arm64

Examples

Install the latest Bicep release

- name: Pin Bicep
  uses: ipmhubio/ipm-actions/.github/actions/pin-your-bicep@v1

- name: Compile Bicep template
  run: bicep build ./main.bicep

Pin a specific Bicep version

- name: Pin Bicep 0.38.3
  uses: ipmhubio/ipm-actions/.github/actions/pin-your-bicep@v1
  with:
    version: '0.38.3'

Use outputs to log the installed version

- name: Pin Bicep
  id: bicep
  uses: ipmhubio/ipm-actions/.github/actions/pin-your-bicep@v1

- name: Log Bicep version
  run: echo "Installed Bicep ${{ steps.bicep.outputs.resolved_version }}"

Combine with IPM sync in a Bicep deployment workflow

name: Deploy Bicep infrastructure

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Pin Bicep
        uses: ipmhubio/ipm-actions/.github/actions/pin-your-bicep@v1
        with:
          version: '0.38.3'

      - name: Sync IPM packages
        uses: ipmhubio/ipm-actions/.github/actions/ipm-sync@v1
        with:
          working-directory: ./infrastructure
          sync-mode: Clean
        env:
          IPM_CLIENT_SECRETS: ${{ secrets.IPM_CLIENT_SECRETS }}

      - name: Build Bicep
        run: bicep build ./infrastructure/main.bicep

info

The action checks if the requested version is already on the agent's `PATH` before downloading. On self-hosted runners with a pre-installed Bicep, the download step will be skipped automatically.

Install IPM

Mon, 22 May 2023 00:34:57 +0100

Windows

Windows 10/11

We strongly advise to use winget to install IPM on Windows 10 or 11. winget is the easiest way to install and to update IPM.

winget install IPMHub.IPM

Update IPM

winget upgrade IPMHub.IPM

Windows 7 SP1 - Windows 8

IPM parameters

Thu, 08 Feb 2024 22:21:11 +0000

check_circle

IPM version 0.14.0 is now available with interactive search/add, CLI diagnostics, and workspace init improvements!

The IPM client has a number of main verbs that can be used to interact with the IPMHub and get your project up and running.

Main verbs:

account: Display current user information
add: Add packages to your workspace
build: Prepare package contents from a source directory
cache: Manage the IPM client cache
config: Configure the IPM client
export: Export a package to a local folder
info: Get package information
init: Initialize a local workspace
list: List available packages
login: Authenticate with IPMHub
logout: End the current session
publish: Publish a new package version
search: Find packages
status: Check workspace status
sync: Synchronize your workspace

Account

Return the current user and the remaining lifetime of the current session.

Add

Thu, 08 Feb 2024 22:27:48 +0000

Introduction

The ipm add command facilitates adding new packages to the local workspace and also directly downloads it from our remote servers.

Interactive Mode

Starting with version 0.14.0, when ipm add is run without a --package argument in a supported terminal, it launches the advanced interactive navigation.

How it works:

Start typing to fuzzy-search packages by name
Use ↑ / ↓ arrow keys to navigate through the results
Press Page Up / Page Down to move between pages of results
Press Enter on a package to load all available versions
Press ← Left arrow to go back to the package list
Press F1 to show keyboard shortcut help
Press F2 to view the package details (latest version); when browsing versions, F2 shows the details for the selected version
Press Enter on a version to add that package version to your local workspace

This is the recommended way to explore and add packages when working interactively. For scripted or CI/CD use, continue providing --package and optionally --version as before.

Build

Tue, 23 Apr 2024 00:00:00 +0000

Introduction

The ipm build command allows you to build a package from a source folder to a target folder. This is particularly useful when you want to inspect the package contents before publishing, ensuring that only the intended files are included and correctly organized.

Command Syntax

ipm build -s <source-directory> [-d <destination-directory>] [--dry-run] [--include-manifest] [--summary-file <filepath>]

Required Parameters (option 1)

-s or --source: The source directory containing your package content
-d or --destination: The destination directory where the built package will be placed

Required Parameters (option 2)

-s or --source: The source directory containing your package content
--dry-run: Execute the build process without actually copying files, showing what would happen

Examples

Build package content from the current directory to a ‘dist’ folder:

Export

Wed, 23 Apr 2025 00:00:00 +0000

Introduction

The ipm export command enables you to export packages from IPMHub directly to local folders without configuring them as workspaces. This is particularly useful for scenarios where you need to extract package contents for reference, inspection, or integration into non-IPM environments.

Key Benefits

Direct Export: Extract package files to any folder without workspace configuration
Version Control: Export specific versions of packages
Simplified Access: Get package content without creating workspace dependencies
Reference Material: Create local copies of packages for documentation or learning
Flexible Destinations: Export to empty or non-empty directories with --force
Audit Documentation: Generate compliance reports with --summary-file

Use Cases

The export command is designed for scenarios such as:

Verified Packages

Sun, 08 Jun 2025 00:00:00 +0000

Introduction

Verified packages provide enterprise-grade package integrity through cryptographic verification, ensuring that packages maintain their exact content from build to deployment. This feature addresses growing enterprise requirements for package provenance and content verification through comprehensive manifest generation and automated verification processes.

What Are Verified Packages?

Verified packages are IPM packages that include cryptographic proof of their integrity through manifest files. These packages receive a “verified” badge and provide mathematical assurance that their content has not been tampered with between build and publication.

Audit Reporting

Sun, 08 Jun 2025 00:00:00 +0000

Introduction

IPM’s --summary-file parameter creates JSON reports that document what each operation did. These files record which files were processed, what was excluded, and basic operation metadata. They’re useful for tracking changes and understanding what happened during package operations.

Available for These Commands

The --summary-file parameter works with:

ipm build - Records what files were included and excluded during build
ipm export - Documents package export operations
ipm publish - Logs package publication details

Build Operation Summaries

When you use --summary-file with ipm build, it creates a JSON file documenting:

Publishing

Tue, 23 Apr 2024 00:00:00 +0000

Introduction

The ipm publish command allows you to publish new package versions to IPMHub. This guide covers the publishing process and best practices to ensure your packages are properly structured and accessible, including support for verified packages and audit reporting.

Prerequisites

Before publishing a package with IPM, ensure you have:

Created the package on IPMHub portal (see
PUBLISH
IPM
" data-bs-toggle="tooltip" href="https://docs.ipmhub.io/docs/packages/publish/ipm/">IPM Publishing guide)
Prepared your package content in a local directory
Authenticated with IPMHub using ipm login
Determined the appropriate semantic version (e.g., 1.0.0)
For verified packages: Built package with manifest using ipm build --include-manifest

Publishing Workflow

Basic Publishing

The standard syntax for publishing a package:

Exit Codes

Mon, 20 Jan 2025 00:00:00 +0000

info

Error codes are introduced in IPM version 0.13.0

Introduction

The IPM CLI returns specific exit codes to indicate the success or failure of operations. These codes help with automation, scripting, and debugging by providing detailed information about what went wrong during command execution.

warning

On Linux and macOS, exit codes are limited to 0-255. Negative exit codes are converted using modulo 256 (e.g., -100 becomes 156).

Exit Code Categories

Exit codes are organized into logical groups based on the type of operation or error:

Project Config (ipmhub.json)

Thu, 08 Feb 2024 22:21:25 +0000

All packages that you are adding to your project are versioned. This means that you can specify which version of a package you wish to include in your project. To keep track of which version you are using within your project we save that information in a easy to read json file. This file is easy to read and can be used to add multiple packages at once. Next to that it’s also possible to ship a copy of a whole project to a different environment.

Diagnostics

Wed, 18 Mar 2026 00:00:00 +0000

Introduction

IPM 0.14.0 introduces configurable diagnostic levels. When enabled, the CLI sends telemetry about the current session to the IPMHub API. This information is used for troubleshooting, support, and analytics.

Diagnostics are disabled by default (none). No data is sent unless you opt in.

Diagnostics Levels

Three levels are available:

Level	Description
`none`	No session data is sent. This is the default.
`minimal`	Sends basic information about the CLI run.
`full`	Sends detailed contextual information about the run environment.

Minimal

The minimal level sends the following at the start and end of each CLI session:

Sync

Thu, 08 Feb 2024 22:27:38 +0000

Introduction

The ipm sync command facilitates the synchronization of your local workspace with our remote servers. In the sections below, we explore various scenarios in which the synchronization process proves to be beneficial.

Initialize a new project

When starting a new project or replicating an existing one with multiple packages, diverse

IPM FEATURES

Add
All information you may need to setup your project using IPM Add." data-bs-toggle="tooltip" href="https://docs.ipmhub.io/docs/ipm/param_details/add/#multiple-strategy">strategies, or a otherwise more complex setup, you can effortlessly duplicate the ipmhub.json file from one project to another.

AI Translation

Thu, 08 Feb 2024 22:21:25 +0000

AI Translation

Welcome to the documentation for our AI Translation Service, an innovative feature designed to enhance user interaction with our IPM client in their preferred language. With this service, we aim to break language barriers by providing translations for Readme and Release notes in over 136 languages. This ensures that every user can seamlessly access and comprehend essential information in their preferred language, making our platform more inclusive and user-friendly. Explore the capabilities and integration details of our AI Translation Service in the sections below to elevate your user experience.

IPM

Thu, 08 Feb 2024 22:27:38 +0000

Introduction

The released packages provide versioning support, facilitate exploration of version history, demonstrate examples and READMEs, and include additional functionalities. It is strongly advised to deploy reusable packages to a hub.

When utilizing the IPM client to publish new versions to the IPM, it enables the creation of public, hybrid and private packages. This functionality also permits the building of applications from a designated folder.

Requirements

Everyone with a paid license can publish packages to our hub with IPM. You can follow the following requirements and guidelines:

CSV Upload

Wed, 29 Oct 2025 22:27:38 +0000

Introduction

The CSV bulk import feature lets you create multiple packages at once by uploading a CSV file. This is useful when you need to create many packages quickly or migrate packages from another system.

Requirements

Maximum 100 packages per CSV file
Contributor role or higher in the target organization(s)
CSV must be semicolon-separated (;)

CSV Format

Required Columns

Your CSV must include these columns:

Malware Scanning

Fri, 06 Mar 2026 00:00:00 +0000

Introduction

Every package version published to IPMHub is automatically scanned for malicious content. This happens in the background after ipm publish completes. The version is unavailable for download until the scan finishes.

Scan Process

Scanning runs as a background process triggered by the upload. It operates independently of the IPM client – once publish returns, the scan is already queued.

The scan can take up to 5 minutes to complete. During this time, the version is unlisted and cannot be downloaded by anyone, including the publisher.

Package visibility

Thu, 08 Feb 2024 22:27:38 +0000

Introduction

On IPMHub.io, we provide support for three types of package visibility: Public, Hybrid, and Private. Below, you will find a more detailed explanation of each of these visibility types. Please be aware that in the Free tier, we only support public packages.

What is a Tracked Workspaces?

Mon, 22 May 2023 00:34:57 +0100

Introduction

With IPM, it’s possible to automatically track the history and current state of your workspaces. You can also see which packages and versions are active in each workspace. This provides a unified and clear overview of the state and distribution of your packages. In addition to having a clear overview of your package distribution, we also provide clear insights into who updated a workspace, such as updating packages, and adding or removing them.

Edit organization

Thu, 03 Oct 2024 00:34:57 +0100

info

Want to try out this feature? Join our Partner program

Introduction

When you create an organization and publish hybrid or public packages, you will expose you organization on IPMHub.io. You can manage configuration settings from this page.

Invite users

Wed, 02 Oct 2024 00:34:57 +0000

info

This guide the administrator. If you got invited, please please look here for more information: Partner program

Introduction

To invite new team member to you organization they first need to have an account. This documenation guides you thought this process. This part of the documention is for the “Admins” of an organization. Please look at this documention if you are a user that is invited or want to be invited to an organization.

Users and roles

Wed, 02 Oct 2024 00:34:57 +0000

info

Want to try out this feature? Join our Partner program

Introduction

Within IPMHub.io, you can manage user access and permissions. Each user is assigned a specific role that defines what actions they can perform within the system. Owners have full control over an organization, allowing them to create, assign, or update user roles to ensure proper access control across the platform. Roles help streamline permissions, making it easy to manage what users can see and do.

Delete users

Wed, 02 Oct 2024 00:34:57 +0000

info

Want to try out this feature? Join our Partner program

Introduction

To delete a user from your organization, follow these steps.

Use Tracked Workspace

Mon, 22 May 2023 00:34:57 +0100

info

Want to try out this feature? Join our Partner program

Setup local workspace

Using ipm init (recommended)

Starting with version 0.14.0, you can link a workspace to a tracked workspace directly when initializing with ipm init:

Create Tracked Workspace

Mon, 22 May 2023 00:34:57 +0100

info

Want to try out this feature? Join our Partner program

Create

To create a Tracked Workspace, go to the portal and go to the organization page. Select the organization for which you want to create a Tracked Workspace; in our example, we create one for IPMHub.

Creating Groups

Thu, 19 Feb 2026 00:00:00 +0000

Creating a Group

Access the Groups Section

Navigate to your organization
Expand the “Settings” menu
Click on “Groups”

Create New Group

Click the “Create Group” button
A modal will open with the following fields:

Click the image to enlarge

Group Properties

Name - Unique identifier for the group (max 64 characters: a-z, A-Z, 0-9, dashes)
Description - Brief description of the group’s purpose
Organization Role - Choose the role this group will have:
- Global Contributor
- Global Viewer

Click “Create Group” to finish

Managing Group Members

Thu, 19 Feb 2026 00:00:00 +0000

Managing Group Members

Groups can contain three types of entities: users, other groups (nested), and client secrets. This guide covers adding and removing members.

Accessing Member Management

There are two ways to access the member management interface:

Option 1: From the Groups Table

In the groups table, click the people icon in the “Actions” column for the group you want to manage.

Option 2: From the Group Details

Open the group by clicking on its name
In “Quick Actions”, click “Manage Members”

Adding Members

Click the “Add Members” button

Editing Groups

Thu, 19 Feb 2026 00:00:00 +0000

Editing Group Properties

You can modify a group’s name, description, and organization role after creation.

Accessing Edit Mode

There are two ways to edit a group:

Option 1: From the Group Details

Open the group by clicking on its name
In “Quick Actions”, click “Edit Properties”

Option 2: From the Groups Table

In the groups table, click the gear icon in the “Actions” column for the group you want to edit.

Deleting Groups

Thu, 19 Feb 2026 00:00:00 +0000

Deleting a Group

Deleting a group removes the group container but does not delete the entities that were members of the group.

Accessing Delete Function

There are two ways to delete a group:

Option 1: From the Group Details

Open the group by clicking on its name
In “Quick Actions”, click “Edit Properties”
Click the “Delete Group” button at the bottom of the properties panel

Option 2: From the Groups Table

In the groups table, click the gear icon in the “Actions” column, then select delete from the options.

Edit Tracked Workspace

Mon, 22 May 2023 00:34:57 +0100

info

Want to try out this feature? Join our Partner program

Edit Tracked Workspace

Within the portal you can change the name and the description. Changing the name or the description has no impact on the current link

Delete and restore Tracked Workspace

Mon, 22 May 2023 00:34:57 +0100

info

Want to try out this feature? Join our Partner program

Delete Tracked Workspace

To delete

Go to the Tracked Workspace that you want to delete. Tracked Workspaces can be found under your organization.

Activity Log

Wed, 18 Mar 2026 00:00:00 +0000

info

Access to the Activity Log requires the Security Manager role or higher within your organization.

Activity Log

The Activity Log provides IPMHub administrators with a comprehensive, real-time record of all activities that occur within the application. Every administrative action, security event, and system operation is captured and surfaced here, giving you a clear picture of who did what, when, and how. Use the Activity Log to support security auditing, investigate anomalies, and maintain administrative oversight across your organization.

Client Secrets

Thu, 18 Jan 2024 00:34:57 +0100

Introduction

Client secrets provide secure authentication for non-interactive processes in IPMHub, enabling automated workflows through platforms like DevOps pipelines and GitHub Actions. These secrets allow programmatic access to IPMHub functionality while maintaining security and control over permissions.

Key Features

Role-Based Access: Assign specific permission levels (Viewer or Contributor) to control access scope
Configurable Analytics: Choose the level of analytics data collection
Managed Expiration: Set validity periods up to 24 months
Revocation Control: Immediately revoke access when needed
Security Compliance: Administrative oversight with proper role requirements

Usage and Limitations

Authentication Priority

Client secret authentication always takes precedence over interactive authentication
When using a client secret, any existing interactive session will be ignored

Multiple Secrets Support

IPM supports the use of multiple client secrets simultaneously
Each secret can have different roles and analytics settings

Supported Operations

When using client secrets, the IPM client only supports these commands:

Package Feed

Fri, 27 Mar 2026 00:00:00 +0000

Package Feed

The Package Feed gives you a live feed URL that delivers update notifications whenever a new version of a package is published. Subscribe using any feed reader or automation tool to stay informed of new releases in real time. Feed data can be retrieved as RSS or JSON (the Type), and the content within each entry can be rendered as HTML, Markdown, or plain text (the Format), allowing integration with a wide range of tools and workflows.

Create Client Secret

Thu, 18 Jan 2024 00:34:57 +0100

Creating Client Secrets

info

You must have the Security Manager role or higher to create client secrets.

Prerequisites

Before creating a client secret, ensure you have:

The Security Manager role or higher in the organization
Determined the required access level (Viewer or Contributor)
Planned the secret’s lifetime and analytics requirements

Creation Process

Navigate to your organization’s settings:
- Go to Organizations
- Select your organization
- Click Settings
- Select Client Secrets

Click the image to enlarge

Edit Client Secret

Thu, 18 Jan 2024 00:34:57 +0100

Editing Client Secrets

info

Only the Analytics Mode can be modified after a client secret is created.

Access Secret Settings

Navigate to your organization’s settings:
- Go to Organizations
- Select your organization
- Click Settings
- Select Client Secrets
Click the image to enlarge
Locate the client secret you want to modify

Click the image to enlarge

Delete Client Secret

Thu, 18 Jan 2024 00:34:57 +0100

Deleting Client Secrets

warning

Deleting a client secret immediately revokes access and cannot be undone.

Revocation Process

Navigate to your organization’s settings:
- Go to Organizations
- Select your organization
- Click Settings
- Select Client Secrets
Click the image to enlarge
Locate the client secret to revoke

Click the image to enlarge
Open the client secret details and go to Properties

Using Client Secrets

Thu, 18 Jan 2024 00:34:57 +0100

Using Client Secrets with IPM

Client secrets enable non-interactive authentication for automated processes. This guide explains how to use client secrets with the IPM client.

Prerequisites

Before using client secrets, ensure you have:

Created a client secret in the IPMHub portal
Required permissions for the intended operations
IPM client installed and configured

Enabling Non-Interactive Mode

To use client secrets, you must first enable non-interactive mode with the --non-interactive parameter. This tells IPM to use client secret authentication instead of interactive login.

Sandbox Organizations

Wed, 29 Oct 2025 22:27:38 +0000

Introduction

Sandbox organizations provide isolated testing environments where you can experiment with infrastructure packages without affecting production systems. Each sandbox operates as an independent organization with full IPMHub functionality while maintaining your existing licensing structure.

Key Features

Complete Isolation: Dedicated organization with “-sandbox” suffix, fully separated from production
Full Platform Access: All IPMHub features including publishing, workspace management, and CLI operations
Production Integration: Use packages from your main organization as nested dependencies
Protected Boundaries: Technical controls prevent sandbox packages from contaminating production
Quarterly Reset: Automatic cleanup every 4 months keeps environments fresh

How Sandbox Organizations Work

Organization Structure

When you request a sandbox, IPMHub creates a new organization with your organization name plus a “-sandbox” suffix:

Sync from Production

Wed, 29 Oct 2025 22:27:38 +0000

Introduction

The Sync from Production feature lets you copy package metadata from your production organization to your sandbox environment. This creates empty package shells in your sandbox that match your production packages, letting you experiment with existing package structures.

What Gets Synced

When you sync from production, only package metadata is copied:

Package name
Package description
Package type (Bicep, Terraform, etc.)
License information
Visibility settings
Project URL

What Doesn’t Get Synced

Package versions
Package content/files
Version history
Download statistics
Tracked workspaces

The synced packages are created empty - you can then publish versions to them in your sandbox environment.

ipmhub Docs

About

About IPMHub link

Our Solution link

prep-ipm

prep-ipm link

Usage link

Inputs link

Outputs link

Supported Platforms link

Examples link

Install latest and use in a subsequent step link

Pin a specific version link

Run two IPM versions in the same job link

Integrate with GitHub

Integrate IPM with GitHub Workflows link

Installing IPM in Your Workflow link

Authentication Setup link

Third Party Licenses

Autofac link

CommandLineParser link

Access organizations

Overview link

Prerequisites link

Steps link

1. Create Your IPMHub Account link

Integrate with Azure DevOps

Integrate IPM with Azure DevOps Pipelines link

Installing IPM in Your Pipeline link

ipm-init

ipm-init link

Usage link

Inputs link

Examples link

Initialize a workspace at the repo root link

Initialize in a subdirectory link

Use a pinned IPM version with a clean log link

ipm-sync

ipm-sync link

Usage link

Inputs link

Sync Modes link

Examples link

Sync all packages in the workspace link

Sync with a clean slate link

Sync a specific package link

Sync multiple specific packages link

Multi-platform sync link

Link Entra

ipm-status

ipm-status link

Usage link

Inputs link

Examples link

Check status of all packages link

Check status of a single package link

Drift detection in a scheduled workflow link

Use alongside sync in a deploy pipeline link

Link GitHub

pin-your-bicep

pin-your-bicep link

Usage link

Inputs link

Outputs link

Supported Platforms link

Examples link

Install the latest Bicep release link

Pin a specific Bicep version link

Use outputs to log the installed version link

Combine with IPM sync in a Bicep deployment workflow link

Install IPM

Windows link

Update IPM link

IPM parameters

Account link

Add

Introduction link

Interactive Mode link

Build

Introduction link

About IPMHub

Our Solution

prep-ipm

Usage

Inputs

Outputs

Supported Platforms

Examples

Install latest and use in a subsequent step

Pin a specific version

Run two IPM versions in the same job

Integrate IPM with GitHub Workflows

Installing IPM in Your Workflow

Authentication Setup

Autofac

CommandLineParser

Overview

Prerequisites

Steps

1. Create Your IPMHub Account

Integrate IPM with Azure DevOps Pipelines

Installing IPM in Your Pipeline

ipm-init

Usage

Inputs

Examples

Initialize a workspace at the repo root

Initialize in a subdirectory

Use a pinned IPM version with a clean log

ipm-sync

Usage

Inputs

Sync Modes

Examples

Sync all packages in the workspace

Sync with a clean slate

Sync a specific package

Sync multiple specific packages

Multi-platform sync

ipm-status

Usage

Inputs

Examples

Check status of all packages

Check status of a single package

Drift detection in a scheduled workflow

Use alongside sync in a deploy pipeline

pin-your-bicep

Usage

Inputs

Outputs

Supported Platforms

Examples

Install the latest Bicep release

Pin a specific Bicep version

Use outputs to log the installed version

Combine with IPM sync in a Bicep deployment workflow

Windows

Update IPM

Account

Introduction

Interactive Mode

Introduction

Command Syntax

Required Parameters (option 1)

Required Parameters (option 2)

Examples

Introduction

Key Benefits

Use Cases

Introduction

What Are Verified Packages?

Introduction

Available for These Commands

Build Operation Summaries

Introduction

Prerequisites

Publishing Workflow

Basic Publishing

Introduction