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:​

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.

Repo not connected

This repo is not part of your Swimm workspace. Please contact your admin.

In this case, you are not the admin. Only admins can connect (add) repositories to the Swimm workspace.

Repo not connected

Select a workspace from the list to connect this repo.

In this case, you are an admin, this message will be followed by a "connect" button.

Repo not connected

This public repo is part of another Swimm workspace which you are not a member of.

Public repositories can be connected to multiple Swimm workspaces. This message informs you that this repo is connected to another Swimm workspace. You might want to consider logging in to that workspace, or connect this repo to your current workspace.

Not a member?

You are currently not a member of [workspace name] workspace. Please check with your admin to request access.

User expired

You have been removed from workspace [workspace name]. Contact your Admin to resolve.

You are logged in, but cannot see any documents​

VS Code requires that the repository is launched from its root directory to function correctly.

Example: Swimm may not be able to find the documents if the repository is located at: /users/desktop/repo-name and you launched VS Code from /users/desktop.

Solution:
Open the repository's root folder from VS Code.

When you try to log in, the browser opens and nothing happens​

This may happen in some setups, for example when you run VS Code in Ubuntu and configure a specific browser to be the default one for VS Code.

Solution:
Copy the callback URL and paste it into your browser (the one you use for surfing the web).

You open a project with multiple repositories but the Swimm plugin is not working.​

VS Code uses something called Workspaces, but they're different from Swimm Workspaces. In VS Code, a Workspace is like a big box that can hold one or more folders, along with their settings and configurations. This makes it easy to switch between different projects or contexts.

Swimm is compatible with VS Code workspaces and can handle multiple repositories in the same view, as long as they're all on the same level.

Solution:
Make sure that the folders in your project (which represent different repositories) are added to the VS Code workspace.

In VS Code's menu, navigate to File > Add Folder to Workspace....

Add folder to VS Code Workspace

Supported scenarios​

Single repo

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

Sibling multi-repo

  • VS Code includes support for multi-root workspaces. This allows you to have multiple repositories open at the same level in the same window. Swimm’s welcome panel will detect the active repo and all information will be relative to it.

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.