Skip to main content

Zilla Manager CLI

CLI

Zilla Manager CLI

The Zilla Manager command line interface uses the Zilla Manager Configuration to package the Zilla runtime with minimal dependencies.

Commands

zpm help

The zpm help command shows help information about available commands, or more information for a specific command.

zpm help [command]

Examples:

./zpmw help install

zpm clean

The zpm clean command removes files from its .zpm/ output directory.

Optionally, only the files necessary to execute the Zilla Runtime are kept intact, leaving a minimal installation footprint for deployment.

zpm clean

--keep-image

Default: false

Clean up everything except runtime image

Examples:

./zpmw clean --keep-image

zpm encrypt

The zpm encrypt command provides a convenient mechanism to encrypt secrets using a securely generated master secret.

When Maven repositories requiring authorization are listed in Zilla Manager Configuration, then the output of this command can be used to provide encrypted credentials in Zilla Manager Settings.

If a master secret does not already exist, it is generated in Zilla Manager Security.

zpm encrypt

Examples:

./zpmw encrypt

Enter a password to zpmw encrypt via standard input, then the base64-encoded encrypted password is displayed via standard output.

zpm install

The zpm install command resolves the Zilla Manager Configuration to create a runtime with minimal dependencies, generating the zilla runtime executable.

zpm install

--debug

Default: false

Link jdk.jdwp.agent module

--exclude-local-repository

Exclude the local Maven repository when resolving dependencies

--exclude-remote-repositories

Exclude remote Maven repositories when resolving dependencies

Examples:

./zpmw install

zpm wrap

The zpm wrap command generates an executable zpmw wrapper script that automatically downloads zpm if necessary before passing the arguments to zpm.

This approach avoids the need to manually install zpm and allows greater control over the version of zpm being used.

zpm wrap

--local-repository <locaRepolDir>

Default: ${user.home}/.m2/repository

Local Maven repository directory

--remote-repository <repoURL>

Default: https://maven.packages.aklivity.io

Remote Maven repository URL

--version <version>

Require zpm wrapper to use <version>

Example:

./zpmw wrap --version 0.9.8

Generates an executable zpmw script in the same directory, which can be used in place of zpm to first ensure that zpm version 0.9.8 is automatically downloaded into the .zpmw/ subdirectory if necessary.