This feature is supported in the Professional edition only.
for Windows and Linux
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:
- Vagrant is downloaded and installed.
Before you start working with Vagrant, make sure that the Vagrant 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 Settings / Preferences Dialog as described in Enabling and Disabling Plugins.
|Vagrant executable||Specify 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 Select vagrant executable dialog box.
|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.
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 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.
|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.
|Environment variable||Click 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.
|Alt+Insert||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.
|Alt+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. |
|Alt+Insert||Click this button to install a new Vagrant plugin.|
|Alt+Delete||Click this button to remove the selected plugin.|
|Click this button to update the selected plugin.|
|Use this button to attach a license to the selected plugin.|
Last modified: 26 October 2017