<h1 align="center"><img src="resources/images/sorify-icon.svg" width="192" align="center"/></h1>

<p align="center">
  Next generation AI First - Browser Testing <br>& browser automation platform <br><br>
  Fully AI controllable - Playwright Management Platform<br>
  Built for AI Agents - <b>Claude・Codex</b><br><br>
  Built for developers<br>
  Manage entire workspace through MCP<br><br>
  Create powerful <b>browser automations</b><br>
  With scheduler<br><br>
  Bi-directional webhooks integrations<br>
  Chrome Extension, with MCP (for Hybrid lovers)<br><br>
  24/7 Background Agents<br>
  <b>Page aware MCP</b><br>
</p>


<p align="center">
<a href="https://trendshift.io/repositories/156992?utm_source=trendshift-badge&amp;utm_medium=badge&amp;utm_campaign=badge-trendshift-156992" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/156992/daily?language=PHP" alt="rakutentech%2Fsorify | Trendshift" width="250" height="55"/></a>
</p>

<hr>

<p align="center">
  <b>Comprehensive test management</b><br>
  With Playwright runners on Ephemeral<br>
</p>

<p align="center">
  <img src="docs/static/dashboard-test-management.png" alt="Sorify screenshot" width="850"/>
</p>

<p align="center">
  <b>Control everything from local harness</b><br>
  Claude・Codex・OpenCode<br>
</p>

<p align="center">
  <img src="docs/static/local-harness-claude-codex.png" alt="Sorify screenshot" width="650"/>
</p>


<p align="center">
  <b>Pick up from where left off</b><br>
  AI agent on Dashboard itself<br>
  24/7 background AI Agents<br>
</p>

<p align="center">
  <img src="docs/static/dashboard-ai-agent.png" alt="Sorify screenshot" width="850" />
</p>

<p align="center">
  <b>Page Aware - with MCP sync</b><br>
  Same MCP tools that power local harness<br>
  also on UI
</p>

<p align="center">
  <img src="docs/static/page-aware-mcp.png" alt="Sorify screenshot" width="850" />
</p>
<p align="center">
  <b>Admin tools</b><br>
  User management, oAuth apps<br>
  Monitor, logs and others
</p>

<p align="center">
  <img src="docs/static/admin-tools.png" alt="Sorify screenshot" width="850" />
</p>

<p align="center">
  <b>Code coverage</b><br>
  For frontend assets<br>
</p>

<p align="center">
  <img src="docs/static/code-coverage.png" alt="Sorify screenshot" width="850" />
</p>

<p align="center">
  <b>User Skills</b><br>
  Create, reuse skills - all in one place<br>
  Share, browse, copy, attach<br>
  For both local or UI Agent<br>
</p>

<p align="center">
  <img src="docs/static/skills_create.png" alt="Sorify screenshot - create user skill" width="850" />
</p>


★ **Automate:** Automate browser testing, using claude, codex - with skills, mcp, test runners & dashboard.

★ **Chrome Extension:** Capture browser actions, send to AI to write tests, upload, self heal.

★ **Webhooks:** 3 types of bi-directional integrations. Trigger runs remotely, or trigger Github Actions or HTTP webhook pre/post a run from Sorify.

★ **Ephemeral:** Self host, scalable on ephemeral mode.

★ **Schedule:** In built scheduler to run automated browser tasks.

✴︎ **Test Management:** Organize test suites and test cases, run them on demand or on a schedule.

✴︎ **Playwright Code Coverage:** Code coverage support within dashboard.

✴︎ **Test Runners:** Playwright-powered execution with full run history.

✴︎ **Notifications:** Get notified when suites finish or fail.

✴︎ **Cookie Manager**: Sorify supports per-suite cookie injection from UI, MCP and chrome extension.

✴︎ **User Management:** Roles, permissions, and per-user IAM.

✴︎ **MCP Server:** Low token consumption over MCP layer, control all aspects of tests cases, code.

✴︎ **Agent Plugins:** Claude/Codex plugins included - zero-code test code management.

