{"id":16179557,"url":"https://github.com/gschier/will-you-please","last_synced_at":"2025-03-19T01:31:02.514Z","repository":{"id":57710068,"uuid":"267486248","full_name":"gschier/will-you-please","owner":"gschier","description":"✨ The easiest way to run scripts during development ","archived":false,"fork":false,"pushed_at":"2023-02-25T02:14:10.000Z","size":1492,"stargazers_count":40,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T13:49:12.512Z","etag":null,"topics":["cli","developer-tools"],"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/gschier.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["gschier"]}},"created_at":"2020-05-28T03:41:40.000Z","updated_at":"2024-09-15T11:50:01.000Z","dependencies_parsed_at":"2024-06-20T15:52:17.980Z","dependency_job_id":null,"html_url":"https://github.com/gschier/will-you-please","commit_stats":null,"previous_names":["gschier/willyouplease","gschier/wyp"],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gschier%2Fwill-you-please","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gschier%2Fwill-you-please/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gschier%2Fwill-you-please/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gschier%2Fwill-you-please/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gschier","download_url":"https://codeload.github.com/gschier/will-you-please/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243960361,"owners_count":20375102,"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":["cli","developer-tools"],"created_at":"2024-10-10T05:28:51.335Z","updated_at":"2025-03-19T01:31:02.088Z","avatar_url":"https://github.com/gschier.png","language":"Go","funding_links":["https://github.com/sponsors/gschier"],"categories":["Go"],"sub_categories":[],"readme":"# Will You Please [![Release](https://github.com/gschier/will-you-please/workflows/Release/badge.svg)](https://github.com/gschier/will-you-please/actions?query=workflow%3ARelease)\n\nWill you please is a script runner for local development.\n\n![Demo GIF](https://raw.githubusercontent.com/gschier/wyp/master/screenshots/demo.gif)\n\n## Getting Started\n\nInstall the `wyp` binary:\n\n```bash\ngo install github.com/gschier/wyp@latest\n```\n\nGenerate a config file:\n\n```bash\nwyp init  # Generate ./wyp.yaml\n```\n\nRun some commands!\n\n```bash\nwyp run                           # Prompt for script to run\nwyp run [name]                    # Execute script by name\nwyp run [name] --watch            # Prompt and restart on file change\nwyp run [name] --watch-dir ./src  # Watch specific directory\n\nwyp combine [name...]  # Execute scripts in parallel\n\nwyp start  # Shorthand for `wyp run start`\n```\n\n## Configuration\n\nConfiguration is defined in `wyp.(yaml|toml|json)`. An sample config can be generated by running `wyp init`.\n\n```yaml\n# ~~~~~~~~ #\n# wyp.yaml #\n# ~~~~~~~~ #\n\n# Scripts are defined in a map of [name] =\u003e [config]\nscripts:\n  backend:\n    help: run the backend\n    run: go run main.go\n    watch: .\n    \n  backend:\n    help: run the frontend\n    run: npm start\n    watch: ./frontend\n    \n  start:\n    help: run backend and frontend\n    combine:\n      - backend\n      - frontend\n```\n\nHere's a dummy config that showcases all possible options.\n\n```yaml  \n  # Complete example\n  everything-example:\n\n    # Help text for command\n    help: command with all options\n  \n    # Make available under \"wyp [name]\" vs default \"wyp run [name]\"\n    root: true\n  \n    # Execute other scripts by name\n    combine:\n      - command1\n      - command2\n\n    # Code to execute for script\n    run: echo \"Hello World\"\n  \n    # Define environment variables for run context\n    env:\n      - NAME=value\n      - ANOTHER='something that needs quotes'\n\n    # Change the directory the command is run in (default ./)\n    dir: './some/other/directory'\n\n    # Hide command from help output\n    hide: true\n\n    # Select between bash/zsh/sh (default: current shell)\n    shell: bash\n\n    # Restart when file change detected (recursive)\n    watch: .\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgschier%2Fwill-you-please","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgschier%2Fwill-you-please","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgschier%2Fwill-you-please/lists"}