Fork me on GitHub

vibox

cli helper for VirtualBox Management

leny — bash

machine:~ leny$ vibox list -s

IE7 {3ca17e1c-49b9-4e49-9d50-53767d2fe2bc} poweroff

IE9 {808bd258-e1c8-460e-a421-cf78297ae0e5} poweroff

IE10 {4e60848d-b316-42d9-80f9-b8b41bc3eed3} poweroff

nodebase {515004b4-fe11-4be3-9da1-8d9c84260877} poweroff

hyperbase {e1fbdd95-0115-45d2-be98-2250ed94716a} running

vibox is a simple manager for your VirtualBoxes' VMs.

Actually, it's just a wrapper over VBoxManage, but more simple and with completion.

It's free, built with node.js, and made with


First steps

vibox is built with node.js, so it must be installed on your computer.

Install the module with: npm install vibox

To benefit from completion, add the following line to your .profile, or .bash_rc, or whatever :
which vibox > /dev/null && . "$( vibox --initpath )"

Purpose

vibox is a cli tools, so if you type some commands, vibox would do awesome things.

list

vibox list [options]

Options

-s, --state
Display state of VMs
-r, --running
Show running VMs only
leny — bash — vibox list

machine:~ leny$ vibox list

IE7 {3ca17e1c-49b9-4e49-9d50-53767d2fe2bc}

IE9 {808bd258-e1c8-460e-a421-cf78297ae0e5}

IE10 {4e60848d-b316-42d9-80f9-b8b41bc3eed3}

nodebase {515004b4-fe11-4be3-9da1-8d9c84260877}

hyperbase {e1fbdd95-0115-45d2-be98-2250ed94716a}

leny — bash — vibox list -s

machine:~ leny$ vibox list -s

IE7 {3ca17e1c-49b9-4e49-9d50-53767d2fe2bc} poweroff

IE9 {808bd258-e1c8-460e-a421-cf78297ae0e5} poweroff

IE10 {4e60848d-b316-42d9-80f9-b8b41bc3eed3} poweroff

nodebase {515004b4-fe11-4be3-9da1-8d9c84260877} poweroff

hyperbase {e1fbdd95-0115-45d2-be98-2250ed94716a} running

leny — bash — vibox list -r

machine:~ leny$ vibox list -r

hyperbase {e1fbdd95-0115-45d2-be98-2250ed94716a} running

The list command displays all installed VMs on your system.
You can optionally check the status of each VM and sort the results by currently running VMs.

show

vibox show [options] <uid|name>

Options

-f, --full
Display full information
leny — bash — vibox show

machine:~ leny$ vibox show hyperbase

=============

= hyperbase =

=============

- uuid: {e1fbdd95-0115-45d2-be98-2250ed94716a}

- group: /Local Servers

- os: Debian

- ram: 2048MB

+ state: running

  - since: Thursday, May 09, 2013 16:23:30

+ shared folders:

  - flatland: /Users/leny/Works/flatLand

leny — bash — vibox show -f

machine:~ leny$ vibox show hyperbase

=============

= hyperbase =

=============

- uuid: {e1fbdd95-0115-45d2-be98-2250ed94716a}

- group: /Local Servers

- os: Debian

- ram: 2048MB

+ state: running

  - since: Thursday, May 09, 2013 16:23:30

+ shared folders:

  - flatland: /Users/leny/Works/flatLand

