UII CLI client
This repository contains a command line client for Virtomize Unattended Install Images API.
It is intended both for day to day use, and to demonstrate the usage of the API for other projects.
Requirements
In order to use this client, you need an API token form the cloud api.
A token can be created using the Virtomize website.
This token can be passed to each command using --token=123456
.
Alternatively, the client will use the value provided in the UIIAPITOKEN
environment variable.
Usage
The client supports the following commands:
Help
Use --help
or -h
to print a list of all available commands.
Building an ISO
The build
command can be used to build an ISO.
The following example command will build an ISO file named foo.iso
, which will install Debian linux in version 11 using hostname
as the hostname.
Example:
uii-go-cli build foo.iso debian 11 hostname --token=1234567890ABCDEFGHIJKL
List available operation systems
The ls os
command can be used to list all available operating systems.
Example:
uii-go-cli ls os
List available packages for an operating systems
The ls package
command can be used to list all available operating systems.
Example:
uii-go-cli ls package debian 11
This command can produce quite a bit of output.
Piping the result into less is a good way to address this.
uii-go-cli ls package debian 11 | less
Contribution
Thank you for participating to this project.
Please see our Contribution Guidlines for more information.
Pre-Commit
This repo uses pre-commit hooks. Please install pre-commit and do pre-commit install
Conventional Commits
Format commit messaged according to Conventional Commits standard.
Semantic Versioning
Whenever you need to version something make use of Semantic Versioning.