Skip to content

Latest commit

 

History

History
39 lines (37 loc) · 1.72 KB

README.md

File metadata and controls

39 lines (37 loc) · 1.72 KB
Raw

Engima: A new way to utilize Multipass

made-with-python

Hello! My name is Ty "WarpWing" Chermsirivatana and I'm writing this README to inform you of this CLI tool codenamed Engima! Engima is a Text User Interface tool for navigating the Multipass VM System by Canonical

What does it do?

It only does basic operations at the moment but I'll probably add more functionality soon.

  • Creating a Instance
  • Shell into a Instance
  • Deleting a Instance
  • Stopping a Instance
  • Purging/Permanently Deleting a Instance
  • Recovering a Instance

What could it do in the future

Later on, I plan to include the following

  • Ansible Registration
  • Cloudinit Support
  • Pip3 Package Intergration
  • Multi Worker Registration with Kubernetes
  • Better Intergration with Windows

Installation for Linux and MacOS

To install it, please do the following

git clone https://github.com/WarpWing/MultipassSimplified.git
pip3 install -r requirements.txt 
sudo chmod +x engima 
sudo cp engima /usr/bin/engima

Installation for Windows(Not optimized for Windows yet)

git clone https://github.com/WarpWing/MultipassSimplified.git
pip3 install -r requirements.txt
python3 engima

Contributing

Hey hey I see you want to contribute! If you want to contribute code, just write a quick PR and I'll take a look at the code or if you want to contribute ideas, just make a quick issue and we can discuss it!

Credits

  • WarpWing - The author of the README.md and the main active contributer to Engima
  • EnderBro1000 - A good friend of mine who contributed a bit to Engima