Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xwmx/vbox

A streamlined interface for VBoxManage, the VirtualBox command line tool.
https://github.com/xwmx/vbox

bash bpkg cli command-line homebrew shell vboxmanage virtual-machine virtualbox

Last synced: about 1 month ago
JSON representation

A streamlined interface for VBoxManage, the VirtualBox command line tool.

Host: GitHub
URL: https://github.com/xwmx/vbox
Owner: xwmx
License: mit
Created: 2016-01-20T23:31:42.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2020-10-07T06:17:24.000Z (about 4 years ago)
Last Synced: 2024-11-01T21:42:10.319Z (about 2 months ago)
Topics: bash, bpkg, cli, command-line, homebrew, shell, vboxmanage, virtual-machine, virtualbox
Language: Shell
Homepage:
Size: 85.9 KB
Stars: 36
Watchers: 4
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

```
_
__ _| |__ _____ __
\ \ / / '_ \ / _ \ \/ /
\ V /| |_) | (_) > <
\_/ |_.__/ \___/_/\_\
```

# vbox

A streamlined interface for
[VBoxManage](https://www.virtualbox.org/manual/ch08.html), the
[VirtualBox](https://www.virtualbox.org/) command line tool.

`vbox` wraps `VBoxManage`, providing a simpler UI with a focus on frequently
used commands.

## Installation

### Homebrew

To install with [Homebrew](http://brew.sh/):

```bash
brew tap xwmx/taps
brew install vbox
```

### npm

To install with [npm](https://www.npmjs.com/package/vbox.sh):

```bash
npm install --global vbox.sh
```

### bpkg

To install with [bpkg](http://www.bpkg.io/):

```bash
bpkg install xwmx/vbox
```

### Manual

To install manually, simply add the `vbox` script to your `$PATH`. If
you already have a `~/bin` directory, you can use the following command:

```bash
curl -L https://raw.github.com/xwmx/vbox/master/vbox \
-o ~/bin/vbox && chmod +x ~/bin/vbox
```

## Usage

Global Options:
-h --help Display this help information.
--version Display version information.

Help:
vbox help []
```

### Subcommands

#### `commands`

```
Usage:
vbox commands [--raw]

Options:
--raw Display the command list without formatting.

Description:
Display the list of available commands.
```

#### `config`

```
Usage:
vbox config [--path]

Options:
--path Print the path to the configuration file, 'VirtualBox.xml'.

Description:
When no argument has been passed, open the 'VirtualBox.xml' configuration
file in `$EDITOR`, which is currently set to ''. When the
`--path` option is specified, the path to 'VirtualBox.xml' is printed.
```

#### `forwarding`

```
Usage:
vbox forwarding add
vbox forwarding list
vbox forwarding delete

Subcommands:
add Add a new port forwarding rule.
list List forwarding rules.
delete Delete the specified rule.

Description:
Manage port forwarding.

Example:
vbox forwarding add "ubuntu-vm" "tcp5000" "5000"

Equivalent of:
VBoxManage controlvm ubuntu-vm \
natpf1 "tcp5000,tcp,127.0.0.1,5000,,5000"
```

#### `help`

```
Usage:
vbox help []

Description:
Display help information for vbox or a specified command.
```

#### `kill`

```
Usage:
vbox kill ( | )

Description:
Command: `VBoxManage controlvm poweroff`

Has the same effect on a virtual machine as pulling the power cable on a real
computer. The state of the VM is not saved beforehand, and data may be lost.
(This is equivalent to selecting the "Close" item in the "Machine" menu of
the GUI or pressing the window's close button, and then selecting "Power off
the machine" in the dialog.)
```

#### `list`

```
Usage:
vbox list [running | status]

Arguments:
running List all running VMs.
status Display all VMs with basic status information.

Description:
List VirtualBox VMs.
```

#### `manage`

```
Usage:
vbox manage []

Description:
Alias for `VBoxManage`.

VBoxManage Documentation:
https://www.virtualbox.org/manual/ch08.html
```

#### `pause`

```
Usage:
vbox pause ( | )

Description:
Command: `VBoxManage controlvm pause`

Temporarily puts a virtual machine on hold, without changing its state for
good. The VM window will be painted in gray to indicate that the VM is
currently paused. (This is equivalent to selecting the "Pause" item in the
"Machine" menu of the GUI.)
```

#### `reset`

```
Usage:
vbox reset ( | )

Description:
Command: `VBoxManage controlvm reset`

Has the same effect on a virtual machine as pressing the "Reset" button on a
real computer: a cold reboot of the virtual machine, which will restart and
boot the guest operating system again immediately. The state of the VM is not
saved beforehand, and data may be lost. (This is equivalent to selecting the
"Reset" item in the "Machine" menu of the GUI.)
```

#### `resume`

```
Usage:
vbox resume ( | )

Description:
Command: `VBoxManage controlvm resume`

Undo a previous pause command. (This is equivalent to selecting the "Resume"
item in the "Machine" menu of the GUI.)
```

#### `show`

```
Usage:
vbox show ( | )

Description:
Command: `VBoxManage showvminfo `

Show information about a particular virtual machine.
```

#### `start`

```
Usage:
vbox start ( | ) [--headless]

Description:
Start the VM with the given name or UUID.
```

#### `status`

```
Usage:
vbox status [( | ) [--long|-l]]

Options:
-l --long Display long-form status information for the specified VM.

Description:
When no argument has been passed, this acts as an alias for
`vbox list status` and displays the status for all of the VMs. When
passed a VM name or UUID, the status aka state of that VM is displayed.
```
#### `stop`

```
Usage:
vbox stop ( | )

Description:
Command: `VBoxManage controlvm savestate`

Save the current state of the VM to disk and then stop the VM. (This is
equivalent to selecting the "Close" item in the "Machine" menu of the GUI or
pressing the window's close button, and then selecting "Save the machine
state" in the dialog.)
```

#### `version`

```
Usage:
vbox (version | --version)

Description:
Display the current program version.
```