This is the multi-page printable view of this section. Click here to print.
Command Reference
- 1: completion
- 2: completion bash
- 3: completion fish
- 4: completion powershell
- 5: completion zsh
- 6: copy
- 7: create
- 8: delete
- 9: disk
- 10: disk create
- 11: disk delete
- 12: disk list
- 13: disk resize
- 14: disk unlock
- 15: edit
- 16: factory-reset
- 17: info
- 18: limactl
- 19: list
- 20: protect
- 21: prune
- 22: shell
- 23: show-ssh
- 24: snapshot
- 25: snapshot apply
- 26: snapshot create
- 27: snapshot delete
- 28: snapshot list
- 29: start
- 30: start-at-login
- 31: stop
- 32: sudoers
- 33: tunnel
- 34: unprotect
- 35: validate
1 - completion
limactl completion
Generate the autocompletion script for the specified shell
Synopsis
Generate the autocompletion script for limactl for the specified shell. See each sub-command’s help for details on how to use the generated script.
Options
-h, --help help for completion
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
- limactl completion bash - Generate the autocompletion script for bash
- limactl completion fish - Generate the autocompletion script for fish
- limactl completion powershell - Generate the autocompletion script for powershell
- limactl completion zsh - Generate the autocompletion script for zsh
2 - completion bash
limactl completion bash
Generate the autocompletion script for bash
Synopsis
Generate the autocompletion script for the bash shell.
This script depends on the ‘bash-completion’ package. If it is not installed already, you can install it via your OS’s package manager.
To load completions in your current shell session:
source <(limactl completion bash)
To load completions for every new session, execute once:
Linux:
limactl completion bash > /etc/bash_completion.d/limactl
macOS:
limactl completion bash > $(brew --prefix)/etc/bash_completion.d/limactl
You will need to start a new shell for this setup to take effect.
limactl completion bash
Options
-h, --help help for bash
--no-descriptions disable completion descriptions
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl completion - Generate the autocompletion script for the specified shell
3 - completion fish
limactl completion fish
Generate the autocompletion script for fish
Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
limactl completion fish | source
To load completions for every new session, execute once:
limactl completion fish > ~/.config/fish/completions/limactl.fish
You will need to start a new shell for this setup to take effect.
limactl completion fish [flags]
Options
-h, --help help for fish
--no-descriptions disable completion descriptions
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl completion - Generate the autocompletion script for the specified shell
4 - completion powershell
limactl completion powershell
Generate the autocompletion script for powershell
Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
limactl completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command to your powershell profile.
limactl completion powershell [flags]
Options
-h, --help help for powershell
--no-descriptions disable completion descriptions
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl completion - Generate the autocompletion script for the specified shell
5 - completion zsh
limactl completion zsh
Generate the autocompletion script for zsh
Synopsis
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(limactl completion zsh)
To load completions for every new session, execute once:
Linux:
limactl completion zsh > "${fpath[1]}/_limactl"
macOS:
limactl completion zsh > $(brew --prefix)/share/zsh/site-functions/_limactl
You will need to start a new shell for this setup to take effect.
limactl completion zsh [flags]
Options
-h, --help help for zsh
--no-descriptions disable completion descriptions
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl completion - Generate the autocompletion script for the specified shell
6 - copy
limactl copy
Copy files between host and guest
Synopsis
Copy files between host and guest
Prefix guest filenames with the instance name and a colon.
Example: limactl copy default:/etc/os-release .
limactl copy SOURCE ... TARGET [flags]
Options
-h, --help help for copy
-r, --recursive copy directories recursively
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
7 - create
limactl create
Create an instance of Lima
limactl create FILE.yaml|URL [flags]
Examples
To create an instance "default" from the default Ubuntu template:
$ limactl create
To create an instance "default" from a template "docker":
$ limactl create --name=default template://docker
To create an instance "default" with modified parameters:
$ limactl create --cpus=2 --memory=2
To create an instance "default" with yq expressions:
$ limactl create --set='.cpus = 2 | .memory = "2GiB"'
To see the template list:
$ limactl create --list-templates
To create an instance "default" from a local file:
$ limactl create --name=default /usr/local/share/lima/templates/fedora.yaml
To create an instance "default" from a remote URL (use carefully, with a trustable source):
$ limactl create --name=default https://raw.githubusercontent.com/lima-vm/lima/master/templates/alpine.yaml
To create an instance "local" from a template passed to stdin (--name parameter is required):
$ cat template.yaml | limactl create --name=local -
Options
--arch string machine architecture (x86_64, aarch64, riscv64)
--containerd string containerd mode (user, system, user+system, none)
--cpus int number of CPUs
--disk float32 disk size in GiB
--dns ipSlice specify custom DNS (disable host resolver) (default [])
-h, --help help for create
--list-templates list available templates and exit
--memory float32 memory in GiB
--mount strings directories to mount, suffix ':w' for writable (Do not specify directories that overlap with the existing mounts)
--mount-inotify enable inotify for mounts
--mount-type string mount type (reverse-sshfs, 9p, virtiofs)
--mount-writable make all mounts writable
--name string override the instance name
--network strings additional networks, e.g., "vzNAT" or "lima:shared" to assign vmnet IP
--plain plain mode. Disable mounts, port forwarding, containerd, etc.
--rosetta enable Rosetta (for vz instances)
--set string modify the template inplace, using yq syntax
--video enable video output (has negative performance impact for QEMU)
--vm-type string virtual machine type (qemu, vz)
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
8 - delete
limactl delete
Delete an instance of Lima.
limactl delete INSTANCE [INSTANCE, ...] [flags]
Options
-f, --force forcibly kill the processes
-h, --help help for delete
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
9 - disk
limactl disk
Lima disk management
Examples
Create a disk:
$ limactl disk create DISK --size SIZE [--format qcow2]
List existing disks:
$ limactl disk ls
Delete a disk:
$ limactl disk delete DISK
Resize a disk:
$ limactl disk resize DISK --size SIZE
Options
-h, --help help for disk
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
- limactl disk create - Create a Lima disk
- limactl disk delete - Delete one or more Lima disks
- limactl disk list - List existing Lima disks
- limactl disk resize - Resize existing Lima disk
- limactl disk unlock - Unlock one or more Lima disks
10 - disk create
limactl disk create
Create a Lima disk
limactl disk create DISK [flags]
Examples
To create a new disk:
$ limactl disk create DISK --size SIZE [--format qcow2]
Options
--format string specify the disk format (default "qcow2")
-h, --help help for create
--size string configure the disk size
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl disk - Lima disk management
11 - disk delete
limactl disk delete
Delete one or more Lima disks
limactl disk delete DISK [DISK, ...] [flags]
Examples
To delete a disk:
$ limactl disk delete DISK
To delete multiple disks:
$ limactl disk delete DISK1 DISK2 ...
Options
-f, --force force delete
-h, --help help for delete
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl disk - Lima disk management
12 - disk list
limactl disk list
List existing Lima disks
limactl disk list [flags]
Examples
To list existing disks:
$ limactl disk list
Options
-h, --help help for list
--json JSONify output
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl disk - Lima disk management
13 - disk resize
limactl disk resize
Resize existing Lima disk
limactl disk resize DISK [flags]
Examples
Resize a disk:
$ limactl disk resize DISK --size SIZE
Options
-h, --help help for resize
--size string Disk size
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl disk - Lima disk management
14 - disk unlock
limactl disk unlock
Unlock one or more Lima disks
limactl disk unlock DISK [DISK, ...] [flags]
Examples
Emergency recovery! If an instance is force stopped, it may leave a disk locked while not actually using it.
To unlock a disk:
$ limactl disk unlock DISK
To unlock multiple disks:
$ limactl disk unlock DISK1 DISK2 ...
Options
-h, --help help for unlock
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl disk - Lima disk management
15 - edit
limactl edit
Edit an instance of Lima or a template
limactl edit INSTANCE|FILE.yaml [flags]
Options
--cpus int number of CPUs
--dns ipSlice specify custom DNS (disable host resolver) (default [])
-h, --help help for edit
--memory float32 memory in GiB
--mount strings directories to mount, suffix ':w' for writable (Do not specify directories that overlap with the existing mounts)
--mount-inotify enable inotify for mounts
--mount-type string mount type (reverse-sshfs, 9p, virtiofs)
--mount-writable make all mounts writable
--network strings additional networks, e.g., "vzNAT" or "lima:shared" to assign vmnet IP
--rosetta enable Rosetta (for vz instances)
--set string modify the template inplace, using yq syntax
--video enable video output (has negative performance impact for QEMU)
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
16 - factory-reset
limactl factory-reset
Factory reset an instance of Lima
limactl factory-reset INSTANCE [flags]
Options
-h, --help help for factory-reset
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
17 - info
limactl info
Show diagnostic information
limactl info [flags]
Options
-h, --help help for info
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
18 - limactl
limactl
Lima: Linux virtual machines
Examples
Start the default instance:
$ limactl start
Open a shell:
$ lima
Run a container:
$ lima nerdctl run -d --name nginx -p 8080:80 nginx:alpine
Stop the default instance:
$ limactl stop
See also template YAMLs: /usr/local/share/lima/templates
Options
--debug debug mode
-h, --help help for limactl
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl completion - Generate the autocompletion script for the specified shell
- limactl copy - Copy files between host and guest
- limactl create - Create an instance of Lima
- limactl delete - Delete an instance of Lima.
- limactl disk - Lima disk management
- limactl edit - Edit an instance of Lima or a template
- limactl factory-reset - Factory reset an instance of Lima
- limactl info - Show diagnostic information
- limactl list - List instances of Lima.
- limactl protect - Protect an instance to prohibit accidental removal
- limactl prune - Prune garbage objects
- limactl shell - Execute shell in Lima
- limactl show-ssh - Show the ssh command line (DEPRECATED; use
ssh -F
instead) - limactl snapshot - Manage instance snapshots
- limactl start - Start an instance of Lima
- limactl start-at-login - Register/Unregister an autostart file for the instance
- limactl stop - Stop an instance
- limactl sudoers - Generate the content of the /etc/sudoers.d/lima file
- limactl tunnel - Create a tunnel for Lima
- limactl unprotect - Unprotect an instance
- limactl validate - Validate YAML files
19 - list
limactl list
List instances of Lima.
Synopsis
List instances of Lima.
The output can be presented in one of several formats, using the –format
–format json - output in json format
–format yaml - output in yaml format
–format table - output in table format
–format ‘{{
These functions are available to go templates:
indent
The following legacy flags continue to function: –json - equal to ‘–format json’
limactl list [flags] [INSTANCE]...
Options
--all-fields Show all fields
-f, --format string output format, one of: json, yaml, table, go-template (default "table")
-h, --help help for list
--json JSONify output
--list-fields List fields available for format
-q, --quiet Only show names
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
20 - protect
limactl protect
Protect an instance to prohibit accidental removal
Synopsis
Protect an instance to prohibit accidental removal via the ’limactl delete’ command. The instance is not being protected against removal via ‘/bin/rm’, Finder, etc.
limactl protect INSTANCE [INSTANCE, ...] [flags]
Options
-h, --help help for protect
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
21 - prune
limactl prune
Prune garbage objects
limactl prune [flags]
Options
-h, --help help for prune
--keep-referred Keep objects that are referred by some instances or templates
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
22 - shell
limactl shell
Execute shell in Lima
Synopsis
Execute shell in Lima
lima command is provided as an alias for limactl shell $LIMA_INSTANCE. $LIMA_INSTANCE defaults to “default”.
By default, the first ‘ssh’ executable found in the host’s PATH is used to connect to the Lima instance. A custom ssh alias can be used instead by setting the $SSH environment variable.
Hint: try –debug to show the detailed logs, if it seems hanging (mostly due to some SSH issue).
limactl shell [flags] INSTANCE [COMMAND...]
Options
-h, --help help for shell
--shell string shell interpreter, e.g. /bin/bash
--workdir string working directory
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
23 - show-ssh
limactl show-ssh
Show the ssh command line (DEPRECATED; use ssh -F
instead)
Synopsis
Show the ssh command line (DEPRECATED)
WARNING: ’limactl show-ssh’ is deprecated. Instead, use ‘ssh -F ~/.lima/default/ssh.config lima-default’ .
limactl show-ssh [flags] INSTANCE
Examples
"cmd" format (default): Full ssh command line.
$ limactl show-ssh --format=cmd default
ssh -o IdentityFile="/Users/example/.lima/_config/user" -o User=example -o Hostname=127.0.0.1 -o Port=60022 lima-default
"args" format: Similar to the cmd format but omits "ssh" and the destination address
$ limactl show-ssh --format=args default
-o IdentityFile="/Users/example/.lima/_config/user" -o User=example -o Hostname=127.0.0.1 -o Port=60022
"options" format: ssh option key value pairs
$ limactl show-ssh --format=options default
IdentityFile="/Users/example/.lima/_config/user"
User=example
Hostname=127.0.0.1
Port=60022
"config" format: ~/.ssh/config format
$ limactl show-ssh --format=config default
Host lima-default
IdentityFile "/Users/example/.lima/_config/user "
User example
Hostname 127.0.0.1
Port 60022
To show the config file path:
$ limactl ls --format='{{.SSHConfigFile}}' default
/Users/example/.lima/default/ssh.config
Options
-f, --format string Format: cmd, args, options, config (default "cmd")
-h, --help help for show-ssh
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
24 - snapshot
limactl snapshot
Manage instance snapshots
Options
-h, --help help for snapshot
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
- limactl snapshot apply - Apply (load) a snapshot
- limactl snapshot create - Create (save) a snapshot
- limactl snapshot delete - Delete (del) a snapshot
- limactl snapshot list - List existing snapshots
25 - snapshot apply
limactl snapshot apply
Apply (load) a snapshot
limactl snapshot apply INSTANCE [flags]
Options
-h, --help help for apply
--tag string name of the snapshot
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl snapshot - Manage instance snapshots
26 - snapshot create
limactl snapshot create
Create (save) a snapshot
limactl snapshot create INSTANCE [flags]
Options
-h, --help help for create
--tag string name of the snapshot
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl snapshot - Manage instance snapshots
27 - snapshot delete
limactl snapshot delete
Delete (del) a snapshot
limactl snapshot delete INSTANCE [flags]
Options
-h, --help help for delete
--tag string name of the snapshot
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl snapshot - Manage instance snapshots
28 - snapshot list
limactl snapshot list
List existing snapshots
limactl snapshot list INSTANCE [flags]
Options
-h, --help help for list
-q, --quiet Only show tags
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl snapshot - Manage instance snapshots
29 - start
limactl start
Start an instance of Lima
limactl start NAME|FILE.yaml|URL [flags]
Examples
To create an instance "default" (if not created yet) from the default Ubuntu template, and start it:
$ limactl start
To create an instance "default" from a template "docker", and start it:
$ limactl start --name=default template://docker
'limactl start' also accepts the 'limactl create' flags such as '--set'.
See the examples in 'limactl create --help'.
Options
--arch string [limactl create] machine architecture (x86_64, aarch64, riscv64)
--containerd string [limactl create] containerd mode (user, system, user+system, none)
--cpus int [limactl create] number of CPUs
--disk float32 [limactl create] disk size in GiB
--dns ipSlice [limactl create] specify custom DNS (disable host resolver) (default [])
--foreground run the hostagent in the foreground
-h, --help help for start
--list-templates [limactl create] list available templates and exit
--memory float32 [limactl create] memory in GiB
--mount strings [limactl create] directories to mount, suffix ':w' for writable (Do not specify directories that overlap with the existing mounts)
--mount-inotify [limactl create] enable inotify for mounts
--mount-type string [limactl create] mount type (reverse-sshfs, 9p, virtiofs)
--mount-writable [limactl create] make all mounts writable
--name string [limactl create] override the instance name
--network strings [limactl create] additional networks, e.g., "vzNAT" or "lima:shared" to assign vmnet IP
--plain [limactl create] plain mode. Disable mounts, port forwarding, containerd, etc.
--rosetta [limactl create] enable Rosetta (for vz instances)
--set string [limactl create] modify the template inplace, using yq syntax
--timeout duration duration to wait for the instance to be running before timing out (default 10m0s)
--video [limactl create] enable video output (has negative performance impact for QEMU)
--vm-type string [limactl create] virtual machine type (qemu, vz)
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
30 - start-at-login
limactl start-at-login
Register/Unregister an autostart file for the instance
limactl start-at-login INSTANCE [flags]
Options
--enabled Automatically start the instance when the user logs in (default true)
-h, --help help for start-at-login
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
31 - stop
limactl stop
Stop an instance
limactl stop INSTANCE [flags]
Options
-f, --force force stop the instance
-h, --help help for stop
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
32 - sudoers
limactl sudoers
Generate the content of the /etc/sudoers.d/lima file
Synopsis
Generate the content of the /etc/sudoers.d/lima file for enabling vmnet.framework support. The content is written to stdout, NOT to the file. This command must not run as the root user. See https://lima-vm.io/docs/config/network/#socket_vmnet for the usage.
limactl sudoers [--check [SUDOERSFILE-TO-CHECK]] [flags]
Examples
To generate the /etc/sudoers.d/lima file:
$ limactl sudoers | sudo tee /etc/sudoers.d/lima
To validate the existing /etc/sudoers.d/lima file:
$ limactl sudoers --check /etc/sudoers.d/lima
Options
--check check that the sudoers file is up-to-date with "~/.lima/_config/networks.yaml"
-h, --help help for sudoers
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
33 - tunnel
limactl tunnel
Create a tunnel for Lima
Synopsis
Create a tunnel for Lima
Create a SOCKS tunnel so that the host can join the guest network.
limactl tunnel [flags] INSTANCE
Options
-h, --help help for tunnel
--socks-port int SOCKS port, defaults to a random port
--type string Tunnel type, currently only "socks" is implemented (default "socks")
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
34 - unprotect
limactl unprotect
Unprotect an instance
limactl unprotect INSTANCE [INSTANCE, ...] [flags]
Options
-h, --help help for unprotect
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines
35 - validate
limactl validate
Validate YAML files
limactl validate FILE.yaml [FILE.yaml, ...] [flags]
Options
--fill fill defaults
-h, --help help for validate
Options inherited from parent commands
--debug debug mode
--log-format string Set the logging format [text, json] (default "text")
--log-level string Set the logging level [trace, debug, info, warn, error]
--tty Enable TUI interactions such as opening an editor. Defaults to true when stdout is a terminal. Set to false for automation.
SEE ALSO
- limactl - Lima: Linux virtual machines