Skip to main content

Installing CodeSherlock in Organization Repositories

CodeSherlock can be installed on repositories owned by either Personal GitHub accounts or Organization GitHub accounts.

This guide explains how an organization admin can install the CodeSherlock app on repositories under their GitHub Organization.

Installation Steps for Admin​

  1. Admin navigates to codesherlock.ai/signup.
  2. Admin clicks "Continue with GitHub".
  3. Admin is presented with a screen to choose the GitHub Organization.

Organization Selection Screen

  1. Admin selects the Organization where the repositories exist.
  2. Admin is presented with the "Authorize GitHub App" screen.

Authorization Screen

  1. Admin clicks "Authorize" to approve the CodeSherlock GitHub App.

  2. Admin is presented with "Install GitHub App" screen and prompted to "select the repos".

Installation Screen

  1. Admin selects the desired repositories and clicks "Install".

  2. The CodeSherlock app is installed in the Organization at the chosen repos.

  3. Admin is redirected to the CodeSherlock Dashboard.

  4. Admin is taken to the CodeSherlock dashboard screen.

    a. On the dashboard screen the admin is presented with a payment plan. Plan Screen

    Note: Every individual usage in the Organization plan is tracked separately and tokens are deposited against an individual developer.
    If the Admin is also a developer, they can choose to pay for the Paid plan.
    CodeSherlock signs up everyone for free and deposits 150k tokens.

    Here is the link to understand the plan better.

    • i. The admin chooses the Paid plan – the credit card details are filled, and payment goes through.
    • ii. The admin skips to Dashboard. At this point Admin is signed up for free, however no usage will be attributed if the admin does not request Pull Request Reviews.

  5. On the dashboard you will see the Repositories to which CodeSherlock was installed:

Dashboard Screen

Verifying Installation in the GitHub Organization​

To verify the installation:

  1. Go to your GitHub Organization Settings.
  2. Navigate to Third Party Access > GitHub Apps.
  3. Installed GitHub Apps should display the CodeSherlock App

Verify and Install Screen​

Next, all other Organization members who will use CodeSherlock for PR Review need to Sign up to CodeSherlock and pay individually if they need Paid plan token usage.
This creates an account for individual organization members and allows individual token usage, enabling individual users to accrue tokens based on their individual needs.

Here is how non admin Organization member pays for CodeSherlock:

  1. The non admin goes to codesherlock.ai/signup

  2. The non admin logs in to CodeSherlock by clicking “Continue with GitHub.”

  3. The non admin is presented with Authorize GitHub App screen.

Authorization Screen​

  1. The non admin clicks the Authorize button.

  2. The non admin lands into GitHub app CodeSherlock dashboard.

  3. The non admin is presented with a Payment plan page.

  4. The non admin chooses the Paid plan – the credit card details are filled, and payment goes through.

Or

  1. The non admin skips to Dashboard.

  2. The user is taken to the dashboard and the repositories where CodeSherlock app is installed is displayed:

  3. Repeat steps 1 through 9 for all Organization non admin team members. This concludes the Organization installation of CodeSherlock app and team members’ signup to CodeSherlock.

Dashboard Screen​