{"id":28428712,"url":"https://github.com/iocrafts/puppetchef","last_synced_at":"2026-03-09T19:47:29.560Z","repository":{"id":286201121,"uuid":"948170417","full_name":"iocrafts/puppetchef","owner":"iocrafts","description":"A tool that uses Puppeteer to execute web automation recipes defined in YAML format.","archived":false,"fork":false,"pushed_at":"2026-02-23T17:23:57.000Z","size":1963,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-24T00:50:37.624Z","etag":null,"topics":["automation","puppeteer","web","yaml"],"latest_commit_sha":null,"homepage":"https://www.iocrafts.com/projects/puppetchef/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iocrafts.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-13T21:41:10.000Z","updated_at":"2026-02-23T17:24:10.000Z","dependencies_parsed_at":"2025-05-12T20:34:42.229Z","dependency_job_id":"56af3825-ed3a-4007-8cb6-a2811c4605db","html_url":"https://github.com/iocrafts/puppetchef","commit_stats":null,"previous_names":["mdusi/puppetchef"],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/iocrafts/puppetchef","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iocrafts%2Fpuppetchef","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iocrafts%2Fpuppetchef/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iocrafts%2Fpuppetchef/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iocrafts%2Fpuppetchef/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iocrafts","download_url":"https://codeload.github.com/iocrafts/puppetchef/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iocrafts%2Fpuppetchef/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30309921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T17:35:44.120Z","status":"ssl_error","status_checked_at":"2026-03-09T17:35:43.707Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["automation","puppeteer","web","yaml"],"created_at":"2025-06-05T13:00:16.994Z","updated_at":"2026-03-09T19:47:29.552Z","avatar_url":"https://github.com/iocrafts.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Puppetchef\n\nA web automation tool that uses Puppeteer to execute web automation recipes defined in YAML format.\n\n## Features\n\n- **YAML-based Recipe Definition**: Write your web automation tasks in a simple, readable YAML format (syntax inspired by Ansible). Built-in support for ENV variables and JSON objects.\n- **Schema Validation**: Built-in validation for recipe structure and operations.\n- **Plugin System**: Extend functionality with custom plugins.\n- **Configuration Management**: Flexible configuration through JSON files.\n- **Verbose Logging**: Detailed execution logs for debugging.\n- **Syntax Check Mode**: Validate recipes without executing them.\n- **Common Plugins and Commands**: Built-in plugins and commands for easier automation.\n\n## Installation\n\n```bash\nnpm install puppetchef\n```\n\n## Usage\n\n```bash\npuppetchef \u003crecipe\u003e [options]\n```\n\n### Command Line Options\n\n- `\u003crecipe\u003e`: Recipe file in YAML format (required).\n- `-c, --conf \u003cfile\u003e`: Configuration file (default: `puppetchefrc`).\n- `--syntax-check`: Validate recipe only, without executing (default: `false`).\n\n### Environment Variables\n\n- `PUPPETCHEF_LOGLEVEL`: Enables debugging at the specified level (info, debug, error, warn, verbose).\n- `PUPPETCHEF_LOGFILE`: Path to the log file (default: stdout) when a debug level is set.\n\n### Examples\n\n```bash\n# Basic usage with a recipe file\npuppetchef recipe.yaml\n\n# With configuration file\npuppetchef recipe.yaml -c config.json\n\n# Validate recipe without executing\npuppetchef recipe.yaml --syntax-check\n```\n\n### Configuration File (puppetchefrc)\n\nCreate a JSON configuration file to customize browser behavior:\n\n```json\n{\n    \"executablePath\": \"/usr/local/bin/chromium\",\n    \"headless\": false,\n    \"defaultViewport\": {\n        \"width\": 1920,\n        \"height\": 1080\n    },\n    \"downloadBehavior\": {\n        \"policy\": \"allow\",\n        \"downloadPath\": \"/tmp\"\n    }\n}\n```\n\n### Recipe Format\n\nTemplate engine is based on Handlebarjs and support `env` and `json` as helper functions.\n\n```yaml\nurl: \"https://example.com\"\nname: \"Login Test\"\ntasks:\n  - name: \"Login\"\n    steps:\n      - puppetchef.builtin.common:\n          command: \"fill_out\"\n          selector: \"#username\"\n          data: \"testuser\"\n      - puppetchef.builtin.common:\n          command: \"fill_out\"\n          selector: \"#password\"\n          data: \"{{{ env 'PASS' }}}\"\n      - puppetchef.builtin.common:\n          command: \"click\"\n          selector: \"#submit\"\n```\n\n### Plugins\n\nCreate a *plugins* module with custom plugins to extend functionality:\n\n```javascript\n// plugin.js\nmodule.exports = {\n  customAction: async (page, data = {}) =\u003e {\n    // Custom automation logic\n    await page.locator(data.selector);\n\n    // If you need to return values for later use\n    return { x: 20, y: \"msg\" };\n  }\n};\n```\n\nInstall the *plugins* module:\n\n```bash\nnpm install plugins\n```\n\nAnd use it in your recipe:\n\n```yaml\nname: Example Recipe\nurl: https://example.com/demo-url\ntasks:\n  - name: \"Custom Action\"\n    steps:\n      - puppetchef.plugins.plugin:\n          command: \"customAction\"\n          selector: \"#username\"\n        # Make the return value of customAction available to the following steps\n        register: ret\n      - puppetchef.builtin.common:\n          command: debug\n          format: \"Debugging: {{ ret.y }}\"\n        # Conditionals for when to execute this step\n        when: \"{{ ret.x }} \u003e 0\"\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiocrafts%2Fpuppetchef","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiocrafts%2Fpuppetchef","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiocrafts%2Fpuppetchef/lists"}