Skip to main content

Troubleshooting

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.

Supported Operating Systems

Please upgrade your operating system to the latest version to use Swimm. Here is a list of supported operating systems:

ManufacturerSupported versions
AppleSwimm is compatible with macOS 12.0 (Monterey) and newer.

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, open your terminal and 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:

caution

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.

Repo not found

This can happen if:

  1. The open folder/project is not part of a Git repo.
    • Try opening a folder/project that is in a Git repo.
  2. There's no remote named origin in the current Git repository.
    • Run git remote get-url origin and ensure it returns a valid Git remote URL.

Reload the IDE once you've set up the repo with a remote URL.

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.

caution

Login error:

  1. “No repo folder...”

The repository doesn’t have any Swimm Docs and has never been connected to your Swimm workspace.

Or

caution

Login error(s):

  1. “Cannot retrieve the workspace or repo information”
  2. “You are not a member of a workspace where [repo name] is connected to.”

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.

IDE: Rider

If you recently added a repository for your workspace and Rider does not recognize the repository, you may see a "Repo not found" error message in the Swimm plugin:

Repository not found in IDE

You may already have a valid remote origin that Swimm doesn't recognize. This is a known issue with Rider.

Primary Fix - index the .swm directory.

  1. Make sure a .swm directory exists in the root of your repository. If it does not, please create one.
  2. Right-click on the .swm directory and select Tools -> Start Index.
Idirectory in Rider IDE
  1. Wait for the indexing to complete. You may need to restart the IDE for the changes to apply.

Alternate fix - add the .swm directory to your Solution in Rider.

  • Open your Solution file. .sln
  • Add the .swm directory.
  • Save your Solution.

IDE: 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 repository

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

Git Submodules

Swimm currently offers partial support for Git submodules. To effectively manage and work with submodules within your Swimm workspace, please follow these guidelines:

Adding Submodules as Repositories

  • Manual Addition Required:
    • Submodules must be manually added as separate repositories to your Swimm workspace.

Selecting Code Snippets

  • In the IDE:
    • Select code snippets directly from submodules in your IDE as you would with regular repository files.
  • In the Web App:
    • Navigate to All repos in the Web App.
    • Choose the specific submodule's repository from the list to access and select code snippets.

Current Limitations

  • IDE Path Support:
    • Code-coupling a path from submodules is not yet supported in the IDE. This feature is under development and will be updated in future releases.

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.