Console
Motivation: this library purpose is to provide a lighter and more robust API for console commands and/or applications to symfony/console.
It can be used either in combination with FrameworkBundle to facilitate the creation of commands or as a stand-alone package to create a CLI application app.
Key differences:
- Implement interfaces instead of extending classes
- Leverages an
IOobject instead of Input + Output + SymfonyStyle which offers:- The API of SymfonyStyle but still access to the Input and Output objects
- A typed API for arguments and options
Table of Contents
- Installation with Symfony
- Usage preview
- Complete documentation
- Complete documentation
- Known Limitations
- Contributing
Installation with Symfony
<?php declare(strict_types=1);
// config/bundles.php
return [
// ...
// Symfony\Bundle\FrameworkBundle\Symfony\Bundle\FrameworkBundle()
// ...
Fidry\Console\FidryConsoleBundle::class => ['all' => true],
];
Usage preview
To implement a command you have to implement the Fidry\Console\Command\Command interface as follows:
<?php declare(strict_types=1);
namespace Acme;
use Acme\MyService;
use Fidry\Console\Command\Command;
use Fidry\Console\Command\Configuration;
use Fidry\Console\ExitCode;
use Fidry\Console\IO;
final class CommandWithService implements Command
{
private MyService $service;
public function __construct(MyService $service)
{
$this->service = $service;
}
public function getConfiguration(): Configuration
{
return new Configuration(
'app:foo',
'Calls MyService',
<<<'EOT'
The <info>%command.name</info> command calls MyService
EOT,
);
}
public function execute(IO $io): int
{
$this->service->call();
return ExitCode::SUCCESS;
}
}
With the bundle enabled, those services are auto-configured into traditional Symfony commands.
Complete documentation
Known limitations
Some limitations are due to lack of time dedicated to those or based on the assumption they are not necessary. Those choices may be revisited depending on of the use case presented.
- Support for hidden commands (see doc)
- Support for command aliases
- Support for command usage configuration
- Some methods of
Application
Contributing
The project provides a Makefile in which the most common commands have been registered such as fixing the coding style or running the test.
# Print the list of available commands
make
# or
make help
624 Dec 6, 2022
1.8k Jan 3, 2023
436 Feb 20, 2022
324 Dec 28, 2022
793 Dec 25, 2022
336 Jan 7, 2023
18 Dec 31, 2022
96 Dec 29, 2022
22 Mar 8, 2022
29 Nov 19, 2022
283 Dec 10, 2022
3 Oct 20, 2022
4 Mar 8, 2022
3 May 29, 2022
1 Jan 26, 2022
1 Jan 17, 2022
5 Oct 7, 2022
1.9k Dec 28, 2022