start_review
Start a UX review of a running app by scanning its source code, creating a report folder, and providing step-by-step instructions to find and fix usability issues.
Instructions
Start a Phyll review of an app that is already running. Call it first, once, when the person asks to review, audit or improve the UX of an app. It scans the project's source, creates the report folder and returns the method to follow step by step. It needs a Phyll account on this computer (npx phyll login or npx phyll signup) and uses one of the account's reviews.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Address where the app runs and answers, such as http://localhost:3000. Start the app first if it is not running. | |
| jobs | No | The two or three things the end user comes to do, as the person named them, such as Book a haircut. Leave it out when the person did not say. | |
| name | No | Name of the product, for the report's project on agentphyll.com. When left out, it comes from .phyll/config.json, then from the folder's name. | |
| user | No | Who uses the app, in the person's words, such as barbershop customers booking on a phone. Leave it out when the person did not say. | |
| language | No | Language of the report as a code, such as en or pt-BR. Use the language the person writes in. When left out, it comes from the project's .phyll/config.json, then from this computer's language. | |
| project_dir | No | Path to the project folder, when it is not the folder the agent runs in. A relative path starts from that folder. |