{"id":15551291,"url":"https://github.com/xwmx/vbox","last_synced_at":"2025-10-10T20:33:09.022Z","repository":{"id":50663795,"uuid":"50068053","full_name":"xwmx/vbox","owner":"xwmx","description":"A streamlined interface for VBoxManage, the VirtualBox command line tool.","archived":false,"fork":false,"pushed_at":"2020-10-07T06:17:24.000Z","size":88,"stargazers_count":37,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-10T20:32:20.682Z","etag":null,"topics":["bash","bpkg","cli","command-line","homebrew","shell","vboxmanage","virtual-machine","virtualbox"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xwmx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-20T23:31:42.000Z","updated_at":"2025-08-27T12:08:37.000Z","dependencies_parsed_at":"2022-09-10T23:20:27.811Z","dependency_job_id":null,"html_url":"https://github.com/xwmx/vbox","commit_stats":null,"previous_names":["alphabetum/vbox"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/xwmx/vbox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xwmx%2Fvbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xwmx%2Fvbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xwmx%2Fvbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xwmx%2Fvbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xwmx","download_url":"https://codeload.github.com/xwmx/vbox/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xwmx%2Fvbox/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005272,"owners_count":26083863,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","bpkg","cli","command-line","homebrew","shell","vboxmanage","virtual-machine","virtualbox"],"created_at":"2024-10-02T14:03:58.736Z","updated_at":"2025-10-10T20:33:08.992Z","avatar_url":"https://github.com/xwmx.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"```\n       _\n__   _| |__   _____  __\n\\ \\ / / '_ \\ / _ \\ \\/ /\n \\ V /| |_) | (_) \u003e  \u003c\n  \\_/ |_.__/ \\___/_/\\_\\\n```\n\n# vbox\n\nA streamlined interface for\n[VBoxManage](https://www.virtualbox.org/manual/ch08.html), the\n[VirtualBox](https://www.virtualbox.org/) command line tool.\n\n`vbox` wraps `VBoxManage`, providing a simpler UI with a focus on frequently\nused commands.\n\n## Installation\n\n### Homebrew\n\nTo install with [Homebrew](http://brew.sh/):\n\n```bash\nbrew tap xwmx/taps\nbrew install vbox\n```\n\n### npm\n\nTo install with [npm](https://www.npmjs.com/package/vbox.sh):\n\n```bash\nnpm install --global vbox.sh\n```\n\n### bpkg\n\nTo install with [bpkg](http://www.bpkg.io/):\n\n```bash\nbpkg install xwmx/vbox\n```\n\n### Manual\n\nTo install manually, simply add the `vbox` script to your `$PATH`. If\nyou already have a `~/bin` directory, you can use the following command:\n\n```bash\ncurl -L https://raw.github.com/xwmx/vbox/master/vbox \\\n  -o ~/bin/vbox \u0026\u0026 chmod +x ~/bin/vbox\n```\n\n## Usage\n\n```\nUsage:\n  vbox commands [--raw]\n  vbox config [--path]\n  vbox forwarding add \u003cvm-name\u003e \u003crule-name\u003e \u003cport\u003e\n  vbox forwarding list \u003cvm-name\u003e\n  vbox forwarding delete \u003cvm-name\u003e \u003crule-name\u003e\n  vbox (help [\u003ccommand\u003e] | -h | --help)\n  vbox kill   (\u003cname\u003e | \u003cuuid\u003e)\n  vbox list   [running | status]\n  vbox manage [\u003cgeneral option\u003e] \u003ccommand\u003e\n  vbox pause  (\u003cname\u003e | \u003cuuid\u003e)\n  vbox reset  (\u003cname\u003e | \u003cuuid\u003e)\n  vbox resume (\u003cname\u003e | \u003cuuid\u003e)\n  vbox show   (\u003cname\u003e | \u003cuuid\u003e)\n  vbox start  (\u003cname\u003e | \u003cuuid\u003e) [--headless]\n  vbox status [(\u003cname\u003e | \u003cuuid\u003e) [--long|-l]]\n  vbox stop   (\u003cname\u003e | \u003cuuid\u003e)\n  vbox (version | --version)\n\nGlobal Options:\n  -h --help  Display this help information.\n  --version  Display version information.\n\nHelp:\n  vbox help [\u003ccommand\u003e]\n```\n\n### Subcommands\n\n#### `commands`\n\n```\nUsage:\n  vbox commands [--raw]\n\nOptions:\n  --raw  Display the command list without formatting.\n\nDescription:\n  Display the list of available commands.\n```\n\n#### `config`\n\n```\nUsage:\n  vbox config [--path]\n\nOptions:\n  --path  Print the path to the configuration file, 'VirtualBox.xml'.\n\nDescription:\n  When no argument has been passed, open the 'VirtualBox.xml' configuration\n  file in `$EDITOR`, which is currently set to ''. When the\n  `--path` option is specified, the path to 'VirtualBox.xml' is printed.\n```\n\n#### `forwarding`\n\n```\nUsage:\n  vbox forwarding add \u003cvm-name\u003e \u003crule-name\u003e \u003cport\u003e\n  vbox forwarding list \u003cvm-name\u003e\n  vbox forwarding delete \u003cvm-name\u003e \u003crule-name\u003e\n\nSubcommands:\n  add     Add a new port forwarding rule.\n  list    List forwarding rules.\n  delete  Delete the specified rule.\n\nDescription:\n  Manage port forwarding.\n\nExample:\n  vbox forwarding add \"ubuntu-vm\" \"tcp5000\" \"5000\"\n\n  Equivalent of:\n    VBoxManage controlvm ubuntu-vm \\\n      natpf1 \"tcp5000,tcp,127.0.0.1,5000,,5000\"\n```\n\n#### `help`\n\n```\nUsage:\n  vbox help [\u003ccommand\u003e]\n\nDescription:\n  Display help information for vbox or a specified command.\n```\n\n#### `kill`\n\n```\nUsage:\n  vbox kill (\u003cname\u003e | \u003cuuid\u003e)\n\nDescription:\n  Command: `VBoxManage controlvm \u003cvm\u003e poweroff`\n\n  Has the same effect on a virtual machine as pulling the power cable on a real\n  computer. The state of the VM is not saved beforehand, and data may be lost.\n  (This is equivalent to selecting the \"Close\" item in the \"Machine\" menu of\n  the GUI or pressing the window's close button, and then selecting \"Power off\n  the machine\" in the dialog.)\n```\n\n#### `list`\n\n```\nUsage:\n  vbox list [running | status]\n\nArguments:\n  running  List all running VMs.\n  status   Display all VMs with basic status information.\n\nDescription:\n  List VirtualBox VMs.\n```\n\n#### `manage`\n\n```\nUsage:\n  vbox manage [\u003cgeneral option\u003e] \u003ccommand\u003e\n\nDescription:\n  Alias for `VBoxManage`.\n\n  VBoxManage Documentation:\n    https://www.virtualbox.org/manual/ch08.html\n```\n\n#### `pause`\n\n```\nUsage:\n  vbox pause (\u003cname\u003e | \u003cuuid\u003e)\n\nDescription:\n  Command: `VBoxManage controlvm \u003cvm\u003e pause`\n\n  Temporarily puts a virtual machine on hold, without changing its state for\n  good. The VM window will be painted in gray to indicate that the VM is\n  currently paused. (This is equivalent to selecting the \"Pause\" item in the\n  \"Machine\" menu of the GUI.)\n```\n\n#### `reset`\n\n```\nUsage:\n  vbox reset (\u003cname\u003e | \u003cuuid\u003e)\n\nDescription:\n  Command: `VBoxManage controlvm \u003cvm\u003e reset`\n\n  Has the same effect on a virtual machine as pressing the \"Reset\" button on a\n  real computer: a cold reboot of the virtual machine, which will restart and\n  boot the guest operating system again immediately. The state of the VM is not\n  saved beforehand, and data may be lost. (This is equivalent to selecting the\n  \"Reset\" item in the \"Machine\" menu of the GUI.)\n```\n\n#### `resume`\n\n```\nUsage:\n  vbox resume (\u003cname\u003e | \u003cuuid\u003e)\n\nDescription:\n  Command: `VBoxManage controlvm \u003cvm\u003e resume`\n\n  Undo a previous pause command. (This is equivalent to selecting the \"Resume\"\n  item in the \"Machine\" menu of the GUI.)\n```\n\n#### `show`\n\n```\nUsage:\n  vbox show (\u003cname\u003e | \u003cuuid\u003e)\n\nDescription:\n  Command: `VBoxManage showvminfo \u003cvm\u003e`\n\n  Show information about a particular virtual machine.\n```\n\n#### `start`\n\n```\nUsage:\n  vbox start (\u003cname\u003e | \u003cuuid\u003e) [--headless]\n\nDescription:\n  Start the VM with the given name or UUID.\n```\n\n#### `status`\n\n```\nUsage:\n  vbox status [(\u003cname\u003e | \u003cuuid\u003e) [--long|-l]]\n\nOptions:\n  -l --long  Display long-form status information for the specified VM.\n\nDescription:\n  When no argument has been passed, this acts as an alias for\n  `vbox list status` and displays the status for all of the VMs. When\n  passed a VM name or UUID, the status aka state of that VM is displayed.\n```\n#### `stop`\n\n```\nUsage:\n  vbox stop (\u003cname\u003e | \u003cuuid\u003e)\n\nDescription:\n  Command: `VBoxManage controlvm \u003cvm\u003e savestate`\n\n  Save the current state of the VM to disk and then stop the VM. (This is\n  equivalent to selecting the \"Close\" item in the \"Machine\" menu of the GUI or\n  pressing the window's close button, and then selecting \"Save the machine\n  state\" in the dialog.)\n```\n\n#### `version`\n\n```\nUsage:\n  vbox (version | --version)\n\nDescription:\n  Display the current program version.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxwmx%2Fvbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxwmx%2Fvbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxwmx%2Fvbox/lists"}