Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.minimus.io/llms.txt

Use this file to discover all available pages before exploring further.

minicli is the Minimus command-line tool for managing private images. Use it to define, build, and manage private images as code directly from your terminal or CI/CD pipeline.

​
Installation

Download the latest binary for your architecture as explained.

​
Authentication

Generate a token from the Tokens page in the Minimus console, then export it in your terminal or CI/CD environment: 
export MINICLI_TOKEN={token}
All commands require MINICLI_TOKEN to be set. If the token is missing, minicli returns an error: 
Error: Authentication token not found. Please export your token: export MINICLI_TOKEN={token}.

​
Commands

​
version

Display the current version of the minicli binary. Does not require authentication. 
minicli version

​
image init

Create a local YAML template with all supported image fields, pre-populated with empty values for you to fill in. 
minicli image init --output custom.yaml
FlagShorthandDescription
--output-oFile path to save the template. Default: image.yaml
The generated file looks like this: 
apiVersion: v1
name:
baseImage:
additionalPackages:
envVars:
fileBundles:
description:

​
image apply

Create or update a private image recipe from a local YAML file. Follow up with the command image build submit to trigger a build of your updated image. 
minicli image apply --file images/custom.yaml
FlagShorthandDescription
--file-fRequired. Path to the YAML file
If the YAML is invalid, minicli returns a detailed list of errors, for example: 
✗ YAML file validation failed:
  - envVars: "INVALID_KEY" is not a valid key=value format.
  - other: invalid field (doesn't exist).

​
image build submit

Trigger an asynchronous build for a private image. Returns immediately without waiting for the build to complete. Once the build is complete, you can view the image’s build report in Creator. Learn more 
minicli image build submit --name my-image
FlagShorthandDescription
--name-nName of the custom image to build

​
image build status

Look up the current status of a private image build. 
minicli image build status --name my-image

minicli image build status --name my-image
FlagShorthandDescription
--name-nName of the custom image

​
image export

Retrieve the configuration of a remote custom image and output it as a table or YAML file. You can export private image recipes to track changes in git. 
minicli image export --name my-image
minicli image export --name my-image --format yaml --output custom.yaml
FlagShorthandDescription
--name-nName of the custom image to export
--format-fOutput format: table or yaml. Default: table
--output-oFile path to write to. If omitted, prints to terminal
Table output example: 
Image Details:
-----------------------------------
ID:                  img_123
Name:                private-nginx
Base Image:          nginx:latest
Additional Packages: pkg1, pkg2
Env vars:            {"DEBUG": "true", "PORT": "80"}
Build Status:        READY
Build At:            2026-03-15 11:00:00
Created At:          2026-03-15 10:00:00
Updated At:          2026-03-21 15:00:00
Build trace ID:      bld_999
Description:         Production web server with security patches
File Bundles:        19, 82
YAML output example: 
apiVersion: v1
name: my-image
baseImage: nginx
additionalPackages:
  - pkg1
  - pkg2
envVars:
  DEBUG: "true"
  PORT: "80"
description: "Created via minicli"

​
image list

List your Minimus private images: 
minicli image list
FlagShorthandDescription
--custom-cList custom images. Default: true
--base-bList base images available in your license
You can also list base images available in your license for building more private images: 
minicli image list --base

​
image delete

Delete a private image from your account. Prompts for confirmation unless --yes is passed. 
minicli image delete --name my-image
minicli image delete --name my-image --yes
FlagShorthandDescription
--name-nName of the custom image to delete
--yes-ySkip the confirmation prompt

​
bundle list

List all file bundles in your account. File bundles are used to include public keys for internal PKIs (Public Key Infrastructure certificates) and override configuration files and more. Learn more 
minicli bundle list
Last modified on May 31, 2026