https://github.com/dotkernel/dot-cli
DotKernel component to build console applications based on laminas-cli.
https://github.com/dotkernel/dot-cli
Last synced: 9 months ago
JSON representation
DotKernel component to build console applications based on laminas-cli.
- Host: GitHub
- URL: https://github.com/dotkernel/dot-cli
- Owner: dotkernel
- License: mit
- Created: 2021-05-05T09:10:20.000Z (over 4 years ago)
- Default Branch: 3.0
- Last Pushed: 2025-02-28T05:57:26.000Z (11 months ago)
- Last Synced: 2025-04-27T00:03:49.899Z (9 months ago)
- Language: PHP
- Homepage: https://docs.dotkernel.org/dot-cli/
- Size: 112 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# dot-cli
Dotkernel component to build console applications based on [laminas-cli](https://github.com/laminas/laminas-cli).
> dot-cli is a wrapper on top of [laminas-cli](https://github.com/laminas/laminas-cli)
## Documentation
Documentation is available at: https://docs.dotkernel.org/dot-cli/.
## Badges
[](https://github.com/dotkernel/dot-cli/issues)
[](https://github.com/dotkernel/dot-cli/network)
[](https://github.com/dotkernel/dot-cli/stargazers)
[](https://github.com/dotkernel/dot-cli/blob/3.0/LICENSE)
[](https://github.com/dotkernel/dot-cli/actions/workflows/continuous-integration.yml)
[](https://codecov.io/gh/dotkernel/dot-cli)
[](https://github.com/dotkernel/dot-cli/actions/workflows/static-analysis.yml)
## Requirements
- **PHP**: 8.2, 8.3 or 8.4
- **laminas/laminas-servicemanager**: >= 3.11 || >= 4.0,
- **laminas/laminas-cli**: >= 1.4
## Setup
### 1. Install package
Run the following command in your application's root directory:
```shell
composer require dotkernel/dot-cli
```
### 2. Register ConfigProvider
Open your application's `config/config.php` and the following line under the _DK packages_ comment:
```php
Dot\Cli\ConfigProvider::class,
```
### 3. Copy bootstrap file
Locate file `bin/cli.php` in this package, then copy it to your application's `bin/` directory.
This is the bootstrap file you will use to execute your commands with.
### 4. Copy config file
Locate in this package the following file `config/autoload/cli.global.php` then copy it to your application's `config/autoload/` directory.
This is the config file you will add your commands to.
## Testing
Using the command line, go to your application's root directory, then type the following command:
```shell
php ./bin/cli.php
```
The output should look similar to this, containing information on how to start using dot-cli:
```text
Dotkernel CLI 1.0.0
Usage:
command [options] [arguments]
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Available commands:
help Display help for a command
list List commands
demo
demo:command Demo command description.
```
As 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.
For more information, see [laminas-cli documentation](https://docs.laminas.dev/laminas-cli/).
## Setting up as cronjob
```text
* * * * * /opt/plesk/php/7.4/bin/php /var/www/vhosts/example.com/httpdocs/bin/cli.php demo:command -q
```
or
```text
* * * * * cd /var/www/vhosts/example.com/httpdocs/bin && /opt/plesk/php/7.4/bin/php ./cli.php demo:command -q
```
Adapt the command to your specifications by replacing **7.4** with your PHP version and **example.com** with your domain name.
Note 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).
## License
MIT