Skip to content

Commit

Permalink
Make README a bit more inviting
Browse files Browse the repository at this point in the history
  • Loading branch information
svenstaro committed Mar 2, 2025
1 parent 284e588 commit c5bbeeb
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# vmexec
Run a single command in a virtual machine
# vmexec - run a single command in a VM

[![CI](https://github.com/svenstaro/vmexec/workflows/CI/badge.svg)](https://github.com/svenstaro/vmexec/actions)
[![Crates.io](https://img.shields.io/crates/v/vmexec.svg)](https://crates.io/crates/vmexec)
[![license](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/svenstaro/vmexec/blob/master/LICENSE)
[![Stars](https://img.shields.io/github/stars/svenstaro/vmexec.svg)](https://github.com/svenstaro/vmexec/stargazers)
[![Lines of Code](https://tokei.rs/b1/github/svenstaro/vmexec)](https://github.com/svenstaro/vmexec)

**Run a single command in a virtual machine with zero-setup and great performance**

**vmexec** is a zero-setup CLI tool that runs single commands in a throwaway virtual machines.
The idea is for you to run a command a command in VM without having think about the performance implications, how to mount files, how to forward ports, etc.

Nowadays, many are used to the convenience of container runners such as `podman` or `docker` but so far it hasn't been as covenient to run a VM, often requiring a manual set up step.

It has a `docker run`-inspired interface that many should already be familiar with.

## Requirements

Expand All @@ -9,3 +23,5 @@ Run a single command in a virtual machine
## TODO

- Document/bench KSM
- Port forwarding
- Better README

0 comments on commit c5bbeeb

Please sign in to comment.