+ full informations:

  - name: hyperbase

  - groups: /Local Servers

  - ostype: Debian

  - UUID: e1fbdd95-0115-45d2-be98-2250ed94716a

  - CfgFile: /Users/leny/VirtualBox VMs/Local Servers/hyperbase/hyperbase.vbox

  - SnapFldr: /Users/leny/VirtualBox VMs/Local Servers/hyperbase/Snapshots

  - LogFldr: /Users/leny/VirtualBox VMs/Local Servers/hyperbase/Logs

  - hardwareuuid: e1fbdd95-0115-45d2-be98-2250ed94716a

  - memory: 2048

  - pagefusion: off

  - vram: 12

  - cpuexecutioncap: 100

  - hpet: off

  - chipset: piix3

  - firmware: BIOS

  - cpus: 1

  - synthcpu: off

  - bootmenu: messageandmenu

  - boot1: floppy

  - boot2: dvd

  - boot3: disk

  - boot4: none

  - acpi: on

  - ioapic: off

  - pae: off

  - Time offset: 0rtcuseutc

  - hwvirtex: on

  - hwvirtexexcl: off

  - nestedpaging: on

  - largepages: on

  - vtxvpid: on

  - VMState: running

  - VMStateChangeTime: 2013-05-09T14:23:30.969000000

  - monitorcount: 1

  - accelerate3d: off

  - accelerate2dvideo: off

  - teleporterenabled: off

  - teleporterport: 0

  - teleporteraddress:

  - teleporterpassword:

  - tracing-enabled: off

  - tracing-allow-vm-access: off

  - tracing-config:

  - autostart-enabled: off

  - autostart-delay: 0

  - storagecontrollername0: IDE

  - storagecontrollertype0: PIIX4

  - storagecontrollerinstance0: 0

  - storagecontrollermaxportcount0: 2

  - storagecontrollerportcount0: 2

  - storagecontrollerbootable0: on

  - storagecontrollername1: SATA

  - storagecontrollertype1: IntelAhci

  - storagecontrollerinstance1: 0

  - storagecontrollermaxportcount1: 30

  - storagecontrollerportcount1: 1

  - storagecontrollerbootable1: on

  - IDE-0-0: none

  - IDE-0-1: none

  - IDE-1-0: /Applications/VirtualBox.app/Contents/MacOS/VBoxGuestAdditions.iso

  - IDE-ImageUUID-1-0: a8d5a89d-5d2d-4ec8-9545-5f4197a0598c

  - IDE-tempeject: off

  - IDE-IsEjected: off

  - IDE-1-1: none

  - SATA-0-0: /Users/leny/VirtualBox VMs/Local Servers/hyperbase/hyperbase.vdi

  - SATA-ImageUUID-0-0: 914b535b-9bdd-48f2-9f8d-f0c8a0fb5147

  - natnet1: nat

  - macaddress1: 08002737EBA2

  - cableconnected1: on

  - nic1: nat

  - nictype1: 82540EM

  - nicspeed1: 0

  - mtu: 0

  - sockSnd: 64

  - sockRcv: 64

  - tcpWndSnd: 64

  - tcpWndRcv: 64

  - hostonlyadapter2: vboxnet0

  - macaddress2: 080027AFF5FE

  - cableconnected2: on

  - nic2: hostonly

  - nictype2: 82540EM

  - nicspeed2: 0

  - nic3: none

  - nic4: none

  - nic5: none

  - nic6: none

  - nic7: none

  - nic8: none

  - hidpointing: usbtablet

  - hidkeyboard: ps2kbd

  - uart1: off

  - uart2: off

  - lpt1: off

  - lpt2: off

  - audio: coreaudio

  - clipboard: disabled

  - draganddrop: disabled

  - VideoMode: 720,400,0

  - vrde: off

  - usb: on

  - ehci: off

  - VRDEActiveConnection: off

  - VRDEClients: 0

  - GuestMemoryBalloon: 0

  - GuestOSType: Linux26

  - GuestAdditionsRunLevel: 2

  - GuestAdditionsVersion: 4.2.12 r84980

  - GuestAdditionsFacility_VirtualBox Base Driver: 50,1368109425793

  - GuestAdditionsFacility_VirtualBox System Service: 50,1368109429297

  - GuestAdditionsFacility_Seamless Mode: 0,1368109425792

  - GuestAdditionsFacility_Graphics Mode: 0,1368109425792

The show command details information about the selected VM.
You can optionally visualize the full list of information.

control

vibox control <uid|name> <action>

Actions

start
Start the selected VM
headless
Start the selected VM in headless mode (no GUI)
pause
Pause the selected VM
resume
Resume the selected VM
reset
Hard-reset the selected VM
stop
Send an ACPI-stop signal to the selected VM (if ACPI is enabled)
poweroff
Hard-stop the selected VM

The control command allows you to request the selected VM to take action.

start

vibox start [options] <uid|name>

Options

-h, --headless
Start the VM in headless mode (no GUI)

The start command is an alias of vibox control <VM> start.
With the headless option, it's an alias of vibox control <VM> headless.

headless

vibox headless <uid|name>

The headless command is an alias of vibox control <VM> headless.

stop

vibox stop <uid|name>

The stop command is an alias of vibox control <VM> stop.

History

09/05/2013:
v0.0.3 headless command & actions completions for control command
06/05/2013:
v0.0.2 stop command & bug fixes
05/05/2013:
v0.0.1 basic commands & completion support
04/05/2013:
First commit

Next...

However it's functional, there's still some work to do : error handlers, some optimization.

In the future, I'll probably add support to more commands of VBoxManage.

License

Copyright (c) 2013 Leny (http://flatland.be)

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.