Metadata-Version: 2.4
Name: vmfinder
Version: 0.2.1
Summary: A libvirt-based VM management tool
Author-email: wheatfox <wheatfox17@icloud.com>
Maintainer-email: wheatfox <wheatfox17@icloud.com>
License: MIT License
        
        Copyright (c) 2025 wheatfox
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/enkerewpo/vmfinder
Project-URL: Repository, https://github.com/enkerewpo/vmfinder
Project-URL: Issues, https://github.com/enkerewpo/vmfinder/issues
Project-URL: Documentation, https://github.com/enkerewpo/vmfinder/blob/main/README.md
Keywords: libvirt,vm,virtualization,cloud,virtualization management
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: libvirt-python>=11.8.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: jinja2>=3.1.0
Requires-Dist: tabulate>=0.9.0
Requires-Dist: argcomplete>=3.0.0
Requires-Dist: requests>=2.25.0
Dynamic: license-file

# VMFinder

[![PyPI](https://img.shields.io/pypi/v/vmfinder.svg)](https://pypi.python.org/pypi/vmfinder)

## features
- vm creation and management
- template management
- cloud image support
- network management
- disk management
- virtio-fs shared folder support
- cloud-init support

## quick start

```bash
pip install vmfinder

vmfinder init
vmfinder install-completion
```

example usage:

```bash
vmfinder vm create rfuse_vm --template ubuntu-20.04 --cpu 12 --memory 20480 --disk-size 60 --force
vmfinder vm start rfuse_vm
vmfinder vm list
vmfinder vm console rfuse_vm
vmfinder vm ssh rfuse_vm
vmfinder vm ssh rfuse_vm --username ubuntu
vmfinder vm ssh rfuse_vm --key ~/.ssh/id_rsa
ssh -p 1234 ubuntu@<ip_address>
vmfinder vm set-password rfuse_vm
```

```bash
# extfuse
vmfinder vm create extfuse_vm --template ubuntu-16.04 --cpu 12 --memory 20480 --disk-size 60 --force
# cache_ext
vmfinder vm create cache_vm --template ubuntu-22.04 --cpu 12 --memory 20480 --disk-size 60 --force
# virtio-fs shared folder
vmfinder vm create vm1 \
    --template ubuntu-24.04 \
    --cpu 12 \
    --memory 20480 \
    --disk-size 80 \
    --force

# Start VM (virtiofsd will be started automatically)
vmfinder vm start vm1

# Manage virtiofsd manually
vmfinder virtiofs status vm1
vmfinder virtiofs stop vm1
vmfinder virtiofs start vm1 /path/to/shared/dir
vmfinder virtiofs restart vm1
```

**Note:** When creating a VM with `--virtiofs`, the virtiofsd daemon will be started automatically. The VM will automatically start/stop virtiofsd when you start/stop the VM. Inside the VM, mount the shared directory with:

```bash
sudo mkdir -p /mnt/shared
sudo mount -t virtiofs shared /mnt/shared
```

---

copyright 2025 wheatfox <<wheatfox17@icloud.com>>
