Start with a local static scan. Add policy, CI or a browser audit as your workflow needs them. Examples assume the current CLI and a supported website project; they do not require an existing npm registry release.
| Guide | What you will do |
|---|---|
| Getting started | Run the demo, choose a project root and inspect your first report |
| Understanding reports | Separate findings, review items and coverage gaps; interpret scores and machine output |
| Coverage and limitations | Check supported project shapes and understand what each scan can establish |
| Troubleshooting | Resolve detection, output, policy and runtime setup failures |
| Guide | What you will configure |
|---|---|
| CLI reference | Commands, options, defaults and exit codes |
| Project configuration | Severity gates, baselines and reasoned suppressions |
| Browser audits | Playwright/Axe, routes, viewports and an existing build or server |
| Continuous integration | A source-based GitHub Actions job and retained machine reports |
| JavaScript API | Use the scanner and report APIs from your own tooling |
Contributing explains the development loop and rule-quality requirements. GitHub setup covers the first source push. Releasing covers package publication. These maintainer tasks are separate from scanning a website.
Source architecture maps implementation responsibilities and the boundaries to preserve when refactoring.
For private vulnerability reports, use the security policy. For a Turkish introduction, read Türkçe başlangıç rehberi.