Robo

1. Inside composer.json, add the consolidation/robo dependency record to the require or require-dev section. Press CtrlSpace to get code completion for the package name and version.

   "require-dev": {
   "consolidation/robo": "^4.0.3"
   },

2. Install the dependency to your project from composer.json by either of the following:

   • Click the Install shortcut link on top of the editor panel.

   • If the Non-installed Composer packages inspection is enabled, IntelliJ IDEA will highlight the declared dependencies that are not currently installed. Press AltEnter and select whether you want to install a specific dependency or all dependencies at once.

3. In the Terminal tool window, execute the robo init command to add a RoboFile.php file to the project root.

   For guidance on adding commands to RoboFile.php, refer to the Robo documentation.

You can run a Robo command in IntelliJ IDEA by one of the following ways:

• Double-clicking the command on the list in the Robo tasks tool window. To open the Robo tasks tool window, select the Robo tasks bar on the sidebar or select View | Tool Windows | Robo tasks from the main menu.

  tip

  Note that the Robo tasks tool window is available only after you install Robo in your project.

• From the RoboFile.php file. Open RoboFile.php in the editor, click in the gutter next to the required method and select Run 'Robo task <name>' from the context menu.

• As a Run Anything action. Press Ctrl twice to open the Run Anything popup and type the Robo command name in it.

  

You can create a custom Robo run configuration or edit an existing default one.

1. From the main menu, select Run | Edit Configurations. Alternatively, select Edit Configurations from the list on the toolbar.

   

   In the Edit Configurations dialog that opens, click the Add button () on the toolbar and select Robo from the list.

   To edit the latest run configuration, click on the toolbar in the Run tool window.

2. In the Robo configuration dialog that opens, fill out or edit the Robo-specific settings as follows:

   File	Path to the robo executable file. IntelliJ IDEA by default sets the path to the robo file in the vendor/bin folder.
   Arguments	The Robo command name and path to your RoboFile.php file where Robo methods with arguments are defined in the following format: <command name> --load-from <path to RoboFile.php>.

   

   For details on configuring general run configuration settings, refer to Run/debug configurations dialog.

• If you have Robo tasks that you run on a regular basis, you can add the corresponding run configurations to a list of startup tasks in the Startup Tasks settings. The added tasks will be executed automatically on each project startup.