{"id":27947890,"url":"https://github.com/luckyframework/lucky_task","last_synced_at":"2025-05-07T14:38:44.661Z","repository":{"id":39643851,"uuid":"354442254","full_name":"luckyframework/lucky_task","owner":"luckyframework","description":"Library for creating command line tasks for the Lucky CLI","archived":false,"fork":false,"pushed_at":"2023-09-22T17:36:29.000Z","size":90,"stargazers_count":7,"open_issues_count":8,"forks_count":5,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-05-06T00:04:54.178Z","etag":null,"topics":["crystal","crystal-lang","lucky-framework"],"latest_commit_sha":null,"homepage":"","language":"Crystal","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/luckyframework.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":"2021-04-04T02:55:05.000Z","updated_at":"2024-05-06T00:04:54.179Z","dependencies_parsed_at":"2022-08-28T07:30:51.109Z","dependency_job_id":null,"html_url":"https://github.com/luckyframework/lucky_task","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckyframework%2Flucky_task","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckyframework%2Flucky_task/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckyframework%2Flucky_task/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckyframework%2Flucky_task/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luckyframework","download_url":"https://codeload.github.com/luckyframework/lucky_task/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252896915,"owners_count":21821358,"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":["crystal","crystal-lang","lucky-framework"],"created_at":"2025-05-07T14:38:43.973Z","updated_at":"2025-05-07T14:38:44.653Z","avatar_url":"https://github.com/luckyframework.png","language":"Crystal","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lucky Task\n\nA Crystal library for creating command line tasks to be used with the [LuckyCli](https://github.com/luckyframework/lucky_cli).\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n   ```yaml\n   dependencies:\n     lucky_task:\n       github: luckyframework/lucky_task\n   ```\n\n2. Run `shards install`\n\n## Integrating With LuckyCli\n\nCreate a file `tasks.cr` at the root of your project\n\n```crystal\nrequire \"lucky_task\"\n\n# Using `lucky` from the command line will do nothing if you forget this\nLuckyTask::Runner.run\n```\n\n## Creating Tasks\n\nCreate a `tasks` directory in the root of your project.\n\nUpdate your `tasks.cr` file to require all files within that directory for them to be registered with the CLI.\n\n```crystal\n# tasks.cr\nrequire \"lucky_task\"\nrequire \"./tasks/*\"\n```\n\nIn the directory create a file called `send_daily_notifications.cr`.\n\n```crystal\nclass SendDailyNotifications \u003c LuckyTask::Task\n  summary \"Send notifications to users\"\n  \n  # Name is inferred from class name (\"send_daily_notifications\")\n  # It can be overridden:\n  #\n  #   task_name \"app.send_daily_notifications\"\n  \n  def call\n    # Code that sends notifications to all your users...\n  end\nend\n```\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/luckyframework/lucky_task/fork\u003e)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## Contributors\n\n- [matthewmcgarvey](https://github.com/matthewmcgarvey) - creator and maintainer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluckyframework%2Flucky_task","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluckyframework%2Flucky_task","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluckyframework%2Flucky_task/lists"}