62 lines
1.6 KiB
Markdown
62 lines
1.6 KiB
Markdown
|
---
|
||
|
|
sidebar_current: "cli-box"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Box
|
||
|
|
|
||
|
|
**Command: `vagrant box`**
|
||
|
|
|
||
|
|
This is the command used to manage (add, remove, etc.) [boxes](/v2/boxes/index.html).
|
||
|
|
|
||
|
|
The main functionality of this command is exposed via even more subcommands:
|
||
|
|
|
||
|
|
* `add`
|
||
|
|
* `list`
|
||
|
|
* `remove`
|
||
|
|
* `repackage`
|
||
|
|
|
||
|
|
# Box Add
|
||
|
|
|
||
|
|
**Command: `vagrant box add NAME URL`**
|
||
|
|
|
||
|
|
This adds a box add the given URL to Vagrant and stores it under the
|
||
|
|
logical name `NAME`.
|
||
|
|
|
||
|
|
The URL may be a file path or an HTTP URL. For HTTP, basic authentication
|
||
|
|
is supported and `http_proxy` environmental variables are respected. HTTPS
|
||
|
|
is also supported.
|
||
|
|
|
||
|
|
The name argument of this command is a _logical name_, meaning you can
|
||
|
|
effectively choose whatever you want. This is the name that Vagrant searches
|
||
|
|
for to match with the `config.vm.box` setting in Vagrantfiles.
|
||
|
|
|
||
|
|
## Options
|
||
|
|
|
||
|
|
* `--provider PROVIDER` - If given, Vagrant will verify the box you're
|
||
|
|
adding is for the given provider. By default, Vagrant automatically
|
||
|
|
detects the proper provider to use.
|
||
|
|
|
||
|
|
# Box List
|
||
|
|
|
||
|
|
**Command: `vagrant box list`**
|
||
|
|
|
||
|
|
This command lists all the boxes that are installed into Vagrant.
|
||
|
|
|
||
|
|
# Box Remove
|
||
|
|
|
||
|
|
**Command: `vagrant box remove NAME PROVIDER`**
|
||
|
|
|
||
|
|
This command removes a box from Vagrant that matches the given name and
|
||
|
|
provider.
|
||
|
|
|
||
|
|
# Box Repackage
|
||
|
|
|
||
|
|
**Command: `vagrant box repackage NAME PROVIDER`**
|
||
|
|
|
||
|
|
This command repackages the given box and puts it in the current
|
||
|
|
directory so you can redistribute it.
|
||
|
|
|
||
|
|
When you add a box, Vagrant unpacks it and stores it internally. The
|
||
|
|
original `*.box` file is not preserved. This command is useful for
|
||
|
|
reclaiming a `*.box` file from an installed Vagrant box.
|