{"id":29671393,"url":"https://github.com/linkorb/commando","last_synced_at":"2025-09-23T18:07:07.709Z","repository":{"id":37548587,"uuid":"75082257","full_name":"linkorb/commando","owner":"linkorb","description":"Commando: Generic background job runner","archived":false,"fork":false,"pushed_at":"2023-10-25T07:04:56.000Z","size":532,"stargazers_count":3,"open_issues_count":5,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-22T20:13:25.988Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/linkorb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-29T13:05:50.000Z","updated_at":"2022-09-09T07:30:26.000Z","dependencies_parsed_at":"2022-08-26T15:30:51.606Z","dependency_job_id":null,"html_url":"https://github.com/linkorb/commando","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/linkorb/commando","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkorb%2Fcommando","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkorb%2Fcommando/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkorb%2Fcommando/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkorb%2Fcommando/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/linkorb","download_url":"https://codeload.github.com/linkorb/commando/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkorb%2Fcommando/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276622946,"owners_count":25675204,"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","status":"online","status_checked_at":"2025-09-23T02:00:09.130Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-07-22T20:07:45.600Z","updated_at":"2025-09-23T18:07:07.669Z","avatar_url":"https://github.com/linkorb.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Commando\n========\n\nCommando is a generic job-runner.\n\nYou can define your own commands in Json or Yaml files, and process jobs from different\nstores such as a directory of files, or a database.\n\nIt's goal is to make it easy to implement background jobs into your application.\n\nAn example workflow:\n\n1. You define a command \"hello\" in `commando.yml`:\n\n```yml\ncommands:\n  hello:\n    template: echo \"Hello {{ greeted }}\"\n    inputs:\n      greeted:\n        default: world\n```\n2. Your app writes a job into `/your/commando-path/new` called `1.json`:\n```json\n{\n  \"command\": \"hello\",\n  \"inputs\": {\n    \"greeted\": \"universe\"\n  }\n}\n```\n3. You (or cron) runs `commando run`.\n4. Commando will check for new job files in the configured store (in this case a directory), execute the command, replacing arguments in the template with the\npassed job arguments, finally executing `echo \"Hello universe\"`\n5. Commando reports the job status back to the store, including exit codes,\nstart/end times, total duration, and stdout and stderr\n6. Your app reports back to the user if needed, based on the status report.\n\n## Stores:\n\n* `JsonDirJobStore`: Manages jobs through json files with a simple directory structure\n* `PdoJobStore`: Manages jobs through a database table\n* `CamundaJobStore`: Camunda External Task client\n\n## Use-cases\n\nYou can replace the `template` with much more complex command-lines or shell-scripts.\n\nYour app should treat these jobs as \"fire-and-forget\", meaning the app\nshould not block, waiting for response. It's most ideal in scenarios where\nyour triggers commands and doesn't need to know about the response right away:\n\nExamples:\n\n* Update PDFs or reports in the background\n* Send emails and notifications\n* Create a database backup\n* Process uploaded image files\n* ...etc\n\n## Conventional Commits\n\nThis repository is using [Conventional Commits](https://www.conventionalcommits.org/)\n\nPlease run `npm install` at least once, in order to install the appropriate tooling and git hooks (this helps you to follow the conventions by linting them before actually committing).\n\nIn short: you should prefix your commit titles with the correct type (i.e. `feat: my new cool feature`). This helps to create clear commit histories, automatically handles semver, tagging and CHANGELOG.md generation.\n\nIf you'd like to reference a card in our planning system, simply add a `#123` to the end of your commit title. The card will be correctly linked from the changelogs etc.\n\nTo publish a new release, simply run `npm run publish`. This will update the changelog, and manifests like composer.json, package.json, etc to a new tag. The tag follows Semver, and is selected based on your commit types since the last release.\n\n## License\n\nPlease refer to the included LICENSE.md file\n\n## Brought to you by the LinkORB Engineering team\n\n\u003cimg src=\"http://www.linkorb.com/d/meta/tier1/images/linkorbengineering-logo.png\" width=\"200px\" /\u003e\u003cbr /\u003e\nCheck out our other projects at [engineering.linkorb.com](http://engineering.linkorb.com).\n\nBtw, we're hiring!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinkorb%2Fcommando","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinkorb%2Fcommando","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinkorb%2Fcommando/lists"}