Quickstart
From zero to a gated pull request in about fifteen minutes.
1. Create your organization
Sign up — your account and first organization are created together. The Free plan needs no card and includes unlimited analyses.
2. Connect your AI provider (BYOK)
In Settings → AI provider, pick Anthropic, OpenAI, Mistral or Google, choose a model (suggestions load automatically) and paste your API key. Use Test connection — it makes one real call to validate the key + model pair. The key is encrypted with AES-256-GCM and never displayed again.
3. Write — or bootstrap — your playbook
In Playbook, add rules in plain language with a severity and optional glob scopes. Two rules you actually enforce beat twenty aspirations. Starting from an existing codebase? Click Bootstrap from repo and pick a few representative files — no agent required — or let a connected agent call bootstrap_playbook the same way. Either path lands proposed rules in a review queue for your approval(see MCP & agents).
4. Create a workspace token
In Settings → MCP & agents, generate a token — either for the whole organization or scoped to one workspace (workspace tokens inherit global rules). It's shown once; store it as a CI secret named NORMIK_TOKEN.
5. Add one job to your CI
The whole integration is a diff piped over HTTPS:
git diff "origin/main...HEAD" |
curl -sS --fail-with-body -X POST "$NORMIK_URL/api/ci/gate" \
-H "Authorization: Bearer $NORMIK_TOKEN" --data-binary @-Ready-made GitHub Actions and GitLab CI snippets — both able to post the verdict back as a PR or merge-request comment — are generated in Settings → CI integration.Full semantics in CI gate.
Optional: connect Claude Code
claude mcp add --transport http normik https://api.normik.io/api/mcp \
--header "Authorization: Bearer $NORMIK_TOKEN"Your agent now loads the playbook while it writes and self-checks before committing. Open the dashboard: the first analyses, violations and pre-commit fixes appear as they happen.