Getting started with Ship

Installation

Download for macOS

macOS 10.11 El Capitan or higher is required to run Ship. 10.13 High Sierra is recommended.

Signing In

When you launch Ship for the first time you will be prompted to sign in with GitHub. Follow the prompts to complete the sign in process.

After a short delay during which Ship loads your data from GitHub for the first time, you may begin interacting with your issues. Subsequent sign-ins to your account, even from different computers, will be accelerated as your data will already be cached on Ship’s servers in an optimized format.

GitHub Organization Access

GitHub Organizations can restrict access to third party applications such as Ship. The GitHub help document “About third-party application restrictions” has more information.

If you are an organization admin, you can grant access to Ship during the sign in process. If you are not an organization admin, you can request access to an organization of which you are a member during the sign in process. GitHub has a help document on this topic.

Once you’ve signed in to Ship, you can adjust its access, including requesting access to additional organizations, in your GitHub settings.

Selecting Repositories

During your first sign in to Ship, you will be presented with the opportunity to choose which repositories you wish to use with Ship. By default, the selected repositories include repositories with issues enabled that you can modify. You can deselect repositories if you don’t plan to use them with Ship. You can also add any additional public repositories that you want to use with Ship.

Tip

You can modify your list of synchronized repositories at any time from the Ship → Choose Repositories menu.

Multiple Accounts

If you have multiple GitHub accounts, you can manage them using the Ship → Account menu. You can add additional accounts and easily swap between them using the Account menu.