{"id":21619078,"url":"https://github.com/bannzai/teapot","last_synced_at":"2025-04-11T08:42:45.557Z","repository":{"id":63905209,"uuid":"179598511","full_name":"bannzai/Teapot","owner":"bannzai","description":null,"archived":false,"fork":false,"pushed_at":"2019-07-07T13:38:56.000Z","size":107,"stargazers_count":31,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-06T05:00:03.915Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Swift","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/bannzai.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}},"created_at":"2019-04-05T00:48:08.000Z","updated_at":"2022-09-17T05:15:14.000Z","dependencies_parsed_at":"2022-11-28T19:23:32.597Z","dependency_job_id":null,"html_url":"https://github.com/bannzai/Teapot","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bannzai%2FTeapot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bannzai%2FTeapot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bannzai%2FTeapot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bannzai%2FTeapot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bannzai","download_url":"https://codeload.github.com/bannzai/Teapot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248362498,"owners_count":21091141,"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":[],"created_at":"2024-11-24T23:07:50.372Z","updated_at":"2025-04-11T08:42:45.527Z","avatar_url":"https://github.com/bannzai.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\" \u003e\n  \u003cimg width=\"50%\" src=\"logo/teapot_logo.png\" /\u003e\n\u003c/div\u003e\n\n[![swift5.0](https://img.shields.io/badge/language-swift5.0-blue.svg?style=flat)](https://developer.apple.com/swift)\n[![Platform](https://img.shields.io/badge/platform-macOS-green.svg)](https://img.shields.io/badge/platform-macOS-green.svg)\n[![License](http://img.shields.io/badge/license-MIT-000000.svg?style=)](https://github.com/bannzai/Teapot/blob/master/LICENSE)\n\n## Teapot\nTeapot is command line tool writen by Swift.  \nIt can be execute your shell command for each file, when file modified.\n\n## Required\nSwift 5.0 or later.\nAnd it require to run on macOS.\n\n\n## Install\nUsing mint. \n```shell\n$ mint install bannzai/Teapot\n```\n\n## Usage\nFirst, Teapot necessary configuration file named `teapot.yml`.\nTeapot can prepare `teapot.yml` to under the current directory via `$ teapot setup`.\n```swift\n$ teapot setup\n🍵 Teapot setup completion. You can edit ./teapot.yml 🍵\n```\n\nThis will generate the following file:\n```yaml\nsource:\n- build/*\n- Sources/*.*\n- Sources/Teapot/*.*\nignore:\n- \".git\"\n- \".gitignore\"\n- tests/*\nexecute: \n- ls -la __FILE__\n- echo $HOME\n```\n\n- `source` is target file of listen to changing.\n- `ignore` is ignored target file of listen to changing.\n- `execute` is exec shell command for changed target file.\n- `__FILE__` is mark of changed file. So, It is replaced when file changed.\n\nNext, Teapot can be execute your shell command for each file when file modified for it according to `teapot.yml` configuration. \n\n```swift\n$ teapot start\n🍵 Teapot start 🍵\n```\n\nFor example, when you edit some file, teapot display result of `$ ls -la` to changed file.\n\n## LICENSE\n[Teapot](https://github.com/bannzai/Teapot/) is released under the MIT license. See [LICENSE](https://github.com/bannzai/Teapot/blob/master/LICENSE.txt) for details.\n\nHeader logo is released [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/deed) license. Original design by [noainoue](https://github.com/noainoue).\u003cPaste\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbannzai%2Fteapot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbannzai%2Fteapot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbannzai%2Fteapot/lists"}