lima

(โ˜… 21,727)

Linux virtual machines, with a focus on running containers

  • .codespellrc
  • .editorconfig
  • .gitignore
  • .gitmodules
  • .golangci.yml
  • .ls-lint.yml
  • .markdownlint.json
  • .protolint.yaml
  • .shellcheckrc
  • .yamllint
  • ADOPTERS.md
  • AGENTS.md
  • CLAUDE.md
  • go.mod
  • go.sum
  • LICENSE
  • MAINTAINERS.md
  • Makefile
  • NOTICE
  • README.md
  • ROADMAP.md
  • vz.entitlements

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/lima-vm/lima

Downloads the entire project code from GitHub to your computer.

cd lima

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install lima

Installs the pre-built package via Homebrew โ€” no source build required.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
limactl start template:docker

Type this command into your terminal and run it.

export DOCKER_HOST=$(limactl list docker --format 'unix://{{.Dir}}/sock/docker.sock')

Type this command into your terminal and run it.

docker run --rm hello-world

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd website

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation