Skip to main content

Connect repositories to Swimm

When you create a new workspace, it will consist of a single repository - Swimm's (demo) todo repo.

Swimm Side Menu

Getting started​

Add a repository​

Click the + Add new... button in the sidebar. Select Repo.

Add repo from Swimm Side Menu


By default, Swimm admins can connect repositories to the workspace. Non-admins can be granted permissions to add repositories to the workspace in Workspace settings -> Members.

Add Repository as non-admin

Connect your repository.​

Click on Allow GitLab Access to OAuth into your GitLab account.

Allow GitLab Access

We never store your code or your docs on our server. Read more about our security and privacy overview.

Sign into GitLab​

GitLab modal to sign into your account

Select or search for the repositories​

Add repositories to your workspace

Select and connect your repository (or multiple repositories) to your Swimm workspace.

Voila! Now that you have successfully added your repositories, go create your first Swimm document.

How to bulk add repositories​

Refer to our Add Repo API to add repositories in bulk.


If you don't see the repository you wish to add, Swimm doesn't have the correct permissions required and you’ll need to click the Manage Scope button at the bottom right of the dialog box.

Manage scope modal for repos

If you still cannot locate your repo, please reach out to us on our Community Slack Channel.

Authorizing Swimm's OAuth App​

Swimm installs GitLab's OAuth API to read and write documentation on your behalf. To configure GitLab for this, see Configure GitLab as an OAuth 2.0 authentication identity provider.

To view all authorized applications, follow GitLab's documentation.

  1. On the left sidebar, select your avatar.
  2. Select Edit profile and then select Applications.
  3. See the Authorized applications section.
Gitlab - manage OAuth apps

At any time you can remove any access by selecting Revoke.

How to change the order of repositories​

You can change the order of repositories displayed on the left-side navigation. Hover over any repository and drag the repository using the arrow icon.

Reorder repos in your Swimm workspace for Gitlab

Changing the order of your repositories only affects your Swimm account and not other Swimmers.