✴︎ **My AI Agent:** In-dashboard background capable, AI agent your own OpenAI-compatible.

✴︎ **MCP:** Page aware chats that can call every Sorify MCP tool, resumable handoffs to local agents.

✴︎ **Skills:** Create, share skills for agents within platform. Use over MCP or UI agent within.

✴︎ **i18n & 2 modes:** Supports Japanese, Chinese, Malay, with dark mode.

## Quick Start

```sh
docker-compose up
```

## Features

WITH ALL MCP CONTROLS - SUPPORTED


```
▼ Core Testing
・ AI test generation        ・ Playwright execution
・ Browser automation        ・ Cross-browser support
・ Headless mode             ・ Scheduled runs
・ Cron scheduling           ・ Per-test scheduling
・ Run history               ・ Run cancellation
・ Status polling            ・ Test logs
・ Pass-rate analytics       ・ Screenshot on failure
・ Code coverage reports     ・ LCOV coverage export
・ Bundle URL filter         ・ Run retention pruning

▼ Test Management
・ Suite management          ・ Test case management
・ Bulk test creation        ・ Bulk test deletion
・ Suite duplication         ・ Test duplication
・ Code version history      ・ Version restore
・ Test enable/disable       ・ Search and filters
・ Suite bookmarks           ・ Suite review page
・ Dashboard analytics

▼ Sessions and Data
・ Cookie injection          ・ Pre-authenticated sessions
・ Storage state upload      ・ Suite variables
・ Proxy routing             ・ Per-domain proxies
・ Timeout configuration     ・ History retention

▼ Access Control
・ User management           ・ Role-based permissions
・ Per-suite members         ・ Suite sharing

▼ Notifications
・ Teams notifications       ・ Email notifications
・ Inline screenshot emails  ・ Notification cooldown
・ Digest summaries

▼ Integrations
・ CI webhook trigger        ・ Bi-directional webhooks
・ Webhook concurrency guard ・ Webhook token regeneration
・ GitHub Actions dispatch   ・ HTTP request hooks
・ Pre-run hooks             ・ Post-run hooks
・ Multi GitHub App support  ・ GitHub/GHE OAuth login
・ MCP discovery endpoint

▼ AI and Agents
・ MCP server                ・ Low-token consumption
・ Claude plugins            ・ Codex plugins
・ My AI Agent web chat      ・ Agent chat handoff to MCP
・ Agent profiles            ・ Ask and Agent chat modes
・ User skills (markdown)    ・ Skills library + copy
・ Long running agents       ・ Live agent streaming
・ Agent turn cancellation   ・ Agent web tools
・ AI healing                ・ Failure investigation
・ Gateway live lookups

▼ Dashboard and UI
・ Activity feed             ・ Cmd+K command palette
・ Global search             ・ Screenshot gallery
・ Syntax highlighted editor ・ Admin dashboard note
・ i18n (JA, ZH, MS)         ・ Dark mode

▼ Recorder
・ Chrome extension          ・ Session recording
・ Recorded test generation  ・ Standalone recorder MCP

▼ Deployment
・ Self hosting              ・ Ephemeral mode
・ Docker deployment         ・ Admin panel
・ Ephemeral readiness check ・ Execution mode switcher
・ Runner image build        ・ Data retention pruning
```

## Feature Matrix

