Skip to content
vGPU OS
Documentation: Commands

Documentation · Usage

Commands

Reference for the vgpu-os command, keyboard shortcuts and access through the console and SSH.

Alpha

This documentation covers vGPU OS 0.1.2, in alpha. Screens and commands may change between versions; to see the installed version, use vgpu-os version.

vGPU OS has its own command, vgpu-os, to inspect and diagnose the system. The OSX-REIMS commands are in its documentation (opens in a new tab).

Opening a terminal

  • In the session menu (when exiting the OSX-REIMS console), press s.
  • Ctrl+Alt+F2: text login screen. Log in as vgpu-user. Ctrl+Alt+F1 returns to the session.
  • Over SSH, from another computer on the network: ssh vgpu-user@<ip-address>. root login over SSH is refused; use sudo.

vgpu-os version

Shows the vGPU OS version, the Debian and kernel versions, and the OSX-REIMS version bundled in the ISO and the one installed.

vgpu-os version

vgpu-os hw

Hardware detection and validation — the same code used by the first setup.

Command What it does
vgpu-os hw detect Examines the computer: processor, virtualization, KVM, IOMMU, GPUs, and Vulkan
vgpu-os hw plan Says what would be installed, and why, without installing anything
vgpu-os hw validate Walks through the graphics chain and shows READY or the failure found; also checks KVM
vgpu-os hw report Readable summary of everything above

vgpu-os hw provision and vgpu-os hw drivers install the plan; normally they are called by the first setup.

vgpu-os diagnostics

Gathers everything needed to understand a problem: system identity, OSX-REIMS, Reims vGPU, hardware, graphics validation, PCI, DRM, kernel modules, Vulkan, KVM, IOMMU, network, storage, appliance state, boot times, services, recent kernel errors, and logs, including from the previous boot.

vgpu-os diagnostics
Option What it does
--save Also saves the report to a file and shows where, so you can send it to whoever is helping
--splash Explains why the loading screen did not appear

The report does not collect passwords, keys, or serial numbers: it was designed to be shared safely when asking for help.

The Boot section shows how long startup took and how long each vGPU OS stage took. Start there when the computer seems slow to boot.

Rerunning the first setup

sudo vgpu-os-firstboot --force

Runs the first setup again: network, hardware, drivers, OSX-REIMS, and validation.

Keyboard shortcuts

Shortcut Where What it does
Esc While the computer boots Shows the hidden boot menu
Ctrl+Alt+F2 In the session Text login screen
Ctrl+Alt+F1 On the text login screen Returns to the session
Enter, s, r, p Session menu Console again, terminal, restart, shut down