Getting started
Prepare an environment
An environment is a private copy of your repository with the dependencies needed to run its code. Arcanist prepares the environment before it runs reviews.
Choose repositories during setup, or open Repositories to add them later. You can leave the page while preparation runs and return to Repositories to check progress.
Understand the status
| Status | What to do |
|---|---|
| Preparing | Wait while Arcanist installs dependencies and checks the setup. |
| Ready | Start a review. Arcanist can run code in the environment. |
| Needs your input | Select Add credentials or Answer question and provide the requested information. |
| Waiting for Arcanist | Arcanist is working on a setup issue. You do not need to retry. |
| Setup stopped | Select Try again. If GitHub access is missing, select Review GitHub access and restore it first. |
Provide setup information
If setup asks a question, select Answer question, enter your answer, and select Send.
If setup requests credentials, enter them through Add credentials. Optional credentials can be skipped. If you cannot supply a requested value, select Can't provide these so Arcanist can continue without it.
Saved secret values are not shown again in the browser. Do not put secrets in pull request comments, review replies, or support messages.
Prepare related repositories
On a Team workspace, you can select up to 20 repositories per batch. Each gets a separate environment by default. Starter supports one repository.
For an application that needs several repositories together, open Advanced setup and select Prepare repositories together. Choose a primary repository and up to seven related repositories under the same GitHub owner.
Arcanist places those repositories in one environment. Pull requests on the primary repository trigger reviews. Select Prepare in separate environments to return to individual setup.