{"id":15406826,"url":"https://github.com/dannyben/runfile","last_synced_at":"2025-08-12T14:35:13.959Z","repository":{"id":32048028,"uuid":"35619601","full_name":"DannyBen/runfile","owner":"DannyBen","description":"Command line for your projects","archived":false,"fork":false,"pushed_at":"2024-03-23T07:33:51.000Z","size":2342,"stargazers_count":35,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-01T14:12:11.164Z","etag":null,"topics":["cli","cli-framework","cli-gem","cli-generator","gem","ruby","ruby-cli","ruby-gem","task-runner","terminal"],"latest_commit_sha":null,"homepage":"https://runfile.dannyb.co","language":"Ruby","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/DannyBen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support/cast.gif","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"DannyBen"}},"created_at":"2015-05-14T15:35:22.000Z","updated_at":"2024-02-28T03:01:30.000Z","dependencies_parsed_at":"2024-05-01T08:52:40.824Z","dependency_job_id":"120621c1-94b6-452a-85a0-b833abbb7cce","html_url":"https://github.com/DannyBen/runfile","commit_stats":null,"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DannyBen%2Frunfile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DannyBen%2Frunfile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DannyBen%2Frunfile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DannyBen%2Frunfile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DannyBen","download_url":"https://codeload.github.com/DannyBen/runfile/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788535,"owners_count":21161725,"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","cli-framework","cli-gem","cli-generator","gem","ruby","ruby-cli","ruby-gem","task-runner","terminal"],"created_at":"2024-10-01T16:25:42.458Z","updated_at":"2025-08-12T14:35:13.936Z","avatar_url":"https://github.com/DannyBen.png","language":"Ruby","readme":"\u003cdiv align='center'\u003e\n\u003cimg src='logo.svg' width=280\u003e\n\n# Runfile - command line for your projects\n\n---\n\nA beautiful command line utility builder  \nRake-inspired ✦ Docopt inside  \n**[runfile.dannyb.co](https://runfile.dannyb.co)**\n\n---\n\n\u003c/div\u003e\n\n**Runfile** lets you create command line tools in a way similar to\n[Rake](https://github.com/ruby/rake), but with the full power of \n[Docopt](http://docopt.org/) command line options.\n\nYou create a `runfile`, and execute commands with \n`run command arguments -and --flags`.\n\nRunfile is designed primarily for Ruby developers, but if you need to add a \ncommand line \"toolbelt\" for your projects, you can use it regardless.\n\n## Demo\n\n![Runfile Demo](support/cast.gif \"Runfile Demo\")\n\n## Install\n\n```shell\n$ gem install runfile --pre\n```\n\n## Quick Start\n\n```shell\n$ run new        # create a new runfile\n$ run --help     # show the usage patterns\n$ vi runfile     # edit the runfile\n```\n\n## Example\n\nA simple `runfile` looks like this. You can get this template by running \n`run new` (in a directory without other runfiles).\n\n```ruby\ntitle   'Greeter'\nsummary 'A sample runfile'\n\nusage  'hello [NAME --shout]'\nhelp   'Say hello'\noption '--shout, -s', 'Greet louder'\naction 'hello' do |args|\n  name = args['NAME'] || 'You...'\n  message = \"Hello #{name}\"\n  message = \"#{message.upcase}!\" if args['--shout']\n\n  say \"gu`#{message}`\"\nend\n```\n\nYou can then run it by executing this command:\n\n```shell\n$ run hello Luke\nHello Luke\n```\n\nIt will behave in the same way you expect any standard command line interface to\nbehave, \n\n```shell\n# Show usage summary\n$ run\nUsage:\n  run hello [NAME --shout]\n  run (--help | -h)\n\n# Show detailed help\n$ run --help\nGreeter\n\n  A sample runfile\n\nUsage:\n  run hello [NAME --shout]\n  run (--help | -h)\n\nCommands:\n  hello\n    Say hello\n\nOptions:\n  --shout, -s\n    Greet louder\n\n  --help, -h\n    Show this message\n```\n\n### More Examples\n\nYou can learn almost everything there is to know about runfile from the\n[examples](https://github.com/DannyBen/runfile/tree/master/examples#readme).\n\nYou can get any of these examples directly in your terminal by running:\n\n```shell\n$ run example --help\n```\n\n## Documentation\n\nFor a more formal documentation, see the [User Guide](https://runfile.dannyb.co/).\n\n## Contributing / Support\n\nIf you experience any issue, have a question or a suggestion, or if you wish to\ncontribute, feel free to\n[open an issue](https://github.com/DannyBen/runfile/issues).\n","funding_links":["https://github.com/sponsors/DannyBen"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdannyben%2Frunfile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdannyben%2Frunfile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdannyben%2Frunfile/lists"}