vagrant - Man Page
manual page for Vagrant 2.3.4
Examples (TL;DR)
- Create Vagrantfile in current directory with the base Vagrant box:
vagrant init - Create Vagrantfile with the Ubuntu 20.04 (Focal Fossa) box from HashiCorp Atlas:
vagrant init ubuntu/focal64 - Start and provision the vagrant environment:
vagrant up - Suspend the machine:
vagrant suspend - Halt the machine:
vagrant halt - Connect to machine via SSH:
vagrant ssh - Output the SSH configuration file of the running Vagrant machine:
vagrant ssh-config - List all local boxes:
vagrant box list
Synopsis
vagrant [options] <command> [<args>]
Description
- -h, --help
Print this help.
Common commands
- autocomplete
manages autocomplete installation on host
- box
manages boxes: installation, removal, etc.
- destroy
stops and deletes all traces of the vagrant machine
- global-status
outputs status Vagrant environments for this user
- halt
stops the vagrant machine
- help
shows the help for a subcommand
- init
initializes a new Vagrant environment by creating a Vagrantfile
- package
packages a running vagrant environment into a box
- plugin
manages plugins: install, uninstall, update, etc.
- port
displays information about guest port mappings
- powershell
connects to machine via powershell remoting
- provision
provisions the vagrant machine
- push
deploys code in this environment to a configured destination
- rdp
connects to machine via RDP
- reload
restarts vagrant machine, loads new Vagrantfile configuration
- resume
resume a suspended vagrant machine
- serve
start Vagrant server
- snapshot
manages snapshots: saving, restoring, etc.
- ssh
connects to machine via SSH
- ssh-config
outputs OpenSSH valid configuration to connect to the machine
- status
outputs status of the vagrant machine
- suspend
suspends the machine
- up
starts and provisions the vagrant environment
- upload
upload to machine via communicator
- validate
validates the Vagrantfile
- version
prints current and latest Vagrant version
- winrm
executes commands on a machine via WinRM
- winrm-config
outputs WinRM configuration to connect to the machine
For help on any individual command run `vagrant COMMAND -h`
Additional subcommands are available, but are either more advanced or not commonly used. To see all subcommands, run the command `vagrant list-commands`.
- --[no-]color
Enable or disable color output
- --machine-readable
Enable machine readable output
- -v, --version
Display Vagrant version
- --debug
Enable debug output
- --timestamp
Enable timestamps on log output
- --debug-timestamp
Enable debug output with timestamps
- --no-tty
Enable non-interactive output