Logo

Getting Started

The Muse app is installed and managed through the GitHub marketplace at https://github.com/apps/muse-dev. Getting started with Muse is as easy as:

  1. Installing the GitHub app
  2. Selecting a few repositories to analyze
  3. Viewing any bugs found in the Muse Console

NOTE: These steps let you quickly see existing issues within your code base. Muse normally runs automatically at each pull request and reports only on new errors, delivering results as inline code review comments. Learn about our developer-centric approach to code analysis at Running Muse for more information.

GitHub App Installation

  1. Login to your GitHub account and go to the application settings page. Click install.

  2. Muse can be configured to analyze all of your repositories, or a select subset of them. Chose one of these options from the dialog, as show below. Click install.

image

  1. Review the application permissions and click Authorize Muse-Dev by MuseDev.

  2. Once the app is installed, you will be redirected to the Muse Console. Muse will now attempt to analyze pull requests for your repositoriies.

Analyze Your First Repository

When visiting the Muse Console, you will see a list showing all repositories you have installed the Muse app on (for each organization seperately).

image

From this screen, you can select any repository for Muse to get started analyzing. Simply click the “Analyze Now” button. You will then be forwarded to the analysis view where you can watch Muse inspect your code.

If you want to try out muse, but you don’t have a suitable repository on-hand, see this guide to clone a test repo and see Muse working.

image

The yellow color of the page indicates that Muse is building and analyzing your code. This can take some real time (roughly twice the normal build time of your project), so feel free to stretch, grab a cup of coffee, or whatever. Muse will take it from here. Once Muse has finished analysis, you will be able to view the results by clicking on the results tab. If there is a problem with analysis you may also click to see the failing build log. See Troubleshooting page for help if there is a build error.

image

If you made it here, you’re all good to go! You can see the existing bugs that Muse found in your repositories, and any installed repositories will be analyzed every time you create a pull request in GitHub. For more information on that workflow see Running Muse. Happy Musing!