Dokumentation

Erste Schritte mit TesterPayKit

Vom Projektkonto bis zum ersten Bug-Report: Projekt anlegen, SDK in deine App einbauen und sichten, was deine Tester finden — in der Web-Konsole oder im Terminal.

⚙️

Setup

Konto anlegen, Projekt anlegen, SDK einbauen

🐛

Bug-Reports

Wie Tester Bugs melden und was in einem Report steckt

⌨️

CLI & MCP

Bugs im Terminal oder per KI-Agent sichten

🧩

SDKs

Flutter, Expo, Web/React und Swift im Überblick

# Setup

1. Konto anlegen

Lege ein Kundenkonto für deine Projekte an. Mit bestehendem Konto kannst du dich in der Web-Konsole anmelden. Die Testerregistrierung findest du gesondert auf der Anmeldeseite.

Konto anlegen Anmelden

2. Projekt anlegen

Jede App bekommt ein eigenes Projekt, erkannt an ihrer Bundle-ID. Leg es in der Web-Konsole an oder mit der tpk-CLI — die JSON-Ausgabe enthält die Projekt-ID, die das SDK braucht:

dart pub global activate tpk_cli
tpk login
tpk --json project create --name "My App" --bundle-id com.example.myapp

3. SDK installieren

Wähl das SDK für deinen Stack:

Flutter

flutter pub add testerpaykit

Expo / React Native

npx expo install \
  @testerpaykit/expo \
  @react-native-async-storage/async-storage \
  expo-sensors expo-device expo-application expo-file-system expo-audio

Web / React

npm install @testerpaykit/react @testerpaykit/sdk @testerpaykit/api-client @testerpaykit/storage-browser

Swift

Früher Zugang: ein Swift Package, das noch in keinem öffentlichen Verzeichnis liegt. Schreib an [email protected], dann schicken wir es dir.

4. Mit deiner Projekt-ID initialisieren

Flutter: vor runApp initialisieren, die App umhüllen und mit flutter run --dart-define=TPK_PROJECT_ID=<project-uuid> starten.

import 'package:flutter/material.dart';
import 'package:testerpaykit/testerpaykit.dart';

final _navigatorKey = GlobalKey<NavigatorState>();

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  final tpk = await TesterPayKit.initialize(
    config: TesterPayKitConfig(
      projectId: const String.fromEnvironment('TPK_PROJECT_ID'),
      apiBaseUrl: 'https://api.testerpaykit.com',
      enableTesterMode: true,
    ),
  );
  runApp(MaterialApp(
    navigatorKey: _navigatorKey,
    // Screen-Aufrufe zählen die aktiven Testminuten.
    navigatorObservers: [tpk.navigatorObserver],
    builder: (context, child) => TesterPayKitWrapper(
      sdk: tpk,
      navigatorKey: _navigatorKey,
      child: child ?? const SizedBox.shrink(),
    ),
    home: const HomeScreen(),
  ));
}

Expo / React Native: einmal initialisieren, dann melden Tester per Schütteln.

import { TpkExpo, useShake } from '@testerpaykit/expo';
import { useEffect, useState } from 'react';

export function App() {
  const [tpk, setTpk] = useState<TpkExpo | null>(null);

  useEffect(() => {
    TpkExpo.init({
      projectId: '<project-uuid>',
      testerCode: '<tester-invite-code>',
    }).then(setTpk);
  }, []);

  useShake({
    enabled: !!tpk,
    onShake: () => {
      tpk?.submitBug({
        title: 'Per Schütteln gemeldet',
        description: 'Tester hat das Gerät auf dem Startscreen geschüttelt.',
        currentScreen: 'HomeScreen',
      });
    },
  });

  return null; // hier deine echte UI
}

Vollständiges Setup, ausfallsichere Initialisierung und alle Optionen: testerpaykit auf pub.dev · @testerpaykit/expo auf npm

# Bug-Reports

So melden Tester

Tester treten deinem Projekt mit einem Einladungscode bei, den du in der Web-Konsole vergibst. In deiner App schütteln sie das Gerät oder tippen auf den schwebenden Knopf und schicken einen Report mit:

• einem Screenshot, auf Wunsch mit Markierungen
• einer Bildschirmaufnahme
• einer gesprochenen Sprachnotiz statt Tippen

Was in einem Report steckt

• Vom Tester: Titel, Beschreibung, Schweregrad (critical, high, medium, low) und, falls angegeben, Schritte zum Nachstellen sowie erwartetes und tatsächliches Verhalten
• Gerät und App: Gerätemodell, OS-Version, App-Version, Build-Nummer und Bundle-ID — ergänzt das SDK
• Der Weg dorthin: der aktuelle Screen und eine Spur der Screens und Aktionen vor dem Report
• Abstürze: erfasst das SDK und legt sie selbst als Report an
• Anhänge: Screenshots, Bildschirmaufnahmen und Sprachnotizen

Sichten

Die Reports landen in deinem Projekt. Arbeite sie in der Web-Konsole ab oder liste sie im Terminal:

tpk bug list --severity critical --since 24h
tpk bug get <bug-id>

# CLI & MCP

Installieren und anmelden

tpk ist die Kommandozeile von TesterPayKit. tpk login öffnet die Web-Konsole im Browser; dort bestätigst du die Anfrage. Jeder Befehl kann --json für Skripte und Agenten.

dart pub global activate tpk_cli
tpk login
tpk project list

Vom Bug-Report zum Fix

Gib einen Report an dein KI-Coding-Tool, hol dir die Anhänge und markier ihn in einem Release als behoben:

tpk bug context <bug-id>          # JSON für einen Fix-Prompt
tpk bug download <bug-id>         # Screenshots, Aufnahmen, Sprachnotizen
tpk bug fix <bug-id> --version 1.2.3

MCP-Server für KI-Agenten

Die CLI bringt ein zweites Programm mit, tpk_mcp. Es gibt Agenten Lesezugriff auf deine Sessions, Zeitleisten, Bugs und Bug-Kontext über das Model Context Protocol und nutzt dafür die Anmeldung aus tpk login. Für Claude Code:

claude mcp add tpk -- tpk_mcp

Bereit loszulegen?

Lege ein Projektkonto an oder schau dir zuerst die SDKs an. Für zusätzliche Tester prüfen wir gesondert die Verfügbarkeit.

Konto anlegen SDKs ansehen