Getting started
Create an account, connect GitHub, run your first scan and review the findings: five steps, about five minutes.
Five steps take you from nothing to a scanned pull request. It takes about five minutes. Nothing is added to your CI pipeline and no configuration file is needed.
1. Create your account
Go to Sign up. Use an email and password (confirm the email we send), or choose Continue with GitHub.
- GitHub sign-in uses the GitHub account your browser is signed in to. It does not ask which one. If you have several GitHub accounts, check the avatar at the top right of github.com first, or use a separate browser profile for each account.
- The setup screens show Signed in as at the top: your name, how you signed in and your TrustLedger organisation. Check it reads what you expect before you continue.
- You can be signed in on one device at a time: signing in on a second device signs the first one out.
2. Connect GitHub
On the Connect GitHub setup step, click Install on GitHub and install the TrustLedger GitHub App.
- Choose the account that owns your repositories: your company, or your own account if the repositories are yours. GitHub installs on the account you are signed in to in this browser.
- Select the repositories you want scanned. One is enough to start. The app asks for read access to pull requests and code, and write access to checks (see the Trust Center).
- GitHub sends you back to TrustLedger, which shows GitHub App installed on <name> and fills in your GitHub name.
- If you install on a company account you do not own, GitHub asks an owner to approve it first. Nothing is scanned until they do.
Your GitHub name
This is the one field people get wrong. It is the name that comes right after github.com/ in your repository addresses: in github.com/acme-corp/payments-api it is acme-corp.
- TrustLedger matches every pull request to your organisation by this name. If it does not match, the pull request is not scanned and no check appears.
- It is not your email address, your TrustLedger organisation's name or a full repository link. Capital letters do not matter.
- One GitHub name can be linked to one TrustLedger organisation.
3. Select your repository
The free early-access plan covers 1 repository. The first repository that receives a scan is connected automatically, so you pick it by opening a pull request in it. You can see and manage connected repositories in the dashboard under Repositories. A second repository is not scanned on the free plan: the check on its pull request says so, and you can ask us for more at trustledgerapp.dev@gmail.com.
4. Run your first scan
Open a pull request, or push a commit to an existing one, in the connected repository. Within a minute or two a check named TrustLedger AI Governance appears on the pull request, first as in progress and then with a result. Large pull requests take longer because scans run from a queue.
No pull request handy? Try the live demo first: it scans a sample in your browser.
5. Review the findings
Open the scan from the check's Details link or from the dashboard.
- The Security findings card counts vulnerabilities by severity. In the file list, the Findings column shows each file's share of that count; AI-provenance and code-hygiene hints are shown apart as signals and are not vulnerabilities.
- Open a finding to see its Data flow: where untrusted input enters, each step it passes through (including other files) and the dangerous call it reaches, with a suggested fix.
- Fix the code, or attest the file: a named reviewer signs it off. With the default policy, files at CRITICAL or HIGH risk block the merge until they are fixed or attested. A finding that is not real can be marked a false positive, or accepted as a risk with a reason and an optional expiry.
What the free early-access plan includes
The whole product, with an allowance of 3 pull-request scans a month, 1 repository and 2 team members. Reviewer sign-offs are unlimited. The scan count restarts on the first day of each month (UTC). Need more while you evaluate? Write to trustledgerapp.dev@gmail.com.
Scanning outside a pull request
To scan code from a CI job or a monorepo export, an administrator creates an API key under Settings → API Access, and the job sends the files to POST /api/scans. A key can submit scans and read their results; it can never attest a file. Scans sent this way count against your plan's limits, like any other scan:
curl -X POST https://<your-deployment>/api/scans \
-H "X-TrustLedger-Key: tl_live_..." \
-H "Content-Type: application/json" \
-d '{"repo":"acme/api","pr_number":482,"commit_sha":"<sha>","files":[{"path":"src/db/users.ts","content":"..."}]}'See the API reference for every field. GitLab and Bitbucket are also supported.
Stuck?
Start with Troubleshooting. Anything else, or a false positive or missed vulnerability to report, goes through Contact and feedback.
Next: Engine architecture →