Skip to main content


Why do I need to register to Swimm?
To start using Swimm, you will need a Swimm account with at least one workspace. Note that your repositories need to be associated with a workspace, and Swimm stores minimal metadata about your repositories.

Validate your setup

Many issues can be resolved if the environment is set up correctly. Before you start, ensure:

  1. Git is installed and your repo has a valid remote. To verify - run git remote from the directory of the repository.
  2. Your organization is registered and has a Swimm account.
  3. You are a member of your organization's workspace.
  4. The repository you are working on has been added to the workspace.
  5. You have editing permissions to that repository.

Troubleshooting and Error messages:


Login redirects your browser to localhost, showing This site can't be reached.

Simply open your IDE again. Login has succeeded despite this message.

In case you are curious to know more about this issue: This may happen if the browser your IDE opens by default is not on the same Operating System as your IDE. For example, you may be running your IDE within a virtual machine, and the browser opens on the host machine. You can fix this issue by (installing and) configuring your browser. See the official documentation for your product - for example, for WebStorm or PyCharm.)

Errors you may encounter, after logging in.

Invalid repo

Make sure this repo:

  1. Is opened locally in your IDE
  2. It is a valid git repository
  3. It has a valid remote.

Once you set it up, click the reload button.

Make sure you have Git in your PATH. See this Stack Overflow thread for more information.

Validate that your repo has a remote, by running git remote.

If you are running macOS, you may experience this issue after updating the OS. You can fix it by running the following command in your terminal:

xcode-select --install

After running this command, please reload the IDE.


Login error “No repo folder...”
Meaning: The repository doesn’t have any Swimm Docs and has never been connected to your Swimm workspace.



Login error “Cannot retrieve the workspace or repo information”
Or “You are not a member of a workspace where [repo name] is connected to.”
Meaning: The repository is not connected to a Swimm workspace or you are not a member of a workspace where this repository is connected to.

In case of all the errors listed above, make sure that:

  1. Your organization is registered and has a Swimm workspace.

    If not, create one - it’s free.

  2. You are a member of that workspace.

    If not, request your administrator to join the workspace.

  3. The repository you are working on has been added to the workspace.

    If not, log into the workspace and “add a repo” to your workspace.

  4. You have editing permissions to that repository.

    If not, ask your administrator to give you editing permissions.

  5. You are logged in to Swimm in the IDE.

In case you are using Android Studio

Follow these steps:

  1. Start the IDE, use Help -> Find Action, type "Choose Boot Java Runtime for the IDE", and press Enter.
  2. Select the newest version with JCEF to install.
  3. Click the OK button and wait until the file with JetBrains Runtime is downloaded and configured.
  4. Restart the IDE.

Supported scenarios

Single repo

  • Opening a single repo from your IDE is the most straightforward way.

Unsupported scenarios

Nested repositories

  • Nested repositories (such as Git submodules) are not a supported pattern.

Still having issues?

We would love to help. Reach out to us via our Community Slack Channel.

This document is automatically kept up to date using Swimm.