codechecks.io — Documentation

Open source platform for code review automation.

With Codechecks you can replace tools like:

• BundleWatch
• CodeCov

and build even more cool stuff:

• visual regression
• type coverage checking for typescript projects
• deployments per commits
• performance tracking

Check out what's already build

Best part: everything is open source and checks run in userland (your CI) meaning you can implement totally new ideas without any backend changes — it's just JavaScript. API component is general enough to fit lots of different use cases.

If you want to get in, please contact us at [email protected]

Expect more docs soon...

Contents

1. Getting started
2. How does it work?
3. Configuration — codechecks.yml/json/ts/js
   1. CLI options
4. Checks (plugins) development
   1. Developing reusable checks
   2. Testing checks
5. How to build X?
6. Client API reference
7. Local mode
8. Supported CI providers
   1. Adding new CI
9. Debugging
10. Badges
11. FAQ
12. Roadmap