tldr-pages/tldr

Let's document: VBoxManage

Open

#11,431 opened on Nov 9, 2023

View on GitHubContributor guide
 (7 comments) (1 reaction) (0 assignees)Markdown (5,381 forks)batch import
good first issuehelp wantedlet's documentnew command

Repository metrics

Stars
 (63,468 stars)
PR merge metrics
 (PR metrics pending)

Description

Command description

VBoxManage is the CLI of Oracle VM VirtualBox, it includes every control from VirtualBox GUI as well as more features.

Currently, there is a page vboxmanage covering a few commands of VBoxManage but a lot of useful commands are still missing.

We could create subpages to document other commands and maybe refactor the current page using the Subcommand instruction from contributing.

Documentation

https://www.virtualbox.org/manual/ch08.html

Platform

Common

Commands

Already documented commands that could be refactored into subcommands

  • VBoxManage list → #11667
  • VBoxManage showvminfo → #11667
  • VBoxManage startvm → #11667
  • VBoxManage controlvm → #11667
  • VBoxManage extpack → #11667

Commands to document

  • VBoxManage → #3072
    • adoptstate →
    • bandwidthctl →
    • checkmediumpwd →
    • clonemedium →
    • clonevm → #11598
    • closemedium →
    • cloud → #11727
    • cloudprofile →
    • convertfromraw →
    • createmedium →
    • createvm → #11598
    • debugvm →
    • dhcpserver →
    • discardstate →
    • encryptmedium →
    • encryptvm →
    • export → #11598
    • getextradata →
    • guestcontrol →
    • guestproperty →
    • hostonlyif →
    • hostonlynet →
    • import → #11598
    • mediumio →
    • mediumproperty →
    • metrics →
    • modifymedium →
    • modifyvm → #17581
    • modifynvram →
    • movevm → #11796
    • natnetwork →
    • registervm → #11598
    • setextradata →
    • setproperty →
    • sharedfolder →
    • showmediuminfo →
    • signova →
    • snapshot →
    • storageattach →
    • storagectl →
    • unattended →
    • updatecheck →
    • unregistervm → #11598
    • usbdevsource →
    • usbfilter →
  • vboximg-mount →

Contributor guide

Research direction
Document each command listed in the issue by creating subpages following tldr pages contributing guidelines. Use the VirtualBox documentation as reference.
Tech stack
shell
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70