Documentation for Crucible 3.0.x. Documentation for other versions is available too.

This page introduces the basics of using Crucible. By the end, you'll know how to:


We're assuming that:

Add a repository

First up we're going to add a repository to Crucible.

Click on Add Existing... in the Repositories listing of the Administration area.

Choose the repository type and fill in the name and description.

In the repository configuration put the location of your repository. Fill in the authentication details if necessary.

Finally indicate whether or not you would like diff indexing should be turned on and if the repository should not be indexed right away then click Add to finish the process.

Your repository is now created in Crucible and the indexing should have started.

Create a project in Crucible

Crucible comes with a default project, with the key CR, but you will will probably want to create your own projects to contain your reviews. This is achieved in a couple of steps.

Click on Add a new project in the Projects listing of the Administration area.

Fill in the form with the default settings for the project and hit Save.

You'll see your new project in the Projects listing.

Create a review

Now that you have your own project you can create reviews in it.


You need to be logged in to create reviews.

From the Dashboard click on Create review to open the review creation form.

Choose the project in which you want to create the review.

In the next screen click on Browse Changesets to see the list of changesets available to create the review.

Select the changesets that you would like to be reviewed and then click on Edit Details to add reviewers.

Once you have chosen your reviewers and updated the review information you can click on Start Review to begin the review process.

The review is now created and the reviewers will have been notified that a review is pending.

In order to close a review where you are the moderator you need to click on Summarize in the top right and then close the review from the modal window.

  • No labels