Skip to content
Open

docs #4297

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion website/content/en/docs/config/ai/inside/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ weight: 10
Lima is useful for running AI agents (e.g., Claude Code, Codex, Gemini)
inside a VM, so as to prevent agents from directly reading, writing, or executing the host files.

See [Examples » AI](../../../examples/ai.md).
See also:
- [Examples » AI](../../../examples/ai.md).
- [Config » GPU](../../gpu.md)
14 changes: 14 additions & 0 deletions website/content/en/docs/config/gpu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: GPU acceleration
weight: 90
---

Lima VM supports GPU acceleration for the following VM types:
- [krunkit](./vmtype/krunkit.md).

{{% alert title="Note" color=success %}}
"Lima" in this web site refers to [the Lima VM project](https://lima-vm.io).

The Lima VM project is unrelated to [the Lima driver project (driver for ARM Mali GPUs)](https://gitlab.freedesktop.org/lima),
which appears as "Lima" in the documentations of [Mesa 3D](https://docs.mesa3d.org/drivers/lima.html), etc.
{{% /alert %}}
5 changes: 4 additions & 1 deletion website/content/en/docs/config/plugin/cli.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: CLI plugins (Experimental)
title: CLI plugins
weight: 2
---

> **Warning**
> Support for CLI plugins is experimental

| ⚡ Requirement | Lima >= 2.0 |
|----------------|-------------|

Expand Down
4 changes: 2 additions & 2 deletions website/content/en/docs/config/vmtype/krunkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ title: Krunkit
weight: 4
---

> Warning
> **Warning**
> "krunkit" is experimental

| ⚡ Requirement | Lima >= 2.0, macOS >= 13 (Ventura+), Apple Silicon (arm64) |
| ⚡ Requirement | Lima >= 2.0, macOS >= 14 (Sonoma+), Apple Silicon (arm64) |
| ------------- | ----------------------------------------------------------- |

Krunkit runs super‑light VMs on macOS/ARM64 with a focus on GPU access. It builds on [libkrun](https://github.com/containers/libkrun), a library that embeds a VMM so apps can launch processes in a hardware‑isolated VM (HVF on macOS, KVM on Linux). The standout feature is GPU support in the guest via Mesa’s Venus Vulkan driver ([venus](https://docs.mesa3d.org/drivers/venus.html)), enabling Vulkan workloads inside the VM. See the project: [containers/krunkit](https://github.com/containers/krunkit).
Expand Down
1 change: 1 addition & 0 deletions website/content/en/docs/examples/ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,4 @@ See also <https://github.com/github/copilot-cli>.
## See also

- [Config » AI](../config/ai/)
- [Config » GPU](../config/gpu.md)
10 changes: 10 additions & 0 deletions website/content/en/docs/releases/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,13 @@ weight: 300
---

See <https://github.com/lima-vm/lima/releases> for the latest release.

## Lifecycle

| Release | Begin | End |
|---------|------------|----------------------------------|
| v2.x | 2025-11-06 | Undecided (v3 Begin + 3 months) |
| v1.x | 2024-11-06 | 2026-02-06 (v2 Begin + 3 months) |
| v0.x | 2021-05-14 | 2024-11-06 (v1 Begin + 0 days) |

Since Lima v1.x, each major release receives security updates and critical bug fixes until three months after the next major release.
28 changes: 28 additions & 0 deletions website/content/en/docs/releases/breaking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Breaking changes
weight: 20
---

## [v2.0.0](https://github.com/lima-vm/lima/releases/tag/v2.0.0)
- `/tmp/lima` is no longer mounted by default.
- SSH port is no longer hard-coded to 60022 for the "default" instance.
- Port forwarding with `sudo nerdctl run -p` no longer works with nerdctl prior to v2.1.6.
- The default of `guestIPMustBeZero` was changed from `false` to `true` when `guestIP` is `0.0.0.0`.

## [v1.1.0](https://github.com/lima-vm/lima/releases/tag/v1.1.0)
- The `lima-additional-guestagent` package was split from the main `lima` package.

## [v1.0.0](https://github.com/lima-vm/lima/releases/tag/v1.0.0)
- The default [VM type](../config/vmtype/_index.md) was changed from `qemu` to `vz` on macOS hosts with the support for `vz`.
- The default [mount type](../config/mount.md) was changed from `reverse-sshfs` to `virtiofs` for `vz`, `9p` for `qemu`.
- `socket_vmnet` binary has to be strictly owned by root.
- The default value of `ssh.loadDotSSHPubKeys` was changed from `true` to `false`.
- Several templates were removed or renamed.

## [v0.22.0](https://github.com/lima-vm/lima/releases/tag/v0.22.0)
- Support for `vde_vmnet` was dropped in favor of `socket_vmnet`.

## [v0.3.0](https://github.com/lima-vm/lima/releases/tag/v0.3.0)
- `limactl start` no longer starts a VM in the foreground.

See also <https://github.com/lima-vm/lima/releases>.
11 changes: 7 additions & 4 deletions website/content/en/docs/releases/deprecated.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ weight: 10

The following features are deprecated:

- CentOS 7 support
- Loading non-strict YAMLs (i.e., YAMLs with unknown properties)
- `limactl show-ssh` command (Use `ssh -F ~/.lima/default/ssh.config lima-default` instead)
- Ansible provisioning mode (Use `ansible-playbook playbook.yaml` after the start instead)
- `limactl show-ssh` command: deprecated in v0.18.0 (Use `ssh -F ~/.lima/default/ssh.config lima-default` instead)
- Ansible provisioning mode: deprecated in Lima v1.1.0 (Use `ansible-playbook playbook.yaml` after the start instead)
- `limactl --yes` flag: deprecated in Lima v2.0.0 (Use `limactl (clone|rename|edit|shell) --start` instead)

## Removed features
- YAML property `network`: deprecated in [Lima v0.7.0](https://github.com/lima-vm/lima/commit/07e68230e70b21108d2db3ca5e0efd0e43842fbd)
Expand All @@ -17,3 +16,7 @@ The following features are deprecated:
and removed in Lima v0.14.0,in favor of `hostResolver.enabled`
- VDE support, including VNL and `vde_vmnet`: deprecated in [Lima v0.12.0](https://github.com/lima-vm/lima/pull/851/commits/b5e0d5abd0fb2f74b7ddf8faea7a855b5a14ceda)
and removed in Lima v0.22.0, in favor of `socket_vmnet`
- CentOS 7 guest support: deprecated in Lima v0.9.2 and removed in Lima v0.23.0, in favor of CentOS Stream, AlmaLinux, and Rocky Linux.

## Undeprecated features
- Loading non-strict YAMLs (i.e., YAMLs with unknown properties): once deprecated in Lima v0.12.0, but undeprecated in Lima v1.0.4
1 change: 1 addition & 0 deletions website/content/en/docs/releases/experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The following features are experimental and subject to change:
- `audio.device`
- `mountInotify: true`
- `External drivers`: building and using drivers as separate executables (see [Virtual Machine Drivers](../dev/drivers))
- [`vmType: krunkit`](../config/vmtype/krunkit.md)

The following commands are experimental and subject to change:

Expand Down