{"id":18267659,"url":"https://github.com/oxeu/shook","last_synced_at":"2026-05-17T17:03:03.777Z","repository":{"id":149790048,"uuid":"621387280","full_name":"OXeu/shook","owner":"OXeu","description":"🛰A toolkit for invoke shell script by webhook","archived":false,"fork":false,"pushed_at":"2023-05-24T10:03:04.000Z","size":32,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-14T20:57:21.762Z","etag":null,"topics":["go","golang","shell","shell-script","webhook"],"latest_commit_sha":null,"homepage":"","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/OXeu.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}},"created_at":"2023-03-30T15:01:04.000Z","updated_at":"2023-04-02T06:35:22.000Z","dependencies_parsed_at":"2023-06-02T15:30:16.126Z","dependency_job_id":null,"html_url":"https://github.com/OXeu/shook","commit_stats":null,"previous_names":["oxeu/shook"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXeu%2Fshook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXeu%2Fshook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXeu%2Fshook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXeu%2Fshook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OXeu","download_url":"https://codeload.github.com/OXeu/shook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247964500,"owners_count":21025201,"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":["go","golang","shell","shell-script","webhook"],"created_at":"2024-11-05T11:28:12.404Z","updated_at":"2026-05-17T17:02:58.743Z","avatar_url":"https://github.com/OXeu.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ch3 align=\"center\"\u003eShook\u003c/h3\u003e\n\u003cp align=\"center\"\u003eEnable the \u003cstrong\u003eShell\u003c/strong\u003e scripts could be triggered by \u003cstrong\u003eWebhook\u003c/strong\u003e\u003c/p\u003e\n\u003c/p\u003e\n\n[![Release](https://img.shields.io/github/release/thankrain/shook.svg?style=for-the-badge)](https://github.com/thankrain/shook/releases/latest)\n[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge)](/LICENSE)\n[![Powered By: ThankRain](https://img.shields.io/badge/powered%20by-thankrain-red.svg?style=for-the-badge)](https://github.com/thankrain)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/thankrain/shook/release.yml?style=for-the-badge)\n\n\n---\n\n# Install\n\n```shell\ncurl -sfL https://raw.githubusercontent.com/ThankRain/shook/main/install.sh | bash\n```\n\n# Usage\n\n### Initialize Shook\n\n```shell\n$ shook init http://127.0.0.1:2399\n# $ shook init http://127.0.0.1:2399 [specific_token]\n# No token was set, generating token\n# 52fdfc072182654f163f5f0f9a621d72\n# Server initialization successfully. Please keep your token carefully.\n# Shook initialization successfully!\n```\n\n### Create a new webhook\n\nCreate a new webhook to invoke hello.sh when trigger \u003chost:port\u003e/hello\n```shell\n$ shook create hello ./hello.sh\n# $ shook create [hook_name] [script]\n# /hello hooks created!\n# $ cd D:\\Develop\\go\\shook\\src\\cli ; echo $(date) \u003e 1.txt\n```\n\nWhen trigger /hello, the app would cd to current folder and run the `./hello.sh` command\n\n### Invoke the webhook\n\n```shell\n$ shook run hello\n# $ shook run [hook_name]\n```\n\n**Or**\n\n```shell\n$ curl http://127.0.0.1:2399/hello\n# curl \u003cschema://host:post\u003e/\u003chook_name\u003e\n```\n\n# Notice\n\nThe server default register the path `/admin` to manage the webhooks, avoid to use this path as webhook invoke path\n\n# Features\n\n- [x] Basic GET and POST Webhook Without Params\n- [x] Basic Operation Auth\n- [ ] Support auto git repository deploy shell scripts\n\n# License\n\n```text\nMIT License\n\nCopyright (c) 2023 ThankRain\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxeu%2Fshook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxeu%2Fshook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxeu%2Fshook/lists"}