Riscly docs

Get started

Quickstart

Connect a repository and get a full architecture and risk report in a few minutes — no card required for your first project.

Option A — in the dashboard

  1. Create an account. Sign up with email and a password, or use Google / GitHub single sign-on.
  2. Connect a repository. On Get started, authorize GitHub or GitLab. Riscly requests the minimum scope needed to read repository contents.
  3. Run a scan. Start a scan from the project. It infers your architecture and runs SAST, dependency and secret analysis.
  4. Review & fix. Open the architecture map and the risk list. For any code-located finding, choose View fix, then Apply fix to push it to your repo.

First project is free

You can run your first project on the free tier. Upgrade when you need more projects, scans or seats — see Pricing.

Option B — via the API

Prefer automation? The same flow works over the REST API. First grab your token and org id (see Authentication), then:

1. Create a project

curl -X POST https://api.riscly.com/api/projects \
  -H "Authorization: Bearer $RISCLY_TOKEN" \
  -H "x-org-id: $RISCLY_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"my-app"}'

2. Start a scan and poll until it finishes

// kick off the scan
const scan = await riscly(`/projects/${project.id}/scans`, {
  method: "POST",
  body: "{}",
}).then((r) => r.json());

// scans can run in the background — poll the list until done
async function waitForScan(projectId, scanId) {
  while (true) {
    const scans = await riscly(`/projects/${projectId}/scans`).then((r) => r.json());
    const s = scans.find((x) => x.id === scanId);
    if (s && (s.status === "succeeded" || s.status === "failed")) return s;
    await new Promise((r) => setTimeout(r, 2000));
  }
}

const done = await waitForScan(project.id, scan.id);
console.log("posture score:", done.reliabilityScore);

The riscly() helper

The examples use a small wrapper that adds the auth headers. You can define it once — see the Authentication page.

Next steps

PreviousIntroductionNext Authentication