Skip to main content
This guide shows the minimum path to start using Acrity in a workspace.

​
Before you start

You need:
  • Access to the Acrity Console.
  • A user with Workspace admin permission in the workspace.
  • Permission to install or authorize the code provider used by the team.
  • At least one repository with active pull requests or merge requests.
  • Optionally, administrative access to a work management tool such as Jira, Linear, or ClickUp.
Connected Apps, Credentials, Connectors, Repositories, and Policy Engine require a Workspace admin (platform admins also have access).
1

Select your workspace

Enter the Console and choose the workspace from the top selector.
2

Review language and members

In the workspace selector and workspace settings, confirm the default language, workspace admins, and users who need to track reviews.
3

Connect the code provider

Go to Console > Connected Apps when you can use OAuth or a GitHub App. Use Console > Credentials for manual credentials. Use Console > Connectors when the VCS is private, self-hosted, or on a restricted network.
4

Connect repositories

In Console > Repositories, select Connect repository, choose the authentication source, and confirm the repositories that should receive reviews.
5

Bootstrap ARCHITECTURE.md

Open the repository in Console > Repositories > Repository detail and start the ARCHITECTURE.md bootstrap. This gives reviews the project context they rely on. A repository is not ready for reviews until it has a bootstrapped ARCHITECTURE.md, so complete this step for every repository you connect.
6

Adjust the review policy

Use Console > Policy Engine for workspace rules and, when needed, adjust specific settings in Console > Repositories > Repository detail.
7

Validate the first PR or MR

Open or update a PR/MR in the code provider and track the review on the Ops dashboard — where reviews appear — and in the provider output. Use Console > Audit Trail only for technical event details and diagnostics.

​
Quick decision: which connection type should you use?

ScenarioUse
GitHub Cloud with managed installationConnected GitHub App
GitLab, Bitbucket, Azure DevOps, Jira, Linear, or ClickUp through OAuthConnected Apps
Personal token, project token, or technical credentialCredentials
Private VCS, self-hosted VCS, or no inbound access to the cloudConnectors
Prefer Connected Apps when the provider supports them. They simplify authorization, reauthorization, and repository discovery.

​
Production readiness checklist

  • The workspace has at least two workspace admins.
  • Important repositories appear as ready in Console > Repositories, each with a bootstrapped ARCHITECTURE.md.
  • The workspace and repository languages are correct.
  • The author policy blocks accounts that should not generate cost or review activity.
  • API keys have minimum scope, expiration, and IP allowlist when applicable.
  • Outbound webhooks use HMAC when the destination supports verification.
  • Workspace admins reviewed the security pages before configuring production credentials.