Getting Started with BunCover
Learn how to set up BunCover and generate your first coverage report in just a few minutes.
Prerequisites
Before you begin, make sure you have:
- Node.js ≥ 18.0.0 installed
- A BunCover account (sign up at buncover.io)
- A project with Bun test runner configured
Installation
Install the BunCover CLI globally:
npm install -g @qualipsolutions/buncover
Verify the installation:
buncover --version
First Coverage Report
1. Login to BunCover
buncover login
This will open your browser to authenticate with your BunCover account.
2. Create a Project
buncover create-project --name "My Project"
This creates a new project and returns a project ID.
3. Start File Server (Optional)
buncover serve
Run this in a separate terminal to enable source code viewing in the web interface.
4. Run Coverage
buncover run
This runs your tests and uploads the coverage report to BunCover.
🎉 Congratulations!
You've successfully set up BunCover and generated your first coverage report. You can now view your coverage data in the dashboard.