👋 Email us at [email protected] with questions or feedback. We'd love to hear from you. If you have an account with RWX, view your support page for access to support via Slack.

Getting Started with Captain

If you use GitHub and have not already signed up for Captain, the easiest way to get started with Captain is to install the Captain GitHub app. After you install the GitHub app, we will automatically create an RWX account and organization for you to use to log into Captain, and Captain will begin automatically ingesting all of your build data.

We use the GitHub app for read-only access to your GitHub Actions workflow runs, which is how we collect the metrics we need to monitor your builds. You'll be able to select which repositories you want to grant access to when you are installing the GitHub app.

Installing the GitHub app

Installing the GitHub app is simple. Click here to install the Captain GitHub app on GitHub. If you belong to an organization on GitHub (like your company's organization), you'll be prompted to select either an organization or your personal account, like in this image:

Select the organization that you want to integrate with Captain. You'll then be presented with a screen allowing you to select which repositories you want to integrate with Captain. This screen also shows you which permissions Captain currently requires. Captain can't access any data outside of what these permissions allow.

If you aren't sure, we recommend selecting all repositories. You'll be able to rescind permissions or hide repositories in Captain if you eventually want to limit which repositories you can work on in Captain.

After clicking "Install & Authorize", you'll be redirected to Captain, where an account and organization will have been provisioned for you. After a few minutes, your data should be imported into Captain!

Once you've installed the GitHub app, you can begin using Captain to analyze your GitHub actions builds. To analyze and manage your test suites, however, you will still need to integrate your test suite.