{"id":27551838,"url":"https://github.com/przeprogramowani/10x-test-planner","last_synced_at":"2025-04-19T09:44:34.276Z","repository":{"id":288052270,"uuid":"966673252","full_name":"przeprogramowani/10x-test-planner","owner":"przeprogramowani","description":"A Node-based CLI tool to generate test plans from video recordings using Google's Gemini models.","archived":false,"fork":false,"pushed_at":"2025-04-15T09:37:50.000Z","size":8438,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-15T10:37:34.774Z","etag":null,"topics":["e2e","gemini","genai","playwright","tests","video-to-code","vlm"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@10xdevspl/test-planner","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/przeprogramowani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-15T09:27:50.000Z","updated_at":"2025-04-15T09:37:53.000Z","dependencies_parsed_at":"2025-04-15T10:49:06.643Z","dependency_job_id":null,"html_url":"https://github.com/przeprogramowani/10x-test-planner","commit_stats":null,"previous_names":["przeprogramowani/10x-test-planner"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/przeprogramowani%2F10x-test-planner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/przeprogramowani%2F10x-test-planner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/przeprogramowani%2F10x-test-planner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/przeprogramowani%2F10x-test-planner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/przeprogramowani","download_url":"https://codeload.github.com/przeprogramowani/10x-test-planner/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249326171,"owners_count":21251735,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["e2e","gemini","genai","playwright","tests","video-to-code","vlm"],"created_at":"2025-04-19T09:44:33.839Z","updated_at":"2025-04-19T09:44:34.269Z","avatar_url":"https://github.com/przeprogramowani.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Test Planner by 10xDevs\n\n```bash\n _____         _     ____  _\n|_   _|__  ___| |_  |  _ \\| | __ _ _ __  _ __   ___ _ __\n  | |/ _ \\/ __| __| | |_) | |/ _` | '_ \\| '_ \\ / _ \\ '__|\n  | |  __/\\__ \\ |_  |  __/| | (_| | | | | | | |  __/ |\n  |_|\\___||___/\\__| |_|   |_|\\__,_|_| |_|_| |_|\\___|_|\n```\n\nA Node-based CLI tool to generate test plans from video recordings using Google's Gemini models.\n\nCreated test plan can be used as an input for Agentic AI model such Claude 3.7 Sonnet - it contains scenarios, steps and expected selectors to cover your project with E2E tests.\n\nAll the [constraints](https://ai.google.dev/gemini-api/docs/vision?lang=node#prompting-video) of Google Generative AI models must be followed.\n\n## Installation\n\n```bash\nnpm install -g @10xdevspl/test-planner\n```\n\n## Usage\n\n### Using npx\n\n```bash\nnpx @10xdevspl/test-planner --video=user-session.mov --outDir=./my-tests\n```\n\n### Authentication\n\nInclude the following environment variable in your `.env` file or pass it as an argument:\n\n```\nGOOGLE_API_KEY=your_api_key_here\n```\n\nGenerate it here - [Google AI Studio](https://aistudio.google.com/apikey)\n\n### Options\n\n- `--video \u003cpath\u003e` (required): Path to the video file to analyze\n- `--outDir \u003cpath\u003e`: Output directory for the test plan (default: `./e2e`)\n- `--model \u003cname\u003e`: Gemini model to use (default: `gemini-2.0-flash`)\n- `--optimize`: Optimize video using ffmpeg before processing (default: `false`)\n- `--fps \u003cnumber\u003e`: Frames per second for optimized video (default: `15`, requires `--optimize`)\n\n### Requirements\n\n- Node.js 22 or higher\n- (Optional) If using the `--optimize` flag, ffmpeg must be installed on your system\n\n## Test Plan Structure\n\nThe library generates a test plan, followed by Playwright bootstrap and rules for AI.\n\n- `test-plan.md` - the main test plan file\n- `project-checklist.md` - initial configuration of Playwright projects\n- `agent-rules.md` - rules for AI to follow\n\nExample scenario based on the video:\n\n```xml\n\u003cTEST_SCENARIO_1\u003e\n  ## Objective: Authenticate User\n  ## Test Group: Authentication\n  ## Dependencies / Preconditions:\n    - User account \"10xadmin\" must exist.\n    - User must be logged out.\n  ## Setup Steps (if needed beyond starting page):\n    - None required beyond navigating to the initial page.\n  ## Test Suite: authentication.auth.spec.ts\n  ## User Workflow Steps:\n    1. Navigate to the login page (localhost:3000/login).\n    2. Enter valid username \"10xadmin\" into the username field.\n    3. Enter valid password \u003cHIDDEN\u003e into the password field.\n    4. Click the 'Login' button.\n  ## Expected Outcomes / Assertions:\n    - User is redirected to the main dashboard (localhost:3000/home).\n  ## Dynamic Data Considerations:\n    - None.\n  ## Potential Challenges:\n    - None.\n\u003c/TEST_SCENARIO_1\u003e\n```\n\nFor the best results, always attach `agent-rules.md` to prompts that you use to create final test suites.\n\n### Recommended models for test suite generation\n\n- `gemini-2.5-pro`\n- `claude-3-7-sonnet`\n\n## License\n\nISC\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprzeprogramowani%2F10x-test-planner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprzeprogramowani%2F10x-test-planner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprzeprogramowani%2F10x-test-planner/lists"}