Start on GitHub
This is the shortest way to see what Groundrule does. You sign up, pick one repository on GitHub, and Groundrule shows which rules it already passes and what the others find. You need no terminal, and nothing is added to the repository.
You need: a GitHub account that can install an app on the repository’s account. For an organization, that means an owner, or a member the organization lets install apps.
Prefer to keep code on your machine? Use Start from a terminal instead.
-
Create your account.
Go to app.groundrule.dev, choose Create an account, then Sign up with GitHub. Or sign up with an email and confirm it from your inbox.
-
Name your workspace.
One screen. The workspace name and its URL are filled in from your email address. Choose Create workspace.
-
Choose a repository.
The next screen is titled “See what the rules find.” Choose Choose a repository. On GitHub, pick the account, choose Only select repositories, select one, and approve. GitHub sends you back.
-
Scan it.
Choose Scan this repository next to the repository. A dialog says exactly what is read and what is kept. Choose Turn on checks.
The row says “Scanning the default branch. This usually takes under a minute.” Leave the page open.
-
Read the result.
Choose See what the rules found. The page shows how many rules apply, how many already pass, and each rule with findings, with the file and line.
You should now see real findings from your own code. Nothing has been changed in the repository, and nothing blocks anyone.
What you just turned on
Section titled “What you just turned on”- A scan of the default branch, once. It runs again only when an admin chooses Scan again.
- A check on each pull request in that repository from now on, posted as the Groundrule check. It reports what a change introduces, never what was already there.
- What Groundrule keeps: the results. The code is read in a sealed sandbox with no internet access and deleted when the check ends. See Check pull requests without CI.
What to do next
Section titled “What to do next”| If you want to | Do this |
|---|---|
| Decide what each rule does | Open Rules, open a rule, and set its dial: Off, Tell agents, Warn or Block. See Adopting and tuning rules. |
| Cover more than security | Open Packs and choose under What do you want to stop? See Packs. |
| Give the rules to your coding agents | That part runs on a machine: Start from a terminal, from step 4. |
| Write a rule only your team knows | Rules → Describe a rule. See Describe a rule. |
| Bring your team in | Settings → Members → Invite. See Members and roles. |