Working from the Command Line

A kiwi-ng call consists of the global options, a service, a command of the service and the options of the command:

kiwi-ng [global options] <service> <command> [command options]

The global options are described in kiwi-ng. They must be given before the service. The following services and commands exist:

Command

Purpose

kiwi-ng system build

Build an image from an image description, the prepare and the create step in one call.

kiwi-ng system prepare

Create the root tree of an image from an image description.

kiwi-ng system create

Create the image from a prepared root tree.

kiwi-ng system update

Update a prepared root tree from its repositories.

kiwi-ng system boxbuild

Build an image in a self-contained virtual machine or container.

kiwi-ng system stash

Store a root tree as an OCI container, called a stash.

kiwi-ng system stackbuild

Build an image based on one or more stashes.

kiwi-ng result list

List the results of the last build in a target directory.

kiwi-ng result bundle

Bundle the results of a build for distribution.

kiwi-ng image info

Show information about an image description.

kiwi-ng image resize

Resize a disk image.

Plugins can add further commands to the system service.

Getting Help

--help shows the usage of kiwi-ng, of a service or of a command. The positional argument help after a command opens its manual page, which contains the same information as the command’s page in this documentation:

$ kiwi-ng system build --help
$ kiwi-ng system build help

Writing Options

  • An option and its value are separated by a space or by =, for example --target-dir /tmp/myimage or --target-dir=/tmp/myimage.

  • Options marked with ... can be given multiple times.

  • Shell completion is set up with kiwi-ng --install-completion, or printed for a custom setup with kiwi-ng --show-completion.