PyCharm 4.0.0 Web Help

File | Settings | Vagrant

settings

Use this page to:

  • Enable Vagrant support in PyCharm by specifying the Vagrant executable file.
  • Specify the location of the VagrantFile that determines creation of virtual boxes (instances) by provisioning predefined Vagrant base boxes through the vagrant up command.
  • Handle the list of Vagrant base boxes to use in creation of virtual boxes (instances).

Before you start working with Vagrant, make sure that:

  1. Vagrant is downloaded and installed.
  2. Before you start working with Vagrant, make sure that Vagrant plugin is enabled.

    The plugin is bundled with PyCharm and activated by default. If not, enable the plugin as described in Enabling and Disabling Plugins.

Item Description
Vagrant executable Specify the fully qualified address of the executable file: vagrant.bat for Windows, vagrant for Unix and OS X. Type the path manually, or click the browse button and locate the desired file in the Select vagrant executable dialog box.
Instance folder Specify here the fully qualified path to the directory, where the task vagrant init has been executed.

Note that you can create an instance folder in any location, for example, in a project root. When a new remote interpreter is created, this project root location will be suggested by default as the instance folder.

3.1+Provider Use this field to specify the provider to be used by vagrant up command. If this field is left blank, the default provider is used.
3.1+Environment variable Click the ellipsis button or press Shift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift EnterShift EnterShift Enter to specify the shell variables to be used to configure the providers' behavior.
Boxes and Plugins tabs
Boxes This list shows the predefined Vagrant base boxes available in PyCharm. Each item presents a Vagrant base box on which Vagrant configures and launches its instances (virtual machines). The entries of this list correspond to the output of the command vagrant box list.
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter Click this button to download a new base box. This command corresponds to vagrant box add <name> <URL>. By default, PyCharm suggests the URL to the lucid32 box For details, see Creating and Removing Vagrant Boxes.
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete Click this button to remove the selected Vagrant base box. So doing, the box and the nested files are physically deleted from the disk. This command corresponds to vagrant box remove <name> For details, see Creating and Removing Vagrant Boxes.
Plugins Use this table to view and change the list of available plugins.
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter Click this button to install a new Vagrant plugin.
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete Click this button to remove the selected plugin.
update_icon Click this button to update the selected plugin.
attach_license Use this button to attach a license to the selected plugin.

See Also

Procedures:

External Links:

Web Resources: