Amikoo Reporter

Playwright reporter for Amikoo - Automatically installs and configures test reporting to Amikoo platform.

Features

• 🚀 Automatic Setup: Installs and configures everything with one command
• 📊 Comprehensive Reporting: Captures test results, videos, and screenshots
• 🔧 Zero Configuration: Works out of the box with sensible defaults
• 🎯 Git Integration: Automatically captures branch, commit, and repository info
• 📹 Media Support: Uploads test videos and screenshots to Amikoo

Installation

Install the package in your Playwright project:

npm install @muuktest/amikoo-reporter --save-dev

That's it! The package will automatically:

• ✅ Configure or create your playwright.config.ts (or .js)
• ✅ Create or update your .env file with the required key

Configuration

After installation, update your .env file with your Amikoo API key:

AMIKOO_KEY=your_amikoo_key_here

How to obtain the key

• AMIKOO_KEY: Obtain from Amikoo application under your account settings or API keys section.

URL: https://app.amikoo.ai

Project Structure

After installation, your project will have:

your-project/
├── tests/
│   └── ... your test files
├── playwright.config.ts  (configured automatically)
├── .env  (template created or updated with AMIKOO_KEY)
├── node-modules/
│   └── @muuktest/ (installation folder for amikoo-reporter)
└── package.json

Usage

Run your Playwright tests as usual:

npx playwright test

Test results will automatically be reported to Amikoo!

What Gets Reported

The reporter automatically captures and sends:

• ✅ Test execution status (passed/failed/skipped)
• ✅ Test duration and timing
• ✅ Error messages and stack traces
• ✅ Git information (branch, commit, author)
• ✅ Test videos (when enabled)
• ✅ Screenshots (when enabled)
• ✅ Browser and environment details

Playwright Configuration

The installer automatically configures your playwright.config.ts. If you created the config manually, ensure it includes @muuktest/amikoo-reporter as well as any other reporter you previously used in reporter property:

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [['@muuktest/amikoo-reporter']],
  use: {
    video: 'on',        // Optional: capture videos
    screenshot: 'on'    // Optional: capture screenshots
  },
  // ... rest of your config
});

Troubleshooting

Reporter not found

Make sure the @muuktest/amikoo-reporter folder exists in your node-modules project root. Run npm install @muuktest/amikoo-reporter --save-dev to reinstall.

API key errors

Verify your .env file contains a valid AMIKOO_KEY.

Videos not uploading

Ensure video: 'on' is set in your Playwright config's use section.

Advanced Configuration

Multiple Reporters

You can use Amikoo reporter alongside other reporters:

export default defineConfig({
  reporter: [
    ['list'],
    ['html'],
    ['@muuktest/amikoo-reporter']
  ],
});

Custom Test Directory

If your tests are not in the ./tests folder:

export default defineConfig({
  testDir: './e2e',  // or your custom path
  reporter: [['@muuktest/amikoo-reporter']],
});

Support

For issues and questions:

• GitHub Issues: https://github.com/muuklabs/controlhub-reporter/issues

License

ISC