{"id":15654484,"url":"https://github.com/mylxsw/coyotes","last_synced_at":"2025-09-03T05:38:27.058Z","repository":{"id":69884709,"uuid":"70825869","full_name":"mylxsw/coyotes","owner":"mylxsw","description":"非常简单的异步命令执行队列","archived":false,"fork":false,"pushed_at":"2018-10-21T09:04:23.000Z","size":5460,"stargazers_count":27,"open_issues_count":0,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-05-01T09:45:44.402Z","etag":null,"topics":["go","php","queue","redis","task"],"latest_commit_sha":null,"homepage":"https://aicode.cc/taskrunner","language":"Go","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/mylxsw.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}},"created_at":"2016-10-13T16:26:03.000Z","updated_at":"2024-12-31T07:00:47.000Z","dependencies_parsed_at":"2023-02-27T08:31:25.840Z","dependency_job_id":null,"html_url":"https://github.com/mylxsw/coyotes","commit_stats":null,"previous_names":["mylxsw/task-runner"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/mylxsw/coyotes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mylxsw%2Fcoyotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mylxsw%2Fcoyotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mylxsw%2Fcoyotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mylxsw%2Fcoyotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mylxsw","download_url":"https://codeload.github.com/mylxsw/coyotes/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mylxsw%2Fcoyotes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273397850,"owners_count":25098233,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"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":["go","php","queue","redis","task"],"created_at":"2024-10-03T12:51:59.688Z","updated_at":"2025-09-03T05:38:27.016Z","avatar_url":"https://github.com/mylxsw.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Coyotes\n\n不同于其它重量级任务队列，Coyotes仅仅提供了对命令行程序执行的支持，这样就避免了开发者需要学习任务队列相关API，针对任务队列开发任务程序的需要。只需要提供一个可执行的文件或者脚本执行命令，Coyotes就可以并发的执行。\n\n![](./demo.gif)\n\n## 命令参数\n\n- **channel-default** string\n\n    默认channel名称，用于消息队列 (default \"default\")\n\n- **colorful-tty**\n\n    是否启用彩色模式的控制台输出\n\n- **concurrent** int\n\n    并发执行线程数 (default 5)\n\n- **host** string\n\n    redis连接地址，必须指定端口(depressed,使用redis-host) (default \"127.0.0.1:6379\")\n\n- **http-addr** string\n\n    HTTP监控服务监听地址+端口 (default \"127.0.0.1:60001\")\n\n- **password** string\n\n    redis连接密码(depressed,使用redis-password)\n\n- **pidfile** string\n\n    pid文件路径 (default \"/tmp/coyotes.pid\")\n\n- **redis-db** int\n\n    redis默认数据库0-15\n\n- **redis-host** string\n\n    redis连接地址，必须指定端口 (default \"127.0.0.1:6379\")\n\n- **redis-password** string\n\n    redis连接密码\n\n- **task-mode**\n\n    是否启用任务模式，默认启用，关闭则不会执行消费 (default true)\n\n## 安装部署\n\n编译安装需要安装 **Go1.7+**，执行以下命令编译\n\n    make build-mac\n\n上述命令编译后是当前平台的可执行文件（**./bin/coyotes**）。比如在Mac系统下完成编译后只能在Mac系统下使用，Linux系统下编译则可以在Linux系统下使用。\n如果要在Mac系统下编译Linux系统下使用的可执行文件，需要本地先配置好交叉编译选线，之后执行下面的命令完成Linux版本编译\n\n    make build-linux\n\n将生成的执行文件（在**bin**目录）复制到系统的`/usr/local/bin`目录即可。\n\n    mv ./bin/coyotes /usr/local/bin/coyotes\n\n项目目录下提供了`supervisor.conf`配置文件可以直接在supervisor下使用，使用supervisor管理Coyotes进程。Coyotes在启动之前需要确保Redis服务是可用的。\n\n    /usr/local/bin/coyotes -redis-host 127.0.0.1:6379 -password REDIS访问密码 \n\n如果需要退出进程，需要向进程发送`USR2`信号，以实现平滑退出。\n\n    kill -USR2 $(pgrep coyotes)\n\n\u003e 请不要直接使用`kill -9`终止进程，使用它会强制关闭进程，可能会导致正在执行中的命令被终止，造成任务队列数据不完整。\n\n## 任务推送方式\n\n将待执行的任务推送给Coyotes执行有两种方式\n\n- 直接将任务写入到Redis的队列`task:prepare:queue`\n- 使用HTTP API\n\n### 直接写入Redis队列\n\n将任务以json编码的形式写入到Redis的`task:prepare:queue`即可。\n\n    $redis-\u003elpush('task:prepare:queue', json_encode([\n      'task' =\u003e $taskName,\n      'chan' =\u003e $channel,\n      'ts'   =\u003e time(),\n    ], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE))\n\n写入到`task:prepare:queue`之后，Coyotes会实时的去从中取出任务分发到相应的channel队列供worker消费。\n\n### 使用HTTP API\n\nRequest:\n\n    POST /channels/default HTTP/1.1\n    Accept: */*\n    Host: localhost:60001\n    content-type: multipart/form-data; boundary=--------------------------019175029883341751119913\n    content-length: 179\n    \n    ----------------------------019175029883341751119913\n    Content-Disposition: form-data; name=\"task\"\n    \n    ping -c 40 baidu.com\n    ----------------------------019175029883341751119913--\n\n    \nResponse:\n    \n    HTTP/1.1 200 OK\n    Content-Type: application/json; charset=utf-8\n    Date: Mon, 10 Apr 2017 13:05:56 GMT\n    Content-Length: 92\n    \n    {\"status_code\":200,\"message\":\"ok\",\"data\":{\"task_name\":\"ping -c 40 baidu.com\",\"result\":true}}\n\n\n## HTTP API\n\nCoyotes提供了Restful风格的API用于对其进行管理。\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21728c33bdd4b4b703d0)\n\n### **GET /channels** 查询所有channel的状态\n\n#### 请求参数\n\n无\n\n#### 响应结果示例\n\n    {\n      \"status_code\": 200,\n      \"message\": \"ok\",\n      \"data\": {\n        \"biz\": {\n          \"tasks\": [],\n          \"count\": 0\n        },\n        \"cron\": {\n          \"tasks\": [],\n          \"count\": 0\n        },\n        \"default\": {\n          \"tasks\": [\n            {\n              \"task_name\": \"ping -c 40 baidu.com\",\n              \"channel\": \"default\",\n              \"status\": \"running\"\n            }\n          ],\n          \"count\": 1\n        },\n        \"test\": {\n          \"tasks\": [],\n          \"count\": 0\n        }\n      }\n    }\n\n任务状态字段`status`对应关系\n\n\n| status | 说明 |\n| --- | --- |\n| expired | 已过期（应该不会出现，待确认）  |\n| queued | 已队列，任务正在等待执行 |\n| running | 任务执行中 |\n\n\n### **GET /channels/{channel_name}** 查新某个channel的状态\n\n#### 请求参数\n\n无\n\n#### 响应结果示例\n\n    {\n      \"status_code\": 200,\n      \"message\": \"ok\",\n      \"data\": {\n        \"tasks\": [],\n        \"count\": 0\n      }\n    }\n\n### **POST /channels/{channel_name}/tasks** 推送任务到任务队列\n\n#### 请求参数\n\n| 参数 | 说明 |\n| --- | --- |\n| task | 任务名称，不指定command参数时，作为要执行的命令，指定command参数时则仅仅作为任务名称展示使用 |\n| command | 要执行的命令，推荐使用该方式，如果不指定，则使用task参数作为要执行的命令 |\n| args | 命令参数，仅在指定command参数时有效，可以指定多个，依次作为命令参数 |\n| delay | 延迟执行，单位为秒，默认为0 |\n\n#### 请求示例\n\n    POST /channels/default/tasks HTTP/1.1\n    cache-control: no-cache\n    Postman-Token: c084444b-6657-4d30-8128-7ad5d898b69b\n    Content-Type: multipart/form-data; boundary=--------------------------488585830099792470732554\n    User-Agent: PostmanRuntime/3.0.11-hotfix.2\n    Accept: */*\n    Host: localhost:60001\n    accept-encoding: gzip, deflate\n    content-length: 700\n    Connection: keep-alive\n\n    ----------------------------488585830099792470732554\n    Content-Disposition: form-data; name=\"task\"\n\n    pwd\n    ----------------------------488585830099792470732554\n    Content-Disposition: form-data; name=\"command\"\n\n    ping\n    ----------------------------488585830099792470732554\n    Content-Disposition: form-data; name=\"args\"\n\n    -c\n    ----------------------------488585830099792470732554\n    Content-Disposition: form-data; name=\"args\"\n\n    10\n    ----------------------------488585830099792470732554\n    Content-Disposition: form-data; name=\"args\"\n\n    baidu.com\n    ----------------------------488585830099792470732554\n    Content-Disposition: form-data; name=\"delay\"\n\n    10\n    ----------------------------488585830099792470732554--\n    HTTP/1.1 200 OK\n    Content-Type: application/json; charset=utf-8\n    Date: Tue, 16 May 2017 13:11:31 GMT\n    Content-Length: 124\n\n    {\"status_code\":200,\"message\":\"ok\",\"data\":{\"task_id\":\"2fe1347e-d0f1-4da7-a08e-0f299e812008\",\"task_name\":\"pwd\",\"result\":true}}\n\n\n#### 响应结果示例\n\n    {\n      \"status_code\": 200,\n      \"message\": \"ok\",\n      \"data\": {\n        \"task_id\": \"2fe1347e-d0f1-4da7-a08e-0f299e812008\",\n        \"task_name\": \"date\",\n        \"result\": true\n      }\n    }\n\n### **POST /channels** 新建任务队列\n\n#### 请求参数\n\n| 参数 | 说明 |\n| --- | --- |\n| name | 队列名称，也就是推送任务时的channel |\n| distinct | 是否对命令进行去重，可选值为true/false，默认为false |\n| worker | worker数量 |\n\n#### 响应结果示例\n\n    {\n      \"status_code\": 200,\n      \"message\": \"ok\",\n      \"data\": null\n    }\n\n### **GET /channels/{channel_name}/failed-tasks** 查询channel下所有失败的任务\n\n#### 响应结果示例\n\n    {\n        \"status_code\": 200,\n        \"message\": \"ok\",\n        \"data\": {\n            \"3688442d-a896-4456-984e-70aae8a75139\": {\n                \"task_id\": \"3688442d-a896-4456-984e-70aae8a75139\",\n                \"task_name\": \"git-command\",\n                \"command\": {\n                    \"name\": \"git\",\n                    \"args\": null\n                },\n                \"channel\": \"default\",\n                \"status\": \"\",\n                \"retry_count\": 3,\n                \"failed_at\": \"2017-10-17T16:49:09.647182+08:00\"\n            }\n        }\n    }\n\n### **GET /channels/{channel_name}/failed-tasks/{task_id}** 查询channel下失败的某个任务\n\n#### 请求参数\n\n| 参数 | 说明 |\n|---|---|\n| channel_name | 任务所在的channel |\n| task_id | 任务ID |\n\n#### 响应示例\n\n    {\n        \"status_code\": 200,\n        \"message\": \"ok\",\n        \"data\": {\n            \"task_id\": \"3688442d-a896-4456-984e-70aae8a75139\",\n            \"task_name\": \"git-command\",\n            \"command\": {\n                \"name\": \"git\",\n                \"args\": null\n            },\n            \"channel\": \"default\",\n            \"status\": \"\",\n            \"retry_count\": 3,\n            \"failed_at\": \"2017-10-17T16:49:09.647182+08:00\"\n        }\n    }\n\n### **POST /channels/{channel_name}/failed-tasks/{task_id}** 重试channel下失败的任务\n\n#### 请求参数\n\n| 参数 | 说明 |\n|---|---|\n| channel_name | 任务所在的channel |\n| task_id | 任务ID |\n\n#### 响应示例\n\n    {\n        \"status_code\": 200,\n        \"message\": \"ok\",\n        \"data\": null\n    }\n\n### **GET /delay-tasks** 查询所有延迟任务\n\n### 响应示例\n\n    {\n        \"status_code\": 200,\n        \"message\": \"ok\",\n        \"data\": {\n            \"0a360b99-4b22-4269-bdec-9331deb8425c\": {\n                \"task_id\": \"0a360b99-4b22-4269-bdec-9331deb8425c\",\n                \"task_name\": \"git-command\",\n                \"command\": {\n                    \"name\": \"git\",\n                    \"args\": null\n                },\n                \"channel\": \"default\",\n                \"status\": \"\",\n                \"execute_at\": \"2017-10-17T18:07:18.737976+08:00\",\n                \"retry_count\": 0,\n                \"failed_at\": \"0001-01-01T00:00:00Z\"\n            }\n        }\n    }\n\n### **GET /delay-tasks/{task_id}** 查询某个延迟任务\n\n#### 请求参数\n\n| 参数 | 说明 |\n|---|---|\n| task_id | 任务ID |\n\n#### 响应示例\n\n    {\n        \"status_code\": 200,\n        \"message\": \"ok\",\n        \"data\": {\n            \"task_id\": \"dcf8e5c8-3207-457d-b75c-23b4841734b4\",\n            \"task_name\": \"git-command\",\n            \"command\": {\n                \"name\": \"git\",\n                \"args\": null\n            },\n            \"channel\": \"default\",\n            \"status\": \"\",\n            \"execute_at\": \"2017-10-20T11:24:21.986208+08:00\",\n            \"retry_count\": 0,\n            \"failed_at\": \"0001-01-01T00:00:00Z\"\n        }\n    }\n\n### **DELETE /delay-tasks/{task_id}** 删除某个延迟任务\n\n#### 请求参数\n\n| 参数 | 说明 |\n|---|---|\n| task_id | 任务ID |\n\n#### 响应示例\n\n    {\n        \"status_code\": 200,\n        \"message\": \"ok\",\n        \"data\": {\n            \"task_id\": \"182e1598-4915-4510-b2a9-3f9db8706dfd\",\n            \"task_name\": \"git-command\",\n            \"command\": {\n                \"name\": \"git\",\n                \"args\": null\n            },\n            \"channel\": \"default\",\n            \"status\": \"\",\n            \"execute_at\": \"2017-10-20T11:26:26.180545+08:00\",\n            \"retry_count\": 0,\n            \"failed_at\": \"0001-01-01T00:00:00Z\"\n        }\n    }\n\n## 注意事项\n\n### 安全问题\n\n**Coyotes** 会使用shell执行任务队列里的任何命令，包括系统相关的命令，如果不严格控制好输入，恶意用户可以非常轻松的拿到系统的root权限。\n\n1. 一定不要直接开放给外网，**只在内部信任的网络使用**，比如绑定http地址到`192.168`开头的网卡或者`127.0.0.1`本地网络\n2. 如果执行的命令包含来自用户的输入，一定要对输入内容进行严格检查，否则会引起命令注入，造成严重的安全问题，**不要相信任何来自用户的输入**\n3. 不要使用**root权限**执行\n\n## TODO\n\n* [x] 解决退出信号会传递到子进程的问题\n* [x] 队列channel持久化\n* [ ] 支持单个channel的退出\n* [ ] 排队中的任务取消\n* [x] 实现队列调度器\n* [ ] 使用可选后端记录任务执行结果、任务执行结果回调\n* [ ] 实现RabbitMQ作为broker的支持\n* [ ] 队列状态监控\n* [ ] 集群支持（任务分发，新增队列）\n* [ ] 支持脚本文件实时分发、执行\n* [ ] 定时任务执行能力，发送一个任务到队列，设定一个执行时间，时间到了的时候再执行该任务（延迟执行）\n* [ ] 增加配置文件\n* [ ] 增加对Redis Sentinel和Redis Cluster的支持\n* [ ] 解决可以执行任意系统命令带来的安全问题\n* [ ] 加入Redis连接池的支持\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmylxsw%2Fcoyotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmylxsw%2Fcoyotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmylxsw%2Fcoyotes/lists"}