https://github.com/calebstewart/rofi-libvirt-mode
A simple rofi custom script mode for interacting with libvirt domains
https://github.com/calebstewart/rofi-libvirt-mode
Last synced: about 1 month ago
JSON representation
A simple rofi custom script mode for interacting with libvirt domains
- Host: GitHub
- URL: https://github.com/calebstewart/rofi-libvirt-mode
- Owner: calebstewart
- Created: 2024-06-09T22:29:24.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-09T23:25:20.000Z (11 months ago)
- Last Synced: 2025-01-29T13:46:45.246Z (3 months ago)
- Language: Shell
- Size: 2.93 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rofi Libvirt Mode
This repository implements a custom Rofi script mode for interacting with libvirt domains.
The main menu shows a list of libvirt domains. Upon selecting a domain, a set of options
is provided for starting, stopping, editing or viewing the domain depending on the domain
state.
There is not currently any options for force-stopping or restarting a domain. This is mainly
for quickly interactin with domains and side-stepping the normal `virt-manager` UI, which
I dislike for my workflows.
The script depends on:
* `virt-manager` for editing VMs
* `virsh` for starting/stopping VMs
* `grep` and `coreutils` for parsing the output of `virsh`
* `virt-viewer` for opening a VM
The script assumes that `LIBVIRT_DEFAULT_URI` is set in the environment which is necessary
becasuse a connection argument is required to open `virt-manager` with a specific domain
view target. It is also obviously used by `virsh` to define the connection to be used.
## Installation
The `rofi-libvirt-mode` script can be placed anywhere. If you don't want to use the
absolute script path in your Rofi commands, you should place it under a directory
in your path (e.g. `~/.local/bin` is commonly in the user path).
In NixOS, you can add this repository as an input to your flake:
```nix
inputs.rofi-libvirt-mode = {
url = "github:calebstewart/rofi-libvirt-mode";
inputs.nixpkgs.follows = "nixpkgs";
};
```
Then, add the package to `environment.systemPackages` for NixOS or `home.packages`:
```nix
# For NixOS
environment.systemPackages = [rofi-libvirt-mode.packages.${system}.default];
# For Home Manager
home.packages = [rofi-libvirt-mode.packages.${system}.default];
```
Alternatively, you could generate command strings with the absolute Nix Store path
directly in your config without installing the command globally. For example, in
Hyprland, you could set:
```nix
wayland.windowManager.hyprland = {
settings = {
binds = [
"SUPER, M, exec, rofi -show libvirt -modes \"libvirt:${rofi-libvirt-mode.packages.${system}.default}/bin/rofi-libvirt-mode\""
];
};
};
```
## Usage
If installed within your path, you can execute the libvirt mode with:
```sh
rofi -show libvirt -modes "libvirt:rofi-libvirt-mode"
```
For more information on running custom script modes for rofi, see `man 5 rofi-script`.