PhpStorm 2021.3 Help

Getting started with Space

If the Space plugin is enabled and you are not yet logged in to Space, the Space icon Space icon is displayed on the toolbar. To start using Space, you must log in to a Space organization and then either clone a Space project or share your project on Space.

Log in to Space

To log in to Space, you need to provide your organization URL and your account credentials. If you don't have a Space organization, you can create one.

  1. On the toolbar, click Space icon.

  2. Enter your organization URL and click Log In.

    Log in to Space
  3. This will open your default browser. If you are already logged in to the Space web app, click Accept. Otherwise, enter your username and password, and click Log In.

    Space credentials

Once you are logged in to Space, your profile picture is displayed on the toolbar.

Space features, such as code reviews, and merge requests, are available for code that is hosted on Space as part of a Space project. After you are logged in, you can:

Clone a repository

If you have logged in to Space, you can view all projects of your Space organization and clone their repositories.

  1. From the main menu, select Tools | Space | Clone Repository.

  2. In the window that opens, select a repository and click Clone.

    Clone Space repository

You can view the progress of cloning in the status bar. When the repository is successfully cloned, the New Project window opens to let you choose where to open the project in PhpStorm: in a new window or in the current window.

Share a project

If you have a local project, you can share it – that is, upload your repository to a Space project.

  1. From the main menu, select Tools | Space | Share Project on Space.

  2. In the Create Repository in Project list, select a Space project. You can also create a new project directly in PhpStorm.

  3. Enter the repository name and description.

  4. Click Share.

    Share a project in Space
  5. In the Initial Commit Files window that opens, select the files that you want to share and click Add.

Your code is now available in Space. You can open any file in the Space web app by right-clicking a file and selecting Open In | Space.

Create a project

If you don't have a Space project, you can create it right from PhpStorm.

  1. From the main menu, select Tools | Space | Share Project on Space.

  2. Next to the Create Repository in Project list, click New….

  3. Fill out the Create New Project on Space form:

    • In the Name field, enter the project name.

    • In the Key field, enter an identifier that will be used in the project URL.

    • Select Private if you want the project to be visible to its members only.

    • In the Description field, enter a description that will be displayed on the project web page and in the list of projects when you clone them.

  4. Click Create.

Create a project in Space

You can now share your code in that new project.

The Space plugin lets you open some of the pages of the Space web app right from PhpStorm. If you are logged in to a Space organization, you can navigate to Space checklists and issues from PhpStorm. If a project that is currently opened in PhpStorm is hosted on Space, you can also open web versions of your files, commits, Automation jobs, and reviews.

Access checklists and issues

  1. Click your profile icon on the toolbar.

  2. Click Checklists or Issues.

Open a file

  1. In the Project tool window, right-click a directory or a file.

  2. In the context menu, select Open In | Space.

To get a Space link to a file, in the same context menu you can click Copy Path/Reference | Copy Link to Space.

Open a commit

  1. In the View | Tool Windows | Git tool window, select the Log tab.

  2. Right-click a commit and, in the context menu, select Space | Open on Space.

To get a Space link to a commit, in the same context menu you can click Space | Copy Link to Space.

Open a review

  1. In the Code Reviews tool window, select a review.

  2. Click the link in the review title.

Open Automation job log

  1. In the View | Tool Windows | Git tool window, select the Log tab.

  2. To the right of a commit, click a job status (available if there is an Automation job triggered for this commit).

  3. In the Space Automation window that opens, click the link next to the job status.

Open a chat

  1. In the Code Reviews tool window, right-click a review.

  2. Select a user, and click Go to Chat….

Last modified: 08 December 2021