Configuration
Storage locations, the image cache and telemetry settings.
Storage locations, the image cache and telemetry settings.
| Command | Description |
|---|---|
lume config get | Get current configuration. |
lume config storage | Manage VM storage locations. |
lume config storage add | Add a new VM storage location. |
lume config storage remove | Remove a VM storage location. |
lume config storage list | List all VM storage locations. |
lume config storage default | Set the default VM storage location. |
lume config cache | Manage image cache settings. |
lume config cache dir | Get or set cache directory. |
lume config cache enable | Enable image caching. |
lume config cache disable | Disable image caching. |
lume config cache status | Show cache status and directory. |
lume config telemetry | Manage pseudonymous telemetry settings. |
lume config telemetry status | Show current telemetry status. |
lume config telemetry enable | Enable pseudonymous telemetry. |
lume config telemetry disable | Disable pseudonymous telemetry. |
lume config telemetry reset-id | Delete the pseudonymous installation ID and registration markers. |
lume config registry | Manage container registry settings. |
lume config registry status | Show current registry configuration. |
lume config registry type | Get or set registry type. |
lume config registry ghcr | Configure GitHub Container Registry settings. |
lume config registry gcs | Configure GCS registry settings. |
lume config network | Manage network settings. |
lume config network interfaces | List available network interfaces for bridged networking. |
Every command also accepts the global options.
Get or set lume configuration.
Without a subcommand, prints the current configuration (lume config get).
lume config <COMMAND>lume config get#Get current configuration.
lume config getExamples
lume config getlume config storage#Manage VM storage locations.
lume config storage <COMMAND>lume config storage add#Add a new VM storage location.
lume config storage add <name> <path>| Argument | Type | Default | Description |
|---|---|---|---|
<name> | string | required | Storage name (letters, digits, dashes and underscores). |
<path> | string | required | Path to the VM storage directory. |
Examples
lume config storage add external /Volumes/External/lumelume config storage remove#Remove a VM storage location.
lume config storage remove <name>| Argument | Type | Default | Description |
|---|---|---|---|
<name> | string | required | Storage name to remove. |
Examples
lume config storage remove externallume config storage list#List all VM storage locations.
lume config storage listExamples
lume config storage listlume config storage default#Set the default VM storage location.
lume config storage default <name>| Argument | Type | Default | Description |
|---|---|---|---|
<name> | string | required | Storage name to set as default. |
Examples
lume config storage default externallume config cache#Manage image cache settings.
lume config cache <COMMAND>lume config cache dir#Get or set cache directory.
lume config cache dir [<path>]| Argument | Type | Default | Description |
|---|---|---|---|
<path> | string | optional | Path to the cache directory (omit to show the current one). |
Examples
lume config cache dir
lume config cache dir /Volumes/External/lume-cachelume config cache enable#Enable image caching.
lume config cache enableExamples
lume config cache enablelume config cache disable#Disable image caching.
lume config cache disableExamples
lume config cache disablelume config cache status#Show cache status and directory.
lume config cache statusExamples
lume config cache statuslume config telemetry#Manage pseudonymous telemetry settings.
lume config telemetry <COMMAND>lume config telemetry status#Show current telemetry status.
lume config telemetry statusExamples
lume config telemetry statuslume config telemetry enable#Enable pseudonymous telemetry.
lume config telemetry enableExamples
lume config telemetry enablelume config telemetry disable#Disable pseudonymous telemetry.
lume config telemetry disableExamples
lume config telemetry disablelume config telemetry reset-id#Delete the pseudonymous installation ID and registration markers.
lume config telemetry reset-idExamples
lume config telemetry reset-idlume config registry#Manage container registry settings.
lume config registry <COMMAND>lume config registry status#Show current registry configuration.
lume config registry statusExamples
lume config registry statuslume config registry type#Get or set registry type.
lume config registry type [<type>]| Argument | Type | Default | Description |
|---|---|---|---|
<type> | string | optional | Registry type to use: ghcr or gcs (omit to show the current one). |
Examples
lume config registry type
lume config registry type ghcrlume config registry ghcr#Configure GitHub Container Registry settings.
lume config registry ghcr [OPTIONS]| Flag | Type | Default | Description |
|---|---|---|---|
--registry | string | Registry URL (default: ghcr.io). | |
--organization | string | Organization or namespace (default: trycua). |
Examples
lume config registry ghcr --organization my-orglume config registry gcs#Configure GCS registry settings.
lume config registry gcs [OPTIONS]| Flag | Type | Default | Description |
|---|---|---|---|
--api-url | string | API URL for signed URL generation. | |
--api-key | string | API key for authentication. |
Examples
lume config registry gcs --api-url https://images.example.com --api-key <key>lume config network#Manage network settings.
lume config network <COMMAND>lume config network interfaces#List available network interfaces for bridged networking.
lume config network interfacesExamples
lume config network interfaces| Code | Meaning |
|---|---|
0 | Success. |
1 | The command failed (for example the VM does not exist or the operation errored). |
64 | Usage error: an unknown command or option, a missing argument, or an invalid value. |