96

There is surprisingly no documentation on what the Vagrant commands do, other than references throughout the "getting started" tutorial.

What I've worked out so far:

  • box - manage "boxes"
  • destroy - shut down the VM then delete its stored image?
  • gem
  • halt - shut down the VM
  • init - prepare a directory with a new Vagrantfile
  • package - shut down the VM, then convert it to a 'package' which can be turned into a box? (Or something)
  • provision - run just the provisioning (eg, Chef, Puppet...) stage
  • reload - modify the VM configuration (eg, reapply Vagrantfile), reboot the VM, reprovision
  • resume - un-suspend (ie, unhibernate)
  • ssh - open an SSH shell connection to the VM
  • ssh-config
  • status
  • suspend - hibernate the VM
  • up - some or all of: copy a VM image to create a new VM, apply configuration to it, boot it

Do I have these right? What are the others? I'm still a bit unclear on the exact difference between reload and destroy/up.

Steve Bennett
  • 114,604
  • 39
  • 168
  • 219
  • The current documentation is a lot better now - http://vagrantup.com/v1/docs/index.html – JavaRocky Oct 10 '12 at 04:58
  • 2
    @JavaRocky, it doesn't seem like it to me. http://vagrantup.com/v1/docs/commands.html still has literally no per-subcommand information. I would expect *more* information about each command in a guide like this (as compared to `-h`), not less. – Matthew Flaschen Dec 08 '12 at 22:56
  • 2
    @JavaRocky - If that's better, I can't imagine what they were like before. Not useful at all. – DougW Feb 20 '13 at 04:01
  • Interesting, it looks like they've actually removed the list of commands, making the website even less informative than before. – Steve Bennett Feb 20 '13 at 05:38
  • From the current docs it looks like "resume" is redundant with "vagrant up", e.g. the latter will resume a machine if it suspended, and re-provision if it is halted. Is that accurate? https://docs.vagrantup.com/v2/getting-started/teardown.html – cboettig Aug 25 '14 at 17:25

3 Answers3

49

I agree with you that documentation at vagrantup is on the shorter side.

Some information can be gleaned from command help system.

  1. For example: gem command.

    Just type the command without arguments: vagrant gem -h and it produces the information that you may need.

    vagrant gem is used to install Vagrant plugins via the RubyGems system. In fact, vagrant gem is just a frontend to the actual gem interface, with the difference being that Vagrant sets up a custom directory where gems are installed so that they are isolated from your system gems.

  2. Vagrant ssh-config:

    Under the hood, when you execute vagrant ssh to ssh into VM. It is utilizing it's well known ssh key. The information on this key is provided by vagrant ssh-config. This is useful in case you want to change the well know key to your own private key and prepare boxes to use that.

    Also some times, you may want to use ssh based automation with your VMs. In that case, knowing which key is being used is useful. You could do use normal ssh command - ssh -i keyfile ..

  3. vagrant status <vmname>

    This command is a wrapper which provides the information on the status of vm. It could be running, saved and powered off.

  4. vagrant reload

    If you make any changes to the configuration in vagrantfile which needs to take effect. You may want to reload the VM. It re-runs the provisioning defined in the vagrantfile unless you ask it not too.

    It does not destroy the VM you have created from a base box. That means all the changes you have made to your VM, like say created a folder in your user directory will be there after reload.

    It is like reboot where it powers off your VM and then applies certain configuration change which can be applied only when VM has been powered off. and then power it on. Example: like attaching another SATA Virtual Disk.

  5. vagrant up

    This reads your configuration file - vagrantfile and then creates a VM from base box. Base Box is like a Template. You can create many VMs from it.

    Similarly, vagrant destroy destroys your VM. In this case all changes you made when inside it will be lost. But thats the cool idea that you can start from a base predefined state when you create a new VM.

I really like using it and have blogged about it.

In summary, it is a good wrapper over VirtualBox APIs and Commands. You can have a look at the VirtualBox commands to understand some of the capabilities better.

kenorb
  • 155,785
  • 88
  • 678
  • 743
pyfunc
  • 65,343
  • 15
  • 148
  • 136
  • 1
    What version of vagrant do you get all this output from? I'm using 1.0.5 and I get nothing of the sort. `vagrant gem -h` gives the output you've shown, but all the others say nothing useful at all. – DougW Feb 20 '13 at 03:58
  • 2
    Vagrant 1.2 seems to have gone backwards. eg, `vagrant init -h` just gives this: Usage: vagrant init [box-name] [box-url] -h, --help Print this help – Steve Bennett Jul 19 '13 at 06:02
37

I'm not sure when it changed, but the current version (1.6.3) has a proper list of commands, and running vagrant list-commands gives an even more complete list:

box             manages boxes: installation, removal, etc.
connect         connect to a remotely shared Vagrant environment
destroy         stops and deletes all traces of the vagrant machine
docker-logs     outputs the logs from the Docker container
docker-run      run a one-off command in the context of a container
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
list-commands   outputs all available Vagrant subcommands, even non-primary ones
login           log in to Vagrant Cloud
package         packages a running vagrant environment into a box
plugin          manages plugins: install, uninstall, update, etc.
provision       provisions the vagrant machine
rdp             connects to machine via RDP
reload          restarts vagrant machine, loads new Vagrantfile configuration
resume          resume a suspended vagrant machine
rsync           syncs rsync synced folders to remote machine
rsync-auto      syncs rsync synced folders automatically when files change
share           share your Vagrant environment with anyone in the world
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
version         prints current and latest Vagrant version

The only commands left out from the complete list when running vagrant by itself are the docker and rsync ones. On my system, anyway.

That seems to be the definitive answer, now.

Steve Bennett
  • 114,604
  • 39
  • 168
  • 219
8

It really is too bad that even though the current docs for v1.1 looks better, it's much less complete than v1. The credo 'less is more' just doesn't work in the area of documentation...

I've found that when it comes to Vagrantfiles, the most complete overview is in the comments of a freshly created Vagrantfile, after initializing a vagrant project. It mentions parameters that are not currently in the documentation.

David Spreekmeester
  • 170
  • 2
  • 4