Why do I need to register to Swimm?
In order 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:
- Git is installed and your repo has a valid remote. To verify - run
git remotefrom the directory of the repository.
- Your organization is registered and has a Swimm account.
- You are a member of your organization's workspace.
- The repository you are working on has been added to the workspace.
- You have editing permissions to that repository.
Troubleshooting and Error messages:
Errors you may encounter, after logging in.
Make sure this repo:
- Is opened locally in your IDE
- It is a valid git repository
- 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
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:
After running this command, please reload the IDE.
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.
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.
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.
You are currently not a member of [workspace name] workspace. Please check with your admin to request access.
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.
This means that if the repository is located at:
And you launched VS Code from
/users/desktop, for example - Swimm may not be able to find the documents.
Workaround: 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.
Workaround: 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.
Make sure that the folders in your project (which represent different repositories) are added to the VS Code workspace ("File" ➝ "Add folder to Workspace").
- Opening a single repo from your IDE is the most straightforward way.
- 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.
- 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.