DotKernel component for creating console applications based on laminas-cli

3.5.0 2024-02-08 12:13 UTC

This package is auto-updated.

Last update: 2024-04-08 12:43:59 UTC


OSS Lifecycle PHP from Packagist (specify version)

GitHub issues GitHub forks GitHub stars GitHub license

Build Static codecov


DotKernel component to build console applications based on laminas-cli.


  • PHP >= 8.2
  • laminas/laminas-servicemanager >= 3.11,
  • laminas/laminas-cli >= 1.4


1. Install package

Run the following command in your application's root directory:

composer require dotkernel/dot-cli

2. Register ConfigProvider

Open your application's config/config.php and the following line under the DK packages comment:


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/ then copy it to your application's config/autoload/ directory. This is the config file you will add your commands to.


Using the command line, go to your application's root directory, then type the following command:

php /bin/cli.php

The output should look similar to this, containing information on how to start using dot-cli:

DotKernel CLI 1.0.0

  command [options] [arguments]

  -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:command  Demo command description.

As shown in config/autoload/, 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.

Setting up as cronjob

*   *   *   *   *   /opt/plesk/php/7.4/bin/php /var/www/vhosts/ demo:command -q


*   *   *   *   *   cd /var/www/vhosts/ && /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 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).