{"id":20103146,"url":"https://github.com/dotkernel/dot-cli","last_synced_at":"2025-05-06T08:31:10.477Z","repository":{"id":42436763,"uuid":"364520113","full_name":"dotkernel/dot-cli","owner":"dotkernel","description":"DotKernel component to build console applications based on laminas-cli.","archived":false,"fork":false,"pushed_at":"2025-02-28T05:57:26.000Z","size":115,"stargazers_count":5,"open_issues_count":4,"forks_count":3,"subscribers_count":3,"default_branch":"3.0","last_synced_at":"2025-04-27T00:03:49.899Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.dotkernel.org/dot-cli/","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/dotkernel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-05T09:10:20.000Z","updated_at":"2025-02-28T05:54:12.000Z","dependencies_parsed_at":"2024-05-03T18:48:33.556Z","dependency_job_id":"deffea2a-d2d5-4a7c-a960-98b8caf22cb4","html_url":"https://github.com/dotkernel/dot-cli","commit_stats":{"total_commits":11,"total_committers":5,"mean_commits":2.2,"dds":0.4545454545454546,"last_synced_commit":"fa6d8dc7a70a263bd185606bae7862a2b74a82c2"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotkernel%2Fdot-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotkernel%2Fdot-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotkernel%2Fdot-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotkernel%2Fdot-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dotkernel","download_url":"https://codeload.github.com/dotkernel/dot-cli/tar.gz/refs/heads/3.0","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252648573,"owners_count":21782405,"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":[],"created_at":"2024-11-13T17:34:27.281Z","updated_at":"2025-05-06T08:31:10.470Z","avatar_url":"https://github.com/dotkernel.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dot-cli\n\nDotkernel component to build console applications based on [laminas-cli](https://github.com/laminas/laminas-cli).\n\n\u003e dot-cli is a wrapper on top of [laminas-cli](https://github.com/laminas/laminas-cli)\n\n## Documentation\n\nDocumentation is available at: https://docs.dotkernel.org/dot-cli/.\n\n## Badges\n\n![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-cli)\n![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-cli/3.9.0)\n\n[![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-cli)](https://github.com/dotkernel/dot-cli/issues)\n[![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-cli)](https://github.com/dotkernel/dot-cli/network)\n[![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-cli)](https://github.com/dotkernel/dot-cli/stargazers)\n[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-cli)](https://github.com/dotkernel/dot-cli/blob/3.0/LICENSE)\n\n[![Build Static](https://github.com/dotkernel/dot-cli/actions/workflows/continuous-integration.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-cli/actions/workflows/continuous-integration.yml)\n[![codecov](https://codecov.io/gh/dotkernel/dot-cli/graph/badge.svg?token=0DFCK2GUBT)](https://codecov.io/gh/dotkernel/dot-cli)\n[![PHPStan](https://github.com/dotkernel/dot-cli/actions/workflows/static-analysis.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-cli/actions/workflows/static-analysis.yml)\n\n## Requirements\n\n- **PHP**: 8.2, 8.3 or 8.4\n- **laminas/laminas-servicemanager**: \u003e= 3.11 || \u003e= 4.0,\n- **laminas/laminas-cli**: \u003e= 1.4\n\n## Setup\n\n### 1. Install package\n\nRun the following command in your application's root directory:\n\n```shell\ncomposer require dotkernel/dot-cli\n```\n\n### 2. Register ConfigProvider\n\nOpen your application's `config/config.php` and the following line under the _DK packages_ comment:\n\n```php\nDot\\Cli\\ConfigProvider::class,\n```\n\n### 3. Copy bootstrap file\n\nLocate file `bin/cli.php` in this package, then copy it to your application's `bin/` directory.\nThis is the bootstrap file you will use to execute your commands with.\n\n### 4. Copy config file\n\nLocate in this package the following file `config/autoload/cli.global.php` then copy it to your application's `config/autoload/` directory.\nThis is the config file you will add your commands to.\n\n## Testing\n\nUsing the command line, go to your application's root directory, then type the following command:\n\n```shell\nphp ./bin/cli.php\n```\n\nThe output should look similar to this, containing information on how to start using dot-cli:\n\n```text\nDotkernel CLI 1.0.0\n\nUsage:\n  command [options] [arguments]\n\nOptions:\n  -h, --help            Display help for the given command. When no command is given display help for the list command\n  -q, --quiet           Do not output any message\n  -V, --version         Display this application version\n      --ansi            Force ANSI output\n      --no-ansi         Disable ANSI output\n  -n, --no-interaction  Do not ask any interactive question\n  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug\n\nAvailable commands:\n  help          Display help for a command\n  list          List commands\n demo\n  demo:command  Demo command description.\n```\n\nAs shown in `config/autoload/cli.global.php`, dot-cli includes a demo command `demo:command` that will help you understand the basics of creating a new command.\nFor more information, see [laminas-cli documentation](https://docs.laminas.dev/laminas-cli/).\n\n## Setting up as cronjob\n\n```text\n*   *   *   *   *   /opt/plesk/php/7.4/bin/php /var/www/vhosts/example.com/httpdocs/bin/cli.php demo:command -q\n```\n\nor\n\n```text\n*   *   *   *   *   cd /var/www/vhosts/example.com/httpdocs/bin \u0026\u0026 /opt/plesk/php/7.4/bin/php ./cli.php demo:command -q\n```\n\nAdapt the command to your specifications by replacing **7.4** with your PHP version and **example.com** with your domain name.\n\nNote the **-q** (or **--quiet**) option at the end of the command - it serves as a flag to inform the Application that no output should be returned (unless it's an error).\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotkernel%2Fdot-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotkernel%2Fdot-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotkernel%2Fdot-cli/lists"}