{"id":50791162,"url":"https://github.com/studentutu/autoflow","last_synced_at":"2026-06-12T11:01:48.649Z","repository":{"id":246752110,"uuid":"822070829","full_name":"studentutu/autoflow","owner":"studentutu","description":"Fully generic  OS macro with autoclicks, keyboard and typings. Uses OpenCV for template matching. ","archived":false,"fork":false,"pushed_at":"2024-07-03T01:03:04.000Z","size":738,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-07-05T05:00:27.736Z","etag":null,"topics":["autoclick","autohotkey","automation","autotyping","bot","desktop","electron","image-detection","javascript","macro","matching","opencv","pipeline","replay","screenshot","template","typescript","workflow"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/studentutu.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2024-06-30T08:22:42.000Z","updated_at":"2024-07-03T01:03:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"92d4182a-0dfe-47a8-9071-bef66cb66c7b","html_url":"https://github.com/studentutu/autoflow","commit_stats":null,"previous_names":["studentutu/autoflow"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/studentutu/autoflow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/studentutu%2Fautoflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/studentutu%2Fautoflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/studentutu%2Fautoflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/studentutu%2Fautoflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/studentutu","download_url":"https://codeload.github.com/studentutu/autoflow/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/studentutu%2Fautoflow/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34240817,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-12T02:00:06.859Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["autoclick","autohotkey","automation","autotyping","bot","desktop","electron","image-detection","javascript","macro","matching","opencv","pipeline","replay","screenshot","template","typescript","workflow"],"created_at":"2026-06-12T11:01:47.193Z","updated_at":"2026-06-12T11:01:48.638Z","avatar_url":"https://github.com/studentutu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Autoworkflow\n\nAuthohotkey alternative for those who like simplicity of js.\nAutomatic os-wide pipeline for your needs with image detection and input simulation based on your custom json steps and state with support for a fully evaluated expressions and conditions.\nAutomate UI as never before.\n\nPowered by electron, robotjs an opencv.\n\n## Contents\n\n- [Installation](#installation)\n- [Workflow overview](#workflow-overview)\n- [Actions](#actions)\n  - [Wait Action, seconds as double/float/integer](#wait-action-seconds-as-doublefloatinteger)\n  - [Finish Action, which stops execution and finishes workflow](#finish-action-which-stops-execution-and-finishes-workflow)\n  - [Input Action](#input-action)\n  - [Detect image action](#detect-image-action)\n  - [Condition check action, check condition on value in custom state](#condition-check-action-check-condition-on-value-in-custom-state)\n  - [GoTo, go to step with specified id](#goto-go-to-step-with-specified-id)\n  - [Modify value in custom state](#modify-value-in-custom-state)\n- [Building](#building)\n  - [Pre-requisites](#pre-requisites)\n  - [Run](#run)\n  - [Package](#package)\n- [TODO](#todo)\n- [Contributions](#contributions)\n\n## Installation\n\nDownload build for your platform from release page.\n\n## Workflow overview\n\nCreate your_custom_workflow.json based on the following examples [testPipeline](./examples/test.json).\nWorkflow consists of list of Steps and custom State.\nStep is an action. See list of supported [actions](#actions)\nState consists of any user defined properties.\nNote: some of the properties are required by the actions.\n\nYour workflow will look something like this:\n\n```json\n{\n    \"Steps\": [\n        {\n            \"Id\": 0,\n            \"Action\": \"wait\",\n            \"Wait\": {\n                \"Seconds\": 1.0\n            }\n        },\n        {\n            \"Id\": 1,\n            \"Action\": \"finish\"\n        }\n    ],\n     \"State\": {\n        \"comment\": \"This is custom state variables, all types are supported.\",\n        \"CurrentMoveVector\": 0,\n        \"MaxMoveRadius\": 30\n    }\n}\n```\n\n## Actions\n\n### Wait Action, seconds as double/float/integer\n\n ```json\n    {\n        \"Id\": number,\n        \"Action\": \"wait\",\n        \"Wait\": {\n            \"Seconds\": 1.0\n        }\n    }\n```\n\n### Finish Action, which stops execution and finishes workflow\n\n ```json\n    {\n        \"Id\": number,\n        \"Action\": \"finish\",\n    }\n```\n\n### Input Action\n\n```json\n   {\n        \"Id\": number,\n        \"Action\": \"input\",\n        \"Input\": {\n            // Optional. Use in conjuction with Detect in order to click onto detected image.\n            \"UseMouseStateProperty\": string,\n\n            // If UseStateProperty is present, will use that value here\n            \"position\": {\n                \"x\": 500,\n                \"y\": 500\n            },\n            \"clicks\": 1,\n\n            \"hold\": 0.5, // Optional, if set, will simulate key/mouse down hold.\n\n            // Optional, defaults to 'left' click.\n            \"button\": 'right' or 'left', \n\n            // Optional for key presses, defaults to 'keyDown'\n            \"type\": 'keyDown' or 'keyUp',\n\n            // Optional for key presses\n            \"key\": 'a' or 'enter'\n        }\n    }\n```\n\n### Detect image action\n\n```json\n   {\n        \"Id\": number,\n        \"Action\": \"detect\",\n        \"Detect\":\n        {\n            // Full path to image, should not contain any spaces. Example: c:\\Users\\userName\\Downloads\\images\\cat.png\n            \"ImagePath\": string, \n\n            // Optional, defaults to 'true'\n            \"UseCenter\": boolean,\n\n            // Optional\n            \"AddOffset\": Vector2, \n\n            // Should be unique for each image detection. Prefer to use image name.\n            \"BooleanStateProperty\": string,\n            \"PositionAtStateProperty\": string\n        }\n    }\n```\n\n### Condition check action, check condition on value in custom state\n\n```json\n   {\n        \"Id\": number,\n        \"Action\": \"check\",\n        \"Check\": \n        {\n            // Custom property name inside your state\n            \"StateProperty\": string, \n\n            // Any valid boolean condition evaluated here, var will be replaced by the current StateProperty value\n            // \"var \u003e 0\" or \"var \u003c 9\" or \"var == true\" or \"!var == true\" etc.\n            \"Condition\": string, \n\n            // Required.\n            \"IdWhenTrue\" : number,\n            // Required.\n            \"IdWhenFalse\" : number\n        }\n    }\n```\n\n### GoTo, go to step with specified id\n\n```json\n   {\n        \"Id\": number,\n        \"Action\": \"goTo\",\n        \"GoTo\" : {\n            \"Id\": number\n        }\n    }\n```\n\n### Modify value in custom state\n\n```json\n   {\n        \"Id\": number,\n        \"Action\": \"modify\",\n        \"Modify\":\n        {\n            // Custom property name inside your state\n            \"StateProperty\" : string,\n            \n            // Required.\n            // Any valid expression here, var will be replaced by the current StateProperty value\n            // \"var + 1\" or \"var--\" or \"42\" or \"true\" or \"false\" or \"{ \"anotherJson\" : 42 }\" etc.\n            \"NewValue\": string\n        }\n    }\n```\n\n## Building\n\n### Pre-requisites\n\n- nvm\n- node 20x\n- yarn\n\nDo a single restore of dependencies:\n\n```bash\n    yarn install \n```\n\n### Run\n\nRun:\n\n``` bash\nyarn start\n```\n\n### Package\n\nRun with command for each platform:\nnpm run make\n\n## TODO\n\n- [x] String state property support\n- [x] Add Input hold into input action\n- [x] Image template detection\n- [ ] Packages for (linux /macos /windows)\n- [ ] Visualization graph tool\n- [ ] Workflow Graph design tool\n- [ ] Graph design export into .json\n- [ ] Fetch action integration\n- [x] Use more reliable and feature rich key/mouse input simulation nut-js\n- [x] Use better opencv package ( so that there is no additional build or setup needed). Used \u003chttps://www.npmjs.com/package/@u4/opencv4nodejs\u003e with a lot of troubleshooting and fixes to make it work.\n- [ ] Multi screen support\n\n## Contributions\n\nHelp to grow this project with your contributions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstudentutu%2Fautoflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstudentutu%2Fautoflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstudentutu%2Fautoflow/lists"}