Quick Start
Use this path when you want VULQN reviewing PRs as quickly as possible.
Before you start
Section titled “Before you start”You need:
- A VULQN account.
- Access to the organization or workspace you want to connect.
- Permission to install the VULQN GitHub App, authorize the GitLab group, or authorize the Bitbucket workspace.
- At least one repository you want VULQN to monitor.
Every account starts with a 15-day trial that includes 20 normal reviews and 5 peer reviews.
1. Sign in
Section titled “1. Sign in”Open app.vulqn.ai and sign in. If this is your first workspace, VULQN takes you to onboarding automatically.
If you already have a workspace, open Settings and choose Add provider.
2. Connect a provider
Section titled “2. Connect a provider”Choose one provider:
| Provider | What happens |
|---|---|
| GitHub | VULQN sends you to GitHub to install the VULQN GitHub App on an organization. Choose all repositories or selected repositories in GitHub, then return to VULQN. |
| GitLab | VULQN sends you to GitLab OAuth. After authorization, choose the group to monitor. VULQN configures webhooks automatically (group-level for Premium, project-level for free). |
| Bitbucket | VULQN sends you to Bitbucket OAuth. After authorization, choose the workspace to monitor. If the workspace is not listed, enter the workspace slug manually. |
After the connection completes, VULQN syncs repository metadata into your workspace.
3. Enable repositories
Section titled “3. Enable repositories”Open Settings and use the repository controls for the connected provider.
For each repository:
- Enable the repository.
- Check the branch filter. New repositories default to
main,master. - Clear the branch field if VULQN should review PRs to any target branch.
- Turn on peer review only for repositories that need the extra validation and have peer credits available.
You can sync repositories again later if new repos are added or provider permissions change.
4. Open or update a pull request
Section titled “4. Open or update a pull request”VULQN reviews active repositories when a PR is opened, reopened, or updated. If the target branch does not match the repository branch filter, the PR is ignored.
During a review, the PR build status moves to in progress. When the review finishes, VULQN posts inline findings, updates the PR description with the review summary, and sets the build status to passed or failed based on the confidence gate.
5. Use the dashboard
Section titled “5. Use the dashboard”The dashboard shows:
- Total PRs reviewed.
- Active repositories.
- Remaining normal and peer credits.
- Open critical and medium findings.
- Recent review activity.
- Top finding categories across recent reviews.
Open a review detail page to inspect findings by severity or by file, see resolved or acknowledged findings, and jump back to the source-control thread.
If the first review does not appear
Section titled “If the first review does not appear”Check these items first:
- The repository is enabled in Settings.
- The PR target branch matches the repository branch field.
- The provider connection is active.
- Your trial, subscription, or add-on credits are still active.
- For GitHub, the app installation includes the repository.
- For GitLab, the webhook is registered automatically when you enable a repository (project-webhook mode) or is already covered by the group webhook (Premium).
- For Bitbucket, run Sync repos after changing workspace access.