phyll 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +44 -0
- package/bin/phyll.mjs +6 -0
- package/package.json +42 -0
- package/skill/data/tells.json +1641 -0
- package/skill/schema/config.schema.json +51 -0
- package/skill/schema/tells.schema.json +156 -0
- package/skill/scripts/capture.mjs +224 -0
- package/skill/scripts/lib/cli.mjs +16 -0
- package/skill/scripts/lib/config.mjs +19 -0
- package/skill/scripts/lib/detectors.mjs +301 -0
- package/skill/scripts/lib/files.mjs +134 -0
- package/skill/scripts/lib/score.mjs +51 -0
- package/skill/scripts/lib/structure.mjs +287 -0
- package/skill/scripts/lib/version.mjs +3 -0
- package/skill/scripts/probe.js +384 -0
- package/skill/scripts/scan.mjs +175 -0
- package/src/browser.mjs +317 -0
- package/src/cli.mjs +165 -0
- package/src/credentials.mjs +40 -0
- package/src/engine.mjs +40 -0
- package/src/mcp.mjs +145 -0
- package/src/paths.mjs +19 -0
- package/src/review.mjs +226 -0
- package/src/setup.mjs +69 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 carlosphyll
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# phyll
|
|
2
|
+
|
|
3
|
+
UX review for apps built with AI, inside the agent you already use.
|
|
4
|
+
|
|
5
|
+
Phyll plugs into Codex, Claude Code or any agent that speaks MCP. Your agent opens your app the way a first-time user would, walks the core jobs in a real browser, and writes a report of what gets in the way: forms that ask for more than the job needs, sign-up walls, dead buttons, text too faint to read. The fixes keep your design.
|
|
6
|
+
|
|
7
|
+
The AI work runs in your agent, on your own plan. This package adds the browser, the page probe, the source scanner and the link to Phyll's engine, which sends the review method, checks the report and keeps it with a link.
|
|
8
|
+
|
|
9
|
+
## Start
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx phyll signup you@example.com
|
|
13
|
+
npx phyll setup codex # or: npx phyll setup claude
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Then ask your agent: "review my app at http://localhost:3000".
|
|
17
|
+
|
|
18
|
+
`setup` registers the connector in Codex's `config.toml` or with `claude mcp add`, and installs the Chromium build it uses. You need Node 20 or newer.
|
|
19
|
+
|
|
20
|
+
## Commands
|
|
21
|
+
|
|
22
|
+
| Command | What it does |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| `signup <email>` | Create a free account, with 5 full reviews. The key is saved in `~/.phyll` |
|
|
25
|
+
| `login <key>` | Use an account you already have on this computer |
|
|
26
|
+
| `setup codex` or `setup claude` | Connect Phyll to your agent and install the browser |
|
|
27
|
+
| `status` | Your plan and the reviews left |
|
|
28
|
+
| `pro` | Subscribe to Phyll Pro, R$ 9 a month, with unlimited reviews |
|
|
29
|
+
| `billing` | Change the card or cancel Phyll Pro |
|
|
30
|
+
| `scan [folder]` | Scan the source for AI tells, with no account and no AI |
|
|
31
|
+
| `mcp` | Run the connector for your agent; `setup` registers it for you |
|
|
32
|
+
| `logout` | Forget the key on this computer |
|
|
33
|
+
|
|
34
|
+
## The tools your agent gets
|
|
35
|
+
|
|
36
|
+
`start_review` scans the project, creates the report folder and returns the method. `capture` saves a screenshot and the page probe of each route at laptop and phone size. `open`, `snapshot`, `click`, `fill`, `select`, `check`, `press`, `back`, `screenshot`, `probe` and `resize` drive the browser, which stays on your app. `guide` returns a part of the method, `finish_review` sends the report to the engine and writes `report.md`, and `scan`, `account` and `upgrade` do what their names say.
|
|
37
|
+
|
|
38
|
+
## What leaves your computer
|
|
39
|
+
|
|
40
|
+
Your source code, your screenshots and your agent's conversation stay on your computer. When a review starts, the connector sends the app's address, the project name and a summary of the scan: which tells it found, how many times, and the paths of routes and forms. When it ends, it sends the report your agent wrote, which the engine keeps so the link works.
|
|
41
|
+
|
|
42
|
+
## More
|
|
43
|
+
|
|
44
|
+
The scanner, the plugin and four example apps are in the [repository](https://github.com/carlosphyll/phyll). MIT license.
|
package/bin/phyll.mjs
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "phyll",
|
|
3
|
+
"version": "0.4.1",
|
|
4
|
+
"description": "UX review for apps built with AI, inside the agent you already use. Connects Codex or Claude Code to the Phyll engine; the AI work stays on your own plan.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"homepage": "https://github.com/carlosphyll/phyll",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/carlosphyll/phyll.git",
|
|
11
|
+
"directory": "packages/connector"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"ux",
|
|
15
|
+
"ux-review",
|
|
16
|
+
"mcp",
|
|
17
|
+
"codex",
|
|
18
|
+
"claude-code",
|
|
19
|
+
"ai",
|
|
20
|
+
"vibe-coding"
|
|
21
|
+
],
|
|
22
|
+
"bin": {
|
|
23
|
+
"phyll": "bin/phyll.mjs"
|
|
24
|
+
},
|
|
25
|
+
"files": [
|
|
26
|
+
"bin",
|
|
27
|
+
"src",
|
|
28
|
+
"skill",
|
|
29
|
+
"README.md"
|
|
30
|
+
],
|
|
31
|
+
"engines": {
|
|
32
|
+
"node": ">=20"
|
|
33
|
+
},
|
|
34
|
+
"scripts": {
|
|
35
|
+
"prepack": "node scripts/copy-scanner.mjs"
|
|
36
|
+
},
|
|
37
|
+
"dependencies": {
|
|
38
|
+
"@modelcontextprotocol/sdk": "^1.30.1",
|
|
39
|
+
"playwright": "^1.63.0",
|
|
40
|
+
"zod": "^4.6.5"
|
|
41
|
+
}
|
|
42
|
+
}
|