PyCharm
 
2021.1
Shortcuts: Windows
Get PyCharm
You are viewing the documentation for an earlier version of PyCharm.
  1. Reference
  2. Settings / Preferences dialog
  3. Tools
  4. Vagrant

Vagrant

Last modified: 08 March 2021

This is a Professional feature: download PyCharm Professional to try.

File | Settings | Tools | Vagrant for Windows and Linux

PyCharm | Preferences | Tools | Vagrant for macOS

Ctrl+Alt+S the Settings/Preferences icon

File | Settings | Tools | Vagrant for Windows and Linux

PyCharm | Preferences | Tools | Vagrant for macOS

Ctrl+Alt+S the Settings/Preferences icon

On this page, enable Vagrant support in PyCharm, specify the location of the VagrantFile, and 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 the plugin is enabled. The plugin is bundled with PyCharm and is activated by default. If the plugin is not activated, enable it on the Plugins page of the IDE settings Ctrl+Alt+S as described in Manage plugins.

    If you are using Docker for Windows, enable the Expose daemon on tcp://localhost:2375 without TLS option in the General section of your Docker settings.

ItemDescription
Vagrant executableSpecify the fully qualified address of the executable file: vagrant.bat for Windows, vagrant for Unix and macOS. Type the path manually, or click the browse button and locate the desired file in the dialog that opens.
Instance folder

Specify here the fully qualified path to the directory, where the task vagrant init has been executed, and the Vagrantfile is initialized and stored.

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.

A Vagrantfile is a configuration file that defines the instance(virtual machine) you need. The file contains the virtual IP address, port mappings, and the memory size to assign. The file can specify which folders are shared and which third-party software should be installed. According to the Vagrantfile your instance(virtual machine) is configured, provisioned against the relevant Vagrant base box, and deployed on your computer. A Vagrantfile is created through the vagrant init command.

When creation of an instance(virtual machine) is invoked either through the vagrant up command or through the Tools | Vagrant | Up menu option, PyCharm looks for the Vagrantfile in the directory specified in the Instance folder field. For more information, see http://docs.vagrantup.com/v2/vagrantfile/.

You can create a Vagrantfile in any directory and appoint it as instance folder. If the field is empty, PyCharm will treat the project root as the instance folder and look for a Vagrantfile in it.

ProviderUse this field to specify the provider to be used by vagrant up command. If this field is left blank, the default provider is used.
Environment variableClick the ellipsis button or press Shift+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.
the Add buttonAlt+InsertClick 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 Vagrant: Working with Reproducible Development Environments.
Remove a boxAlt+DeleteClick this button to remove the selected Vagrant base box. The box and the nested files are physically deleted from the disk. This command corresponds to vagrant box remove <name> For details, see Vagrant: Working with Reproducible Development Environments.
Plugins

Use this table to view and change the list of available plugins.

the Add buttonAlt+InsertClick this button to install a new Vagrant plugin.
Remove the selected pluginAlt+DeleteClick this button to remove the selected plugin.
Update the pluginClick this button to update the selected plugin.
Attach a license to the pluginUse this button to attach a license to the selected plugin.

See also

Procedures

External Links