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 |
|---|---|
Build an image from an image description, the prepare and the create step in one call. |
|
Create the root tree of an image from an image description. |
|
Create the image from a prepared root tree. |
|
Update a prepared root tree from its repositories. |
|
Build an image in a self-contained virtual machine or container. |
|
Store a root tree as an OCI container, called a stash. |
|
Build an image based on one or more stashes. |
|
List the results of the last build in a target directory. |
|
Bundle the results of a build for distribution. |
|
Show information about an image description. |
|
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/myimageor--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 withkiwi-ng --show-completion.