```
▼ Feature Matrix

                                                                            MCP  Dashboard   Webhook     API
                                                                        --------------------------------------
・ Suites: list/get/create/update/delete/duplicate                           ○      ○          —           ○
・ Suite schedule: update/delete                                             ○      ○          —           ○
・ Suite cookies: upload                                                     ○      ○          —           ○
・ Suite integrations: GitHub Action/HTTP request (pre/post run hooks)       ○      ○          —           ○
・ Suite bookmarks: list/toggle                                              ○      ○          —           ○
・ Suite members: list/add/update/remove                                     ○      ○          —           ○
・ Tests: list/get/create/update/update code/delete/duplicate                ○      ○          —           ○
・ Tests: bulk-create/bulk-delete                                            ○      ○          —           ○
・ Tests: toggle enabled/disabled                                            ○      ○          —           ○
・ Runs: trigger/list/get/cancel/delete                                      ○      ○          —           ○
・ Runs: status                                                              ○      ○          ○           ○
・ Runs: logs                                                                ○      ○          —           ○
・ Screenshots: list/get                                                     ○      ○          —           ○
・ Recorder: chrome extension events                                         ○      —          —           —
・ Suite webhook token: regenerate                                           —      ○          —           ○
・ Test code-version: restore                                                —      ○          —           ○
・ Login/register/logout/password reset                                      —      ○          —           ○
・ Profile: update name/password                                             —      ○          —           ○
・ Dashboard analytics (stats, recent runs)                                  —      ○          —           —
・ Admin: manage users (create, list, role, delete, reset password)          —      ○          —           ○
```

## AI Usage

### Claude Code

```sh
$ cat ~/.sorify
SORIFY_URL=http://localhost:8081/sorify
SORIFY_USERNAME=admin@sorify.local
SORIFY_PASSWORD=changeme
```

```sh
claude /plugin marketplace add https://github.com/rakutentech/sorify.git
```

Install `sorify` from that marketplace in Claude Code, then start a new
session. The existing `/sorify:gateway`, `/sorify:generate`, and
`/sorify:recording` commands remain available.

### Codex

```sh
codex plugin marketplace add https://github.com/rakutentech/sorify.git
codex plugin add sorify@sorify
```

**Codex:** Invoke the `$sorify:sorify-setup` skill once.

Use the Codex skills

```sh
$sorify:sorify-gateway
$sorify:sorify-generate
$sorify:sorify-recording
$sorify:sorify-update
```

```sh
codex mcp get sorify
```

<p align="center">
  <img src="./docs/static/sorify.svg" width="850" alt="Sorify workflow"/>
</p>

### SKILL 1 - Sorify MCP


```sh
/sorify:gateway Create a test suite called "Awesome App"
/sorify:gateway List latest failing tests

/sorify:gateway Create new test suite. Get requirements from JIRA/GHE/Excel. Write using /sorify:generate
/sorify:gateway Update the test suite http://localhost:8081/sorify/suites/{id} by adding retry twice
```

**AI Healing**

```sh
/sorify:gateway why my test is failing <name of test>
/sorify:gateway why my test is failing <or-link-to-test>
```

### SKILL 2 - In-Built QA Skills

```sh
# Tests from source code (git)
/sorify:generate Scan my code and generate tests for <github.com/your/repo>

# Tests from source code (path)
/sorify:generate Scan my code and generate tests for </path/to/your/source>, ref </path/to/your/docs>

# Tests from url (remote)
/sorify:generate Crawl site and generate tests for https://rakuten.co.jp
```

#### OR SKILL BYO - Bring your own QA Skills

```sh
/my:qa:skill Create detailed tests <...>
...then /sorify:gateway once done - upload, run and invetigate failed tests
```

## Chrome Recorder - Record, Capture, Generate, upload (Chrome extension)

This is a chrome extension that works in hybrid mode optionally. While browsing it records browser events, and stores into a file.
The sequence of events then can be picked up by AI to better write the test code, works well when more context about the project, such as source code is complemented.

Generate tests from a real recorded session instead of DOM exploration — chrome-mcp-playwright `sorify-recorder-mcp`


**♢  1.** Install the mcp

```sh
curl -fsSL https://raw.githubusercontent.com/rakutentech/sorify/master/mcp/install-mcp.sh | sh
```

**♢  2.** Load the **Chrome** extension


`chrome://extensions/` → enable **"Developer mode"** → "Load unpacked" → select `extension/` folder

*we don't have npx, sorry*

**♢  3.** Start the recorder

Sorify recorder should start automatically when you launch Claude Code or
Codex. In Claude Code, check `/mcp` for
`plugin:sorify:sorify-recorder`.

**If not**, then start the listener at:

```sh
~/.sorify-bin/sorify-recorder-mcp
```

**No 4.** Click the extension icon → Connect → Start recording

![Chrome extension recorder](docs/static/chrome-extension-recorder.png)

*Perform the clicks/inputs you want turned into a test, then Stop recording.*

**Tip:** to check the port `lsof -nP -iTCP:7420 -sTCP:LISTEN`

**No 5.** Generate tests

```sh
/sorify:recording latest
```

In Codex, use `$sorify:sorify-recording` and ask for the latest recording instead.

# Quick Start (from source)

## Development (local)

```sh
# Update: APP_KEY, DB_PASSWORD, MYSQL_ROOT_PASSWORD
cp .env.example .env

composer setup
php artisan dev
```

 ## Verify

```sh
http://localhost:8081/sorify
```

- **User:** admin@sorify.local
- **Password:** changeme

See [INSTALL.md](./INSTALL.md) for other details, self hosting, ephemeral mode, docker.

## Customizable Settings

<table align="center">
  <tr>
    <td align="center" width="50%">
      <b>Suite settings</b><br>
      <sub>Webhooks and integrations configured per suite</sub><br><br>
      <img src="./docs/static/suite_settings.png" alt="Suite settings" width="420"/>
    </td>
    <td align="center" width="50%">
      <b>Webhook settings</b><br>
      <sub>CI webhook for triggering Sorify runs</sub><br><br>
      <img src="./docs/static/webhook_settings.png" alt="Webhook settings" width="420"/>
    </td>
  </tr>
</table>

<p align="center">
  <b>Run settings</b><br>
  Webhook URL, token and run options
</p>

<p align="center">
  <img src="./docs/static/run_settings.png" alt="Run settings" width="850"/>
</p>

# Integrations

1. **Sorify Webhook:** Trigger Sorify run/runs from outside
2. **HTTP Webhook:** Trigger HTTP from sorify - pre/post run
3. **Github Action Webhook:** Trigger Github action from sorify - pre/post run. Details below:


<p align="center">
  <img src="./docs/static/sorify-webhooks.svg" width="850" alt="Sorify workflow"/>
</p>

<p align="center">
  <b>HTTP integration settings</b><br>
  Trigger HTTP from Sorify - pre/post run
</p>

<p align="center">
  <img src="./docs/static/http_integration_settings.png" alt="HTTP integration settings" width="850"/>
</p>

## GitHub, GHES, GHEC integrations

**Integration 1: Github Actions → Sorify**

Trigger Sorify runs from a workflow using the suite's **CI webhook** (token auth, no session).
Grab the webhook URL from the suite's settings page, store the token as a secret, then:

```yaml
on: [push]

jobs:
  e2e:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger Sorify run
        run: |
          curl -sf -X POST "$SORIFY_WEBHOOK_URL/trigger" \
            -H "Content-Type: application/json" \
            -d '{"test_ids": [12, 34]}'   # omit to run all active tests
        env:
          SORIFY_WEBHOOK_URL: ${{ secrets.SORIFY_WEBHOOK_URL }}

      - name: Poll run status
        run: |
          curl -sf "$SORIFY_WEBHOOK_URL/runs/{run}/status"
        env:
          SORIFY_WEBHOOK_URL: ${{ secrets.SORIFY_WEBHOOK_URL }}
```

**Integration 2: Sorify → Github Actions** (pre or post)

GitHub Apps are managed under **Admin → GitHub Apps** (dashboard).
Used for either **login** or triggering **actions** from Sorify.

To register an app, follow the walkthrough on the dashboard itself: **Admin → GitHub Apps → "How to
register"**.

A workflow dispatched by Sorify looks like this:

<p align="center">
  <img src="./docs/static/github_integration_settings.png" alt="GitHub integration settings" width="850"/>
</p>

```yaml
on:
  workflow_dispatch:
    inputs:
      # Injected by Sorify — do not edit
      sorify_run_id:
        type: string
      sorify_suite_id:
        type: string
      # and so on. Custom add from - sorify's suite/{id} > settings

jobs:
  sorify:
    name: Sorify
    steps:
      - name: Show Sorify context
        run: |
          echo "sorify_run_id=${{ github.event.inputs.sorify_run_id }}"
```

## HTTP API Reference

See [API.md](./API.md) for the complete endpoint list and sample curl requests.

## Owners

<table>
  <tr>
    <td align="center">
      <a href="https://github.com/MarikoKikugawa">
        <img src="https://github.com/MarikoKikugawa.png" width="80" height="80" alt="MarikoKikugawa"/><br />
        <sub><b>MarikoKikugawa</b></sub>
      </a>
    </td>
    <td align="center">
      <a href="https://github.com/asghar-ahmed">
        <img src="https://github.com/asghar-ahmed.png" width="80" height="80" alt="asghar-ahmed"/><br />
        <sub><b>asghar-ahmed</b></sub>
      </a>
    </td>
    <td align="center">
      <a href="https://github.com/HiromichiHagiwara">
        <img src="https://github.com/HiromichiHagiwara.png" width="80" height="80" alt="HiromichiHagiwara"/><br />
        <sub><b>HiromichiHagiwara</b></sub>
      </a>
    </td>
  </tr>
  <tr>
    <td align="center">
      <a href="https://github.com/kevincobain2000">
        <img src="https://github.com/kevincobain2000.png" width="80" height="80" alt="kevincobain2000"/><br />
        <sub><b>kevincobain2000</b></sub>
      </a>
    </td>
    <td align="center">
      <a href="https://github.com/pulkit-kathuria">
        <img src="https://github.com/pulkit-kathuria.png" width="80" height="80" alt="pulkit-kathuria"/><br />
        <sub><b>pulkit-kathuria</b></sub>
      </a>
    </td>
    <td align="center">
      <a href="https://github.com/chetra-tep">
        <img src="https://github.com/chetra-tep.png" width="80" height="80" alt="chetra-tep"/><br />
        <sub><b>chetra-tep</b></sub>
      </a>
    </td>
    <td align="center">
      <a href="https://github.com/chetratep">
        <img src="https://github.com/chetratep.png" width="80" height="80" alt="chetratep"/><br />
        <sub><b>chetratep</b></sub>
      </a>
    </td>
  </tr>
</table>

## Contribution

- Raise an issue or PR to `master`

## License

Licensed under the [Apache License, Version 2.0](LICENSE).

The Chrome extension in [`extension/`](extension/) is licensed separately
under the [BSD 3-Clause License](extension/LICENSE), which prohibits
publishing it (or a derivative) under the "Sorify Recorder" name without
permission. See [`extension/README.md`](extension/README.md) for details.

# CHANGE LOG

- **v1** - Intial Release
- **v1.1** - Batteries added on user management, mcp enhancement
- **v1.2** - Chrome Extension to record and write playwright tests
- **v1.3** - Skills updated, MS Teams notifications links to a screenshot, dashboard has admin editable msg
- **v1.4** - Manage users from MCP.
- **v1.5** - i18n support for English and Japanese for now.
- **v1.6** - i18n support for Malay, Simplified Chinese. Extension captures file uploads, iframes, tabs, network. oAuth login, with Avatar. Duplicate a suite.
- **v1.7** - Cookies support, variables support.
- **v1.8** - MCP supports runs. Auto redirect after login page. Support for one time CI webhook and who ran the CI.
- **v1.9** - Chrome extension memory leak fix. Support pre/post webhooks for multiple connectors.
- **v2.0** - Ephemeral mode
- **v2.1** - My AI Agent: in-dashboard agent chat (OpenAI-compatible profiles, page context, MCP handoff) and AI model attribution on test code.
- **v2.2** - Long running agents, admin controlled stale runs, mermaid support on md, AI explain these buttons. Sleaker UI.
- **v2.3** - Playwright coverage supported.
- **v2.4** - User Skills: share, copy, distribute, use in agents.