{"id":17661087,"url":"https://github.com/alessiodionisi/vmkit","last_synced_at":"2025-05-07T17:29:21.998Z","repository":{"id":39031748,"uuid":"359372085","full_name":"alessiodionisi/vmkit","owner":"alessiodionisi","description":"Spin up Linux VMs with QEMU","archived":false,"fork":false,"pushed_at":"2025-04-08T00:46:17.000Z","size":2960,"stargazers_count":20,"open_issues_count":8,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T17:29:15.876Z","etag":null,"topics":["aarch64","arm64","linux","macos","qemu","virtual-machine","x86-64"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alessiodionisi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":"FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["alessiodionisi"]}},"created_at":"2021-04-19T07:44:31.000Z","updated_at":"2025-03-08T20:25:37.000Z","dependencies_parsed_at":"2024-01-16T18:05:21.007Z","dependency_job_id":"b97d4c8d-9e32-4cc3-a862-39493dc65eeb","html_url":"https://github.com/alessiodionisi/vmkit","commit_stats":null,"previous_names":["adnsio/vmkit"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alessiodionisi%2Fvmkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alessiodionisi%2Fvmkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alessiodionisi%2Fvmkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alessiodionisi%2Fvmkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alessiodionisi","download_url":"https://codeload.github.com/alessiodionisi/vmkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252926161,"owners_count":21826254,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aarch64","arm64","linux","macos","qemu","virtual-machine","x86-64"],"created_at":"2024-10-23T17:10:14.593Z","updated_at":"2025-05-07T17:29:21.962Z","avatar_url":"https://github.com/alessiodionisi.png","language":"Go","funding_links":["https://github.com/sponsors/alessiodionisi"],"categories":[],"sub_categories":[],"readme":"# VMKit\n\nSpin up Linux VMs with QEMU.\n\n![Docker running on ARM64 Virtual Machine](/docs/docker.png)\n_In the above image: Docker running on ARM64 Ubuntu Virtual Machine._\n\n## Requirements\n\n- Linux, macOS or Windows (needs testing) host OS.\n- [QEMU](https://www.qemu.org) installed and available in the image, you can install it with homebrew or your package manager of choice. VMKit uses `qemu-img` binary, `qemu-system-aarch64` binary on ARM64 and `qemu-system-x86_64` binary on AMD64.\n\n## Getting started\n\n### Install VMKit\n\nThe only way for now is to have a working Go environment and install VMKit by running this command:\n\n```shell\ngo install github.com/alessiodionisi/vmkit@latest\n```\n\n### Create your first vitual machine\n\nCreate a Debian 12 (Bookworm) virtual machine with 4 CPUs, 4096 mebibytes of ram and 20 GB of disk by running this command:\n\n```shell\nvmkit run debian12 -i debian:bookworm -c 4 -m 4096 -d 20\n```\n\n### Run a command in the virtual machine\n\nRun `uname -a` inside the virtual machine by running this command:\n\n```shell\nvmkit exec debian12 -- uname -a\n```\n\n### Connect to the virtual machine via SSH\n\nYou can get SSH parameters by running this command:\n\n```shell\nvmkit ssh debian12\n```\n\nOn Unix systems you can quickly connect via SSH by running this command:\n\n```shell\n$(vmkit ssh debian12 --command)\n```\n\n## Commands\n\n### Create a virtual machines (`vmkit run`)\n\nWith `vmkit run` you can create and start a new virtual machine.\n\nVMKit will automatically create a pair of SSH keys and configure the chosen system via `cloud-init`. If not specified, a forward to guest port 22 will be created using a free port. This will be used to access the virtual machine via SSH.\n\nExample:\n\n```shell\nvmkit run debian12 -i debian:bookworm -c 4 -m 4096 -d 20\n```\n\nAvailable options:\n\n- `-c`, `--cpu` number of cpu(s) (example: `-c 4`)\n- `-d`, `--disk-size` disk size in gigabytes (GB) (example: `-d 20`)\n- `-i`, `--image` image to use (example: `-i debian:bookworm`)\n- `-m`, `--memory` ram in mebibytes (MiB) (example: `-m 4096`)\n- `-p`, `--port-forward` forward host port to the virtual machine (example: `-p 8080-80`, `-p [host]-[guest]`)\n\n### Remove a virtual machine (`vmkit remove|rm`)\n\nWith `vmkit remove` or `vmkit rm` you can remove a virtual machine.\n\nExample:\n\n```shell\nvmkit remove debian12\n```\n\n### Start a virtual machine (`vmkit start`)\n\nWith `vmkit start` you can start a virtual machine.\n\nExample:\n\n```shell\nvmkit start debian12\n```\n\n### Stop a virtual machine (`vmkit stop`)\n\nWith `vmkit stop` you can stop a virtual machine.\n\nExample:\n\n```shell\nvmkit stop debian12\n```\n\n## Contributing\n\n### Requirements\n\n- [Go](https://golang.org) installed and available in the system.\n- [Task](https://taskfile.dev) installed and available in the system.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falessiodionisi%2Fvmkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falessiodionisi%2Fvmkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falessiodionisi%2Fvmkit/lists"}