PHPackages                             arvodia/arvodia-cli - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. arvodia/arvodia-cli

ActiveLibrary[CLI & Console](/categories/cli)

arvodia/arvodia-cli
===================

ARVODIA CLI Tools

1.1.8(4y ago)0104GPL-3.0-onlyPHPPHP >=7.2.5

Since May 6Pushed 4y ago1 watchersCompare

[ Source](https://github.com/arvodia/arvodia-cli)[ Packagist](https://packagist.org/packages/arvodia/arvodia-cli)[ Docs](https://github.com/arvodia/arvodia-cli)[ RSS](/packages/arvodia-arvodia-cli/feed)WikiDiscussions main Synced today

READMEChangelog (1)DependenciesVersions (6)Used By (0)

[![EURL ARVODIA Logo](https://raw.githubusercontent.com/arvodia/src/main/img/arvodia-logo.png)](https://raw.githubusercontent.com/arvodia/src/main/img/arvodia-logo.png)

ARVODIA CLI Tools
=================

[](#arvodia-cli-tools)

The Arvodia CLI Tools makes it easy to create command line interfaces.

Contents
--------

[](#contents)

- [Feature](#feature)
- [Screenshot](#screenshot)
- [Installation](#installation)
- [Commands](#commands)
- [Example](#example)
- [Annotations](#annotations)
    - [Syntax](#syntax)
- [Input Arguments](#input-arguments)
- [Configuration](#configuration)
- [Git clone](#git-clone)
- [Contact](#contact)
- [License](#license)

Feature
-------

[](#feature)

- a single executable file, or with load class
- a method for a command.
- the input options are injected into the parameters of the function
- support variable annotation for description and shorcut
- the longname input are the same as the name of the function parameters
- validation of the required value
- also other verification such as the command name which does not exist
- compare the type of option input with the variables of the function parameters
- the possibility of optional chaining, example: -abc
- decoration the text output color, block and list
- list command lists all commands:
- help option display help for the given command.
- verbose level option, example : -v -vv -vvv
- command description, usage and help
- confirm and choice input
- generate command

Screenshot
----------

[](#screenshot)

[![EURL ARVODIA Logo](https://raw.githubusercontent.com/arvodia/src/main/img/arvodia-cli-screenshot.png)](https://raw.githubusercontent.com/arvodia/src/main/img/arvodia-cli-screenshot.png)

Installation
------------

[](#installation)

You can [download](https://github.com/arvodia/arvodia-cli/tree/main/bin "download") only the bin file and work with it, or integrate arvodia-cli into your project with composer.

```
composer require arvodia/arvodia-cli
mkdir -p src/Arvodia
cp -r vendor/arvodia/arvodia-cli/src/Arvodia/Command/ src/Arvodia/
ln -s ../vendor/arvodia/arvodia-cli/bin/terminal bin/app_name

```

to execute

```
php bin/app_name

```

Commands
--------

[](#commands)

Class Commands can be integrated directly in the `bin/terminal` file, if you want to use a single file for your executable.

You can also create PHP files in the `src/Arvodia/Command` folder, the files must be suffixed with Command, for example `NameCommand.php`, with a class of the same name as the file, the commands is automatically detected by arvodia-cli.

The class must also contain an `execute()` method, the options passed in the command line will be injected into the parameters of the `execute()` function. in the functions you must always start with the require parameter then optional.

Example
-------

[](#example)

```
class ExampleCommand extends ArvodiaCli {
    protected const DESCRIPTION = 'Example commands';
    protected const HELP = 'HELP commands text';
    /**
     *
     * @option(param=requise,short=r, message="the parameter requires a value")
     * @option(param=optionnel,short=o, message="parameter value is optional")
     */
    public function execute(string $requise, string $optionnel = 'hello')
	{
        $this->show($optionnel . ' ' . $requise . '!');
		$this->show('Verbosity levels is : ' . VERBOSE);
    }
}

```

Annotations
-----------

[](#annotations)

Annotations are optional, it serves to add a shortcut for your option and a description.

### Syntax

[](#syntax)

It must be placed in `@option()`, and it is necessary to declare the `param` that contains the name of the variable in the parameters of your `execute` method

Input Arguments
---------------

[](#input-arguments)

The name of the first argument to find is the name of the command to execute Note: it can be placed at the beginning or in the middle or at the end.

- A parameter without a default value (the parameter requires a value) // required value
    - Note: If a value is required, it doesn't matter which string it next assigns to it.
- A parameter with default value (the parameter value is optional)
    - Note: Optional values do not accept space as a separator.
- A parameter with type bool, boolean:
    - These options do not accept any value if there is a default value, it will just revert to true if it is found.
    - With required value, These options accept the values "1", "true", "on", "yes", "0", "false", "off" and "no"
    - Possible multiple short name with a default value, example -abc

Note: The script will stop when the first bad option is found.

Configuration
-------------

[](#configuration)

To customize the title of the console introduction, modify the `arvodia_cli_title` key in the `Command/config.json` file

### Booter

[](#booter)

in Command/config.json

```
{
    "arvodia_cli_title": "Your cli name",
    "cmd_loader": {
        "youcommendname": {
            "/laminas/laminas-config/src": "Config.php"
        }
    }
}

```

Git clone
---------

[](#git-clone)

```
$ git clone https://github.com/arvodia/arvodia-cli.git

```

Contact
-------

[](#contact)

 - EURL ARVODIA

License
-------

[](#license)

GNU General Public License v3.0

###  Health Score

24

—

LowBetter than 31% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~89 days

Total

5

Last Release

1525d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/34461222?v=4)[Redouane](/maintainers/arvodia)[@arvodia](https://github.com/arvodia)

---

Top Contributors

[![arvodia](https://avatars.githubusercontent.com/u/34461222?v=4)](https://github.com/arvodia "arvodia (44 commits)")

---

Tags

annotationscommand-linecommand-line-toolphpphp-cli

### Embed Badge

![Health badge](/badges/arvodia-arvodia-cli/health.svg)

```
[![Health](https://phpackages.com/badges/arvodia-arvodia-cli/health.svg)](https://phpackages.com/packages/arvodia-arvodia-cli)
```

###  Alternatives

[illuminate/console

The Illuminate Console package.

13046.0M6.4k](/packages/illuminate-console)[styleci/cli

The CLI tool for StyleCI

71470.5k9](/packages/styleci-cli)[winbox/args

Windows command-line formatter

20720.9k21](/packages/winbox-args)[tomatophp/filament-artisan

Simple but yet powerful library for running some artisan commands for FilamentPHP

3275.4k1](/packages/tomatophp-filament-artisan)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)