Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theofidry/console
Library for creating CLI commands or applications
https://github.com/theofidry/console
cli console symfony
Last synced: about 6 hours ago
JSON representation
Library for creating CLI commands or applications
- Host: GitHub
- URL: https://github.com/theofidry/console
- Owner: theofidry
- License: mit
- Created: 2021-05-03T10:37:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-07T10:37:09.000Z (17 days ago)
- Last Synced: 2024-12-17T06:06:19.704Z (7 days ago)
- Topics: cli, console, symfony
- Language: PHP
- Homepage:
- Size: 583 KB
- Stars: 19
- Watchers: 5
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## Console
Motivation: this library purpose is to provide a lighter and more robust API
for console commands and/or applications to [symfony/console][SymfonyConsole].
It can be used either in combination with [`FrameworkBundle`][FrameworkBundle] to
facilitate the creation of commands or as a stand-alone package to create a CLI
application app.
Key differences:
- Leverages an `IO` object 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 (the input is validated when
coercing it to a stricter type)
- Implement explicit interfaces instead of extending god classes
## Table of Contents
- [Installation with Symfony](#installation-with-symfony)
- [Usage preview](#usage-preview)
- [Complete documentation](#complete-documentation)
- [Command](./doc/command.md)
- [Creating a command](./doc/command.md#creating-a-command)
- [Configuring the Command](./doc/command.md#configuring-the-command)
- [Registering the Command](./doc/command.md#registering-the-command)
- [Executing the Command](./doc/command.md#executing-the-command)
- [Console Output](./doc/command.md#console-output)
- [Output Sections](./doc/command.md#output-sections)
- [Console Input](./doc/command.md#console-input)
- [Getting Services from the Service Container](./doc/command.md#getting-services-from-the-service-container)
- [Command Lifecycle](./doc/command.md#command-lifecycle)
- [Testing Commands](./doc/command.md#testing-commands)
- [Logging Command Errors](./doc/command.md#logging-command-errors)
- [Learn More](./doc/command.md#learn-more)
- [How to Call Other Commands](./doc/call-other-commands.md)
- [How to Make Commands Lazily Loaded](./doc/lazy-command.md)
- [Application](./doc/application.md)
- [Creating an application](./doc/application.md#creating-an-application)
- [Executing an Application](./doc/application.md#executing-an-application)
- [Testing](./doc/testing.md)
- [Testing an Application](./doc/testing.md#testing-an-application)
- [Testing a Command](./doc/testing.md#testing-a-command)
- [Known Limitations](#known-limitations)
- [Inspirations](#inspirations)
- [Contributing](#contributing)
### Installation with Symfony
```
$ composer require theofidry/console
```
The Symfony Flex plugin should add the following:
```php
['all' => true],
];
```
### Usage preview
To implement a command you have to implement the `Fidry\Console\Command\Command` interface as
follows:
```php
service = $service;
}
public function getConfiguration(): Configuration
{
return new Configuration(
'app:foo',
'Calls MyService',
<<<'EOT'
The %command.name command calls MyService
EOT,
[
new InputArgument(
'username',
InputArgument::REQUIRED,
'Name of the user',
),
new InputArgument(
'age',
InputArgument::OPTIONAL,
'Age of the user',
),
],
);
}
public function execute(IO $io): int
{
$this->service->call(
$io->getTypedArgument('username')->asStringNonEmptyList(),
$io->getTypedArgument('age')->asNullablePositiveInteger(),
);
return ExitCode::SUCCESS;
}
}
```
With the bundle enabled, those services are auto-configured into traditional Symfony commands.
### 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][hidden-commands])
- Support for command aliases
- Support for command usage configuration
- Some obscure methods of `Application`
### Inspirations
- [zenstruck/console-extra](https://github.com/zenstruck/console-extra)
- [zenstruck/console-test](https://github.com/zenstruck/console-test)
- [webignition/symfony-console-typed-input](https://github.com/webignition/symfony-console-typed-input)
- [webmozart-console](https://github.com/webmozart/console)
### 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.
```bash
# Print the list of available commands
make
# or
make help
```
[hidden-commands]: https://symfony.com/doc/current/console/hide_commands.html
[FrameworkBundle]: https://github.com/symfony/framework-bundle
[SymfonyConsole]: https://github.com/symfony/console