@sorry-currents/cli

CLI-native, zero-infrastructure Playwright test orchestration. The sorry-currents command is the entry point for all user interactions.

Installation

npm install -g @sorry-currents/cli
# or use npx
npx @sorry-currents/cli <command>

Commands

sorry-currents init

Interactive onboarding wizard. Auto-detects CI provider, package manager, and Playwright config. Generates working CI workflow + reporter configuration.

sorry-currents init
sorry-currents init --ci github-actions --shards 4 --skip-prompts
sorry-currents init --dry-run  # Preview without writing files

sorry-currents plan

Generate an optimized shard execution plan from historical timing data.

sorry-currents plan --shards 4
sorry-currents plan --target-duration 30 --max-shards 8
sorry-currents plan --output-matrix          # GitHub Actions matrix JSON
sorry-currents plan --fail-fast threshold --max-failures 5
sorry-currents plan --strategy round-robin   # Alternative strategy

| Option | Default | Description | | ------------------------ | ---------------------------------- | ------------------------------------------------------- | | --shards <n> | — | Fixed shard count | | --timing <path> | .sorry-currents/timing-data.json | Path to timing data | | --output <path> | stdout | Write plan to file | | --output-matrix | false | Output GitHub Actions matrix JSON | | --strategy <name> | lpt | Balancing strategy: lpt, round-robin, file | | --default-timeout <ms> | 30000 | Estimated duration for tests without history | | --fail-fast <mode> | off | Fail-fast strategy: off, first-failure, threshold | | --max-failures <n> | 1 | Failure threshold for --fail-fast threshold |

sorry-currents run

Run Playwright tests with sorry-currents reporter auto-configured.

sorry-currents run --shard-plan shard-plan.json --shard-index 1
sorry-currents run --fail-fast first-failure
sorry-currents run -- --config=custom.config.ts --workers 4

sorry-currents retry-failed

Rerun only failed tests from a previous merged run result.

sorry-currents retry-failed
sorry-currents retry-failed --input .sorry-currents/merged-run-result.json
sorry-currents retry-failed --include-interrupted
sorry-currents retry-failed -- --project chromium --workers 2

| Option | Default | Description | | ----------------------- | ---------------------------------------- | -------------------------------------------- | | --input <path> | .sorry-currents/merged-run-result.json | Path to merged run result JSON | | --run-id <id> | auto | Explicit run ID for the retry run | | --include-interrupted | false | Include interrupted tests in retry selection |

sorry-currents merge

Merge results from multiple shards into a single run result. Also generates updated timing data for the next run's shard balancer.

sorry-currents merge
sorry-currents merge --input .sorry-currents/shards --output .sorry-currents

sorry-currents report

Generate reports from run results.

sorry-currents report --format html
sorry-currents report --format json
sorry-currents report --history --open

sorry-currents history

View test history and analytics from the terminal.

sorry-currents history --flaky           # Flakiest tests
sorry-currents history --slow --limit 10 # Slowest tests
sorry-currents history --failing         # Most failing tests
sorry-currents history --format json     # Machine-readable output

sorry-currents notify

Send run results to integrations, Non-fatal - integration errors exit 0.

sorry-currents notify --github-comment   # PR comment (requires GITHUB_TOKEN)
sorry-currents notify --github-status    # Commit status check
sorry-currents notify --slack <url>      # Slack webhook
sorry-currents notify --webhook <url>    # Generic HTTP POST
sorry-currents notify --datadog          # Datadog metrics (requires DD_API_KEY)

Exit Codes

| Code | Meaning | | ---- | -------------------------------- | | 0 | Success | | 1 | Test failures detected | | 2 | sorry-currents operational error |

CI Usage Example (GitHub Actions)

- name: Generate shard plan
  run: npx @sorry-currents/cli plan --target-duration 30 --max-shards 8 --risk-factor 1 --output-matrix

- name: Run tests
  run: npx @sorry-currents/cli run --shard-plan shard-plan.json --shard-index ${{ matrix.shardIndex }}

- name: Merge results
  run: npx @sorry-currents/cli merge

- name: Generate report
  run: npx @sorry-currents/cli report --format html