mirror of
https://github.com/linka-cloud/d2vm.git
synced 2025-06-23 13:52:26 +00:00
docs: add hidden docs command to generate markdown cli reference
tests: fail if the docs need to be regenerated Signed-off-by: Adphi <philippe.adrien.nousse@gmail.com>
This commit is contained in:
19
docs/reference/d2vm.md
Normal file
19
docs/reference/d2vm.md
Normal file
@ -0,0 +1,19 @@
|
||||
## d2vm
|
||||
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for d2vm
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm build](d2vm_build.md) - Build a vm image from Dockerfile
|
||||
* [d2vm completion](d2vm_completion.md) - Generate the autocompletion script for the specified shell
|
||||
* [d2vm convert](d2vm_convert.md) - Convert Docker image to vm image
|
||||
* [d2vm run](d2vm_run.md) - Run the virtual machine image
|
||||
* [d2vm version](d2vm_version.md) -
|
||||
|
32
docs/reference/d2vm_build.md
Normal file
32
docs/reference/d2vm_build.md
Normal file
@ -0,0 +1,32 @@
|
||||
## d2vm build
|
||||
|
||||
Build a vm image from Dockerfile
|
||||
|
||||
```
|
||||
d2vm build [context directory] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--append-to-cmdline string Extra kernel cmdline arguments to append to the generated one
|
||||
--build-arg stringArray Set build-time variables
|
||||
-f, --file string Name of the Dockerfile
|
||||
--force Override output image
|
||||
-h, --help help for build
|
||||
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
||||
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
||||
-p, --password string Root user password (default "root")
|
||||
-s, --size string The output image size (default "10G")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm](d2vm.md) -
|
||||
|
30
docs/reference/d2vm_completion.md
Normal file
30
docs/reference/d2vm_completion.md
Normal file
@ -0,0 +1,30 @@
|
||||
## d2vm completion
|
||||
|
||||
Generate the autocompletion script for the specified shell
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for d2vm for the specified shell.
|
||||
See each sub-command's help for details on how to use the generated script.
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for completion
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm](d2vm.md) -
|
||||
* [d2vm completion bash](d2vm_completion_bash.md) - Generate the autocompletion script for bash
|
||||
* [d2vm completion fish](d2vm_completion_fish.md) - Generate the autocompletion script for fish
|
||||
* [d2vm completion powershell](d2vm_completion_powershell.md) - Generate the autocompletion script for powershell
|
||||
* [d2vm completion zsh](d2vm_completion_zsh.md) - Generate the autocompletion script for zsh
|
||||
|
49
docs/reference/d2vm_completion_bash.md
Normal file
49
docs/reference/d2vm_completion_bash.md
Normal file
@ -0,0 +1,49 @@
|
||||
## d2vm completion bash
|
||||
|
||||
Generate the autocompletion script for bash
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for the bash shell.
|
||||
|
||||
This script depends on the 'bash-completion' package.
|
||||
If it is not installed already, you can install it via your OS's package manager.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
source <(d2vm completion bash)
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
#### Linux:
|
||||
|
||||
d2vm completion bash > /etc/bash_completion.d/d2vm
|
||||
|
||||
#### macOS:
|
||||
|
||||
d2vm completion bash > /usr/local/etc/bash_completion.d/d2vm
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
```
|
||||
d2vm completion bash
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for bash
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm completion](d2vm_completion.md) - Generate the autocompletion script for the specified shell
|
||||
|
40
docs/reference/d2vm_completion_fish.md
Normal file
40
docs/reference/d2vm_completion_fish.md
Normal file
@ -0,0 +1,40 @@
|
||||
## d2vm completion fish
|
||||
|
||||
Generate the autocompletion script for fish
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for the fish shell.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
d2vm completion fish | source
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
d2vm completion fish > ~/.config/fish/completions/d2vm.fish
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
```
|
||||
d2vm completion fish [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for fish
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm completion](d2vm_completion.md) - Generate the autocompletion script for the specified shell
|
||||
|
37
docs/reference/d2vm_completion_powershell.md
Normal file
37
docs/reference/d2vm_completion_powershell.md
Normal file
@ -0,0 +1,37 @@
|
||||
## d2vm completion powershell
|
||||
|
||||
Generate the autocompletion script for powershell
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for powershell.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
d2vm completion powershell | Out-String | Invoke-Expression
|
||||
|
||||
To load completions for every new session, add the output of the above command
|
||||
to your powershell profile.
|
||||
|
||||
|
||||
```
|
||||
d2vm completion powershell [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for powershell
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm completion](d2vm_completion.md) - Generate the autocompletion script for the specified shell
|
||||
|
47
docs/reference/d2vm_completion_zsh.md
Normal file
47
docs/reference/d2vm_completion_zsh.md
Normal file
@ -0,0 +1,47 @@
|
||||
## d2vm completion zsh
|
||||
|
||||
Generate the autocompletion script for zsh
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for the zsh shell.
|
||||
|
||||
If shell completion is not already enabled in your environment you will need
|
||||
to enable it. You can execute the following once:
|
||||
|
||||
echo "autoload -U compinit; compinit" >> ~/.zshrc
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
#### Linux:
|
||||
|
||||
d2vm completion zsh > "${fpath[1]}/_d2vm"
|
||||
|
||||
#### macOS:
|
||||
|
||||
d2vm completion zsh > /usr/local/share/zsh/site-functions/_d2vm
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
```
|
||||
d2vm completion zsh [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for zsh
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm completion](d2vm_completion.md) - Generate the autocompletion script for the specified shell
|
||||
|
31
docs/reference/d2vm_convert.md
Normal file
31
docs/reference/d2vm_convert.md
Normal file
@ -0,0 +1,31 @@
|
||||
## d2vm convert
|
||||
|
||||
Convert Docker image to vm image
|
||||
|
||||
```
|
||||
d2vm convert [docker image] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--append-to-cmdline string Extra kernel cmdline arguments to append to the generated one
|
||||
-f, --force Override output qcow2 image
|
||||
-h, --help help for convert
|
||||
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
||||
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
||||
-p, --password string The Root user password (default "root")
|
||||
--pull Always pull docker image
|
||||
-s, --size string The output image size (default "10G")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm](d2vm.md) -
|
||||
|
23
docs/reference/d2vm_run.md
Normal file
23
docs/reference/d2vm_run.md
Normal file
@ -0,0 +1,23 @@
|
||||
## d2vm run
|
||||
|
||||
Run the virtual machine image
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for run
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm](d2vm.md) -
|
||||
* [d2vm run hetzner](d2vm_run_hetzner.md) - Run the virtual machine image on Hetzner Cloud
|
||||
* [d2vm run qemu](d2vm_run_qemu.md) - Run the virtual machine image with qemu
|
||||
* [d2vm run vbox](d2vm_run_vbox.md) - Run the virtual machine image with Virtualbox
|
||||
|
29
docs/reference/d2vm_run_hetzner.md
Normal file
29
docs/reference/d2vm_run_hetzner.md
Normal file
@ -0,0 +1,29 @@
|
||||
## d2vm run hetzner
|
||||
|
||||
Run the virtual machine image on Hetzner Cloud
|
||||
|
||||
```
|
||||
d2vm run hetzner [options] image-path [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for hetzner
|
||||
-n, --name string d2vm server name (default "d2vm")
|
||||
--rm remove server when done
|
||||
-i, --ssh-key string d2vm image identity key
|
||||
-t, --token string Hetzner Cloud API token [$HETZNER_TOKEN]
|
||||
-u, --user string d2vm image ssh user (default "root")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm run](d2vm_run.md) - Run the virtual machine image
|
||||
|
37
docs/reference/d2vm_run_qemu.md
Normal file
37
docs/reference/d2vm_run_qemu.md
Normal file
@ -0,0 +1,37 @@
|
||||
## d2vm run qemu
|
||||
|
||||
Run the virtual machine image with qemu
|
||||
|
||||
```
|
||||
d2vm run qemu [options] [image-path] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--accel string Choose acceleration mode. Use 'tcg' to disable it. (default "hvf:tcg")
|
||||
--arch string Type of architecture to use, e.g. x86_64, aarch64, s390x (default "x86_64")
|
||||
--cpus uint Number of CPUs (default 1)
|
||||
--data string String of metadata to pass to VM; error to specify both -data and -data-file
|
||||
--detached Set qemu container to run in the background
|
||||
--device multiple-flag Add USB host device(s). Format driver[,prop=value][,...] -- add device, like -device on the qemu command line. (default A multiple flag is a type of flag that can be repeated any number of times)
|
||||
--disk disk Disk config, may be repeated. [file=]path[,size=1G][,format=qcow2] (default [])
|
||||
--gui Set qemu to use video output instead of stdio
|
||||
-h, --help help for qemu
|
||||
--mem uint Amount of memory in MB (default 1024)
|
||||
--networking string Networking mode. Valid options are 'default', 'user', 'bridge[,name]', tap[,name] and 'none'. 'user' uses QEMUs userspace networking. 'bridge' connects to a preexisting bridge. 'tap' uses a prexisting tap device. 'none' disables networking.` (default "user")
|
||||
--publish multiple-flag Publish a vm's port(s) to the host (default []) (default A multiple flag is a type of flag that can be repeated any number of times)
|
||||
--qemu string Path to the qemu binary (otherwise look in $PATH)
|
||||
--usb Enable USB controller
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm run](d2vm_run.md) - Run the virtual machine image
|
||||
|
31
docs/reference/d2vm_run_vbox.md
Normal file
31
docs/reference/d2vm_run_vbox.md
Normal file
@ -0,0 +1,31 @@
|
||||
## d2vm run vbox
|
||||
|
||||
Run the virtual machine image with Virtualbox
|
||||
|
||||
```
|
||||
d2vm run vbox [options] image-path [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--cpus uint Number of CPUs (default 1)
|
||||
--disk disk Disk config, may be repeated. [file=]path[,size=1G][,format=raw] (default [])
|
||||
--gui Show the VM GUI
|
||||
-h, --help help for vbox
|
||||
--mem uint Amount of memory in MB (default 1024)
|
||||
--name string Name of the Virtualbox VM
|
||||
--networking vbnetworks Network config, may be repeated. [type=](null|nat|bridged|intnet|hostonly|generic|natnetwork[<devicename>])[,[bridge|host]adapter=<interface>] (default [])
|
||||
--vboxmanage string VBoxManage binary to use (default "VBoxManage")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm run](d2vm_run.md) - Run the virtual machine image
|
||||
|
24
docs/reference/d2vm_version.md
Normal file
24
docs/reference/d2vm_version.md
Normal file
@ -0,0 +1,24 @@
|
||||
## d2vm version
|
||||
|
||||
|
||||
|
||||
```
|
||||
d2vm version [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for version
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-v, --verbose Enable Verbose output
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [d2vm](d2vm.md) -
|
||||
|
Reference in New Issue
Block a user