{"id":19300219,"url":"https://github.com/zunderbolt/cakephp-shell-autohelp","last_synced_at":"2025-02-24T01:24:54.758Z","repository":{"id":57092223,"uuid":"86449001","full_name":"zunderbolt/cakephp-shell-autohelp","owner":"zunderbolt","description":"Autogenerates CakePHP3 console shell help","archived":false,"fork":false,"pushed_at":"2017-03-28T11:43:41.000Z","size":4,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-05T22:42:22.746Z","etag":null,"topics":["cakephp","cakephp3","shell"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zunderbolt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-28T10:53:48.000Z","updated_at":"2017-03-28T11:45:51.000Z","dependencies_parsed_at":"2022-08-22T20:41:04.541Z","dependency_job_id":null,"html_url":"https://github.com/zunderbolt/cakephp-shell-autohelp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zunderbolt%2Fcakephp-shell-autohelp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zunderbolt%2Fcakephp-shell-autohelp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zunderbolt%2Fcakephp-shell-autohelp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zunderbolt%2Fcakephp-shell-autohelp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zunderbolt","download_url":"https://codeload.github.com/zunderbolt/cakephp-shell-autohelp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240401666,"owners_count":19795586,"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":["cakephp","cakephp3","shell"],"created_at":"2024-11-09T23:14:09.788Z","updated_at":"2025-02-24T01:24:54.725Z","avatar_url":"https://github.com/zunderbolt.png","language":"PHP","readme":"# Shell-auto-help plugin for CakePHP\n\nSmall trait to autogenerate CakePHP3 console shells help. No need to write ```$parser-\u003eaddArgument()``` and stuff, \njust add phpdoc to your shell methods.   \n\n\n#### Installation\n```\ncomposer require zunderbolt/cakephp-shell-autohelp\n```\n\n#### Usage\n\n```php\nnamespace App\\Shell;\n\nuse Cake\\Console\\Shell;\nuse ZunderBolt\\ShellAutoHelp\\AutoHelpTrait;\n\nclass MyShell extends Shell\n{\n    use AutoHelpTrait;\n\n    /**\n     * Method description will be used in help\n     * @param string $param1 Param1 description\n     * @param mixed $param2 Param2 description\n     */\n    public function test($param1, $param2 = null)\n    {\n    }\n}\n```\n\n`\u003e bin/cake my`\n```\nUsage:\ncake my [subcommand] [-h] [-q] [-v]\n\nSubcommands:\n\ntest  Method description will be used in help\n```\n\n`\u003e bin/cake my test --help`\n```\nUsage:\ncake my test [-h] [-q] [-v] \u003cparam1\u003e [\u003cparam2\u003e]\n\nOptions:\n\n--help, -h     Display this help.\n--quiet, -q    Enable quiet output.\n--verbose, -v  Enable verbose output.\n\nArguments:\n\nparam1  (string) Param1 description\nparam2  (mixed) Param2 description (optional)\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzunderbolt%2Fcakephp-shell-autohelp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzunderbolt%2Fcakephp-shell-autohelp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzunderbolt%2Fcakephp-shell-autohelp/lists"}