Flight Runway

https://github.com/flightphp/runway
Admin
Flight Runway is a console app for managing Flight projects, built on adhocore/php-cli libraries.
Tokens:15,259
Snippets:137
Trust Score:8.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Failure example for config:get

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-get-command.md

Failure example showing the output when the requested config key does not exist. The command prints 'Config key not found: database.port' and exits with code 1.

```bash
$ vendor/bin/runway config:get database.port
Config key not found: database.port
$ echo $?
1
```

--------------------------------

### Install Runway and show help

Source: https://github.com/flightphp/runway/blob/master/_autodocs/README.md

Install the Runway console application via Composer and verify the installation by displaying its help output. The vendor/bin/runway executable is the entry point.

```bash
composer require flightphp/runway
vendor/bin/runway --help
```

--------------------------------

### CLI usage examples for config:get

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-get-command.md

Example CLI invocations of the config:get command: reading a nested value with dot notation and reading the whole config as pretty JSON.

```bash
# Read a nested value
vendor/bin/runway config:get database.host

# Read the whole config (pretty JSON)
vendor/bin/runway config:get
```

--------------------------------

### config:set usage examples

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-set-command.md

Command-line examples for setting configuration values. Shows scalar, JSON, backup, and plain-text usage. The `--backup` flag backs up the file before editing.

```bash
# String / scalar
vendor/bin/runway config:set cache.enabled true

# Nested key with JSON value
vendor/bin/runway config:set database.host '{"host":"127.0.0.1"}'

# Backup the file before editing
vendor/bin/runway config:set --backup database.port 3306

# Plain-text value (falls back to treating it as a string)
vendor/bin/runway config:set app.name 'My App'
```

--------------------------------

### Command registration and usage for config:get

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-get-command.md

Registers the command as config:get, declares an optional argument [key] with dot notation, and sets usage text showing two example invocations.

```php
$this
    ->argument('[key]', 'Config key (dot notation: database.host)')
    ->usage(
        '<bold>  runway config:get database.host</end>' . PHP_EOL .
        '<bold>  runway config:get</end>' . PHP_EOL
    );
```

--------------------------------

### Runway CLI usage examples

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/runway-cli.md

Example commands for listing commands, showing help for a single command, running a command in the discovered project root, and forcing a specific project root using the RUNWAY_ROOT environment variable.

```bash
# Show every registered command
vendor/bin/runway --help

# Show options for a single command
vendor/bin/runway config:get --help

# Run a command in the discovered project root
vendor/bin/runway config:get database.host

# Force a specific project root
RUNWAY_ROOT=/srv/www/my-project vendor/bin/runway config:get
```

--------------------------------

### CLI usage examples: config:migrate with -c and --config-file

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-migrate-command.md

Shows the command with the short `-c` option and the long `--config-file` option.

```bash
# Migrate the project's runway settings into config.php
vendor/bin/runway config:migrate -c .runway-config.json

# Long option form
vendor/bin/runway config:migrate --config-file /srv/app/.runway-config.json
```

--------------------------------

### Failure examples for config:migrate

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-migrate-command.md

Demonstrates error messages when the config file path is missing or the file does not exist.

```bash
$ vendor/bin/runway config:migrate
Please provide the path to the runway config file using the --config-file option.
$ vendor/bin/runway config:migrate -c missing.json
The specified config file does not exist: missing.json
```

--------------------------------

### config:set failure example

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-set-command.md

Example of a failed `config:set` command with invalid JSON. Shows the error message and exit code 1.

```bash
$ vendor/bin/runway config:set database.host '{broken json'
Invalid JSON: Syntax error
Failed to update config: database.host
$ echo $?
1
```

--------------------------------

### Name/Description/Help Setters and Getters

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Provides methods to set and get the command name, description, and help text.

```APIDOC
## Name/Description/Help Setters and Getters

### Description
Provides methods to set and get the command name, description, and help text.

### Methods
- `public function setName(string $name): self`
- `public function setDescription(string $description): self`
- `public function getName(): string`
- `public function getDescription(): string`
- `public function setHelp(string $help): self`
- `public function getHelp(): ?string`

### Notes
`setHelp()` writes to the inherited `_usage` property; `getHelp()` returns `_usage` or `null`.
```

--------------------------------

### Install Runway via Composer

Source: https://github.com/flightphp/runway/blob/master/README.md

Install Runway using Composer. Requires PHP 8.2+ for v1.0; for PHP 7.4, 8.0, and 8.1, use version 0.2.3 and forward.

```bash
composer require flightphp/runway
```

--------------------------------

### Direct usage of ConfigGetCommand

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-get-command.md

Example of directly using the ConfigGetCommand class in application code. Instantiates with the config array and calls execute with a dot-notation key, printing the value and returning 0.

```php
// Direct usage of the class in application code
use flight\commands\ConfigGetCommand;

$command = new ConfigGetCommand($config);
$command->execute('database.host'); // prints the value, returns 0
```

--------------------------------

### addOption usage examples

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Examples of using addOption for flag, required-value, and array-valued options. The mode-dependent defaults are: VALUE_NONE makes the default false, VALUE_IS_ARRAY makes the default an array.

```php
// Flag option: processor.workers is a boolean flag
$this->addOption('verbose', 'v', self::VALUE_NONE, 'Verbose output');
// Required-value option
$this->addOption('host', null, self::VALUE_REQUIRED, 'Database host', 'localhost');
// Array-valued option
$this->addOption('tag', 't', self::VALUE_OPTIONAL | self::VALUE_IS_ARRAY, 'Filter tags');
```

--------------------------------

### Direct usage of ConfigSetCommand

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-set-command.md

Example of directly using the ConfigSetCommand class from application code. It creates a new instance, calls setConfigJson with a JSON path, key, and value, and checks the exit code. On failure (exit 1), the command has already printed the error to stderr.

```php
// Direct usage from application code
use flight\commands\ConfigSetCommand;

$command = new ConfigSetCommand($config);
$exit = $command->setConfigJson('/path/to/.runway-config.json', 'database.port', '3306');
// $exit === 0 on success
if ($exit === 1) {
    // command already printed the error to stderr
}
```

--------------------------------

### Register config:set command arguments and usage

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-set-command.md

Registers the config:set command with two required arguments (<key> and <value>) and one option (-b --backup). The usage examples show how to set a nested config value with JSON and a simple boolean.

```php
$this
    ->argument('<key>', 'Config key (dot notation: database.host)')
    ->argument('<value>', 'JSON-encoded value')
    ->option('-b --backup', 'Backup the config file before updating')
    ->usage(
        '<bold>  runway config:set database.host \'{"host":"127.0.0.1"}\'</end>' . PHP_EOL .
        '<bold>  runway config:set cache.enabled true</end>' . PHP_EOL
    );
```

--------------------------------

### Define config file paths

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/runway-cli.md

Defines the paths for the PHP config file and the JSON dotfile. Used at the start of the configuration loading phase.

```php
$appConfigPath = $projectRoot . '/app/config/config.php';
$dotRunwayPath = $projectRoot . '/.runway-config.json';
```

--------------------------------

### addArgument usage example

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Example of using addArgument with a required argument. The raw format for REQUIRED is <name>.

```php
$this->addArgument('key', self::REQUIRED, 'Config key (dot notation: database.host)');
```

--------------------------------

### Custom command using getRunwayConfigValue and setRunwayConfigValue

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Example of a custom command extending AbstractBaseCommand that reads and writes Runway configuration values using the protected helpers. The command defines a 'deploy' command with a required 'target' argument and returns 0 on success.

```php
namespace MyApp\commands;

use flight\commands\AbstractBaseCommand;

class DeployCommand extends AbstractBaseCommand
{
    public function __construct(array $config)
    {
        parent::__construct('deploy', 'Deploy the application', $config);
        $this->addArgument('target', self::REQUIRED, 'Deploy target');
    }

    public function execute($target = '')
    {
        $endpoint = $this->getRunwayConfigValue('deploy.endpoint');
        // $endpoint is null if unset

        $this->setRunwayConfigValue('deploy.last_target', $target);
        return 0;
    }
}
```

--------------------------------

### Class declaration for ConfigGetCommand

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-get-command.md

Declares the ConfigGetCommand class, extending AbstractBaseCommand. This is the class that implements the config:get command.

```php
class ConfigGetCommand extends AbstractBaseCommand
```

--------------------------------

### Autoload bootstrap

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/runway-cli.md

Resolves the Composer autoloader by checking three candidate paths in order, requiring the first that exists. When installed as a dependency, the first candidate resolves to the project's vendor/autoload.php.

```php
foreach ([__DIR__ . '/../../autoload.php', __DIR__ . '/../vendor/autoload.php', __DIR__ . '/vendor/autoload.php'] as $file) {
	if (file_exists($file) === true) {
		require($file);
		break;
	}
}
```

--------------------------------

### Set RUNWAY_ROOT environment variable

Source: https://github.com/flightphp/runway/blob/master/_autodocs/configuration.md

Sets the RUNWAY_ROOT environment variable to an absolute path, overriding the project root discovery. When set, it is the only starting point for root discovery, bypassing CWD and script dir.

```bash
RUNWAY_ROOT=/srv/www/my-flight-app vendor/bin/runway config:get
```

--------------------------------

### Show Runway help

Source: https://github.com/flightphp/runway/blob/master/README.md

Run this command to display all available Runway commands. The output lists every command you can run with Runway.

```bash
vendor/bin/runway --help
```

--------------------------------

### Execute method: execute()

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-migrate-command.md

Main execution method. Orchestrates reading the config file, validating, decoding, merging, and persisting. No return value; prints success or error messages.

```php
public function execute()
```

--------------------------------

### Name/description/help setters and getters signatures

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Signatures for the name, description, and help setters and getters. setHelp() writes to the inherited _usage property; getHelp() returns _usage or null.

```php
public function setName(string $name): self
public function setDescription(string $description): self
public function getName(): string
public function getDescription(): string
public function setHelp(string $help): self
public function getHelp(): ?string
```

--------------------------------

### Constructor: __construct(array $config)

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-migrate-command.md

Constructor that takes the configuration array. Registers the `config:migrate` command and its `-c, --config-file` option.

```php
public function __construct(array $config)
```

--------------------------------

### getApplication

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Returns the underlying `Ahc\Cli\Application` instance.

```APIDOC
## getApplication

### Description
Returns the underlying `Ahc\Cli\Application` instance.

### Method
getApplication

### Signature
```php
public function getApplication()
```

### Returns
- `null|\Ahc\Cli\Application` - The underlying application instance.
```

--------------------------------

### Application construction

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/runway-cli.md

Constructs the Ahc\Cli application with name 'runway' and version '1.2.4', and retrieves its IO instance. These values appear in --help and --version output.

```php
$consoleApp = new Ahc\Cli\Application('runway', '1.2.4');
$io = $consoleApp->io();
```

--------------------------------

### AbstractBaseCommand constructor signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Constructor signature for AbstractBaseCommand. Stores the merged runway configuration in $this->config and sets $this->projectRoot from the PROJECT_ROOT constant if defined, otherwise from getcwd(). Note that the bin script defines RUNWAY_PROJECT_ROOT, so getcwd() is used in the shipped flow.

```php
public function __construct(string $name, string $description, array $config)
```

--------------------------------

### Dispatch the console application with argv

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/runway-cli.md

Shows the core dispatch call: reads the argv from the server and passes it to the console application's handle() method. This is the entry point for processing a CLI request.

```php
$argv = (array) $_SERVER['argv'];
$consoleApp->handle($argv);
```

--------------------------------

### Command discovery glob patterns and configuration

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/runway-cli.md

Defines the root, base, and final path patterns used to locate command files. The final paths can be extended via configuration, and the app_root config adds an additional pattern. The search list is the cartesian product of these paths, plus any user-supplied paths.

```php
$rootPaths = [$cwd, __DIR__];                                   // + config: root_paths
$basePaths = ['', '/**', '/**/**', '/**/**/**', '/**/**/**/**']; // + config: base_paths
$finalPaths = [
    '/src/commands/*.php',
    '/flight/commands/*.php',
    '/commands/*.php',
];                                                              // + config: final_paths
// if runwayConfig['app_root'] is set:
//   $finalPaths[] = '/' . $app_root . 'commands/*.php';
// + config: paths (appended after all cross-products)
```

--------------------------------

### Class declaration: ConfigMigrateCommand extends AbstractBaseCommand

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-migrate-command.md

Declares the command class for the `config:migrate` command.

```php
class ConfigMigrateCommand extends AbstractBaseCommand
```

--------------------------------

### Show help for a specific Runway command

Source: https://github.com/flightphp/runway/blob/master/README.md

Use this command to see options for a specific command, such as 'routes'. The --help or -h flag can be added to any command to view its options.

```bash
vendor/bin/runway routes --help
```

--------------------------------

### Option definition: -c --config-file path

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-migrate-command.md

Registers the `-c` and `--config-file` option that takes a path value. This option is required to proceed; without it, an error message is printed.

```php
$this->option('-c --config-file path', 'Path to the runway config file');
```

--------------------------------

### Magic property documentation for $backup

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-set-command.md

Documents a magic property $backup that is populated by the -b --backup option defined in the constructor.

```php
/**
 * @property-read bool $backup
 */
```

--------------------------------

### Execute method signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-get-command.md

Execute method signature for ConfigGetCommand. Accepts an optional dot-notation key and returns an integer exit code.

```php
public function execute($key = null)
```

--------------------------------

### Persist wizard result via config:set

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/runway-cli.md

Encodes the wizard's chosen index_root and app_root as JSON and passes them to the config:set command. Uses JSON_PRETTY_PRINT and JSON_UNESCAPED_SLASHES flags.

```php
$json = json_encode([
    'index_root' => $index_location,
    'app_root' => $app_location
], JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);

$consoleApp->handle([$projectRoot . 'runway', 'config:set', 'runway', $json]);
```

--------------------------------

### Interact method: interact(Interactor $io)

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-migrate-command.md

No-op method; does not perform any pre-execute interaction.

```php
public function interact(Interactor $io): void
```

--------------------------------

### Project-root discovery result

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/runway-cli.md

Changes the working directory to the discovered project root and defines RUNWAY_PROJECT_ROOT as its absolute path. Relative file operations in commands resolve against this root.

```php
$cwd = $projectRoot;
chdir($cwd);
define('RUNWAY_PROJECT_ROOT', $cwd);
```

--------------------------------

### setConfig method signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-set-command.md

Signature of the protected method that writes into a PHP app/config/config.php file. Returns 0 on success, 1 on failure. The method performs several steps: checks file existence, includes the file, parses the value, deep-merges via dot notation, optionally backs up, reads the file, locates the return block, detects indentation, and writes back.

```php
protected function setConfig(string $configPath, string $key, $value = ''): int
```

--------------------------------

### getApplication method signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Signature for the getApplication method, a Symfony-style shim returning the underlying Ahc\Cli\Application instance.

```php
public function getApplication()
```

--------------------------------

### Merge runway config

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-migrate-command.md

Initializes the `runway` key in a fresh local array and merges the existing in-memory config with the decoded JSON file, the JSON file taking precedence.

```php
$config['runway'] = $this->config['runway'] ?? [];
$config['runway'] = array_merge($config['runway'], $runwayConfig);
```

--------------------------------

### execute method signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-set-command.md

The `execute` method signature for the `config:set` command. It accepts a dot-notation key and an optional value, which is parsed as JSON when possible.

```php
public function execute($key, $value = '')
```

--------------------------------

### addOption

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Adds a Symfony-style option to the command, mapping to Ahc\Cli's `option()` method. Supports flags, required values, and array values.

```APIDOC
## addOption

### Description
Adds a Symfony-style option to the command, mapping to Ahc\Cli's `option()` method. Supports flags, required values, and array values.

### Method
addOption

### Signature
```php
public function addOption(string $name, $shortcut = null, ?int $mode = null, string $description = '', $default = null): self
```

### Parameters
- **$name** (string) - Required - Long option name, no leading dashes (`--name`)
- **$shortcut** (string | string[] | null) - Optional - Short option char(s), no dashes; first array element is used
- **$mode** (?int) - Optional - One or more `VALUE_*` constants OR-ed together
- **$description** (string) - Optional - Help text
- **$default** (mixed) - Optional - Default value

### Mode-Dependent Default Behavior
- `$mode === null` → treated as `VALUE_OPTIONAL`.
- `$mode === VALUE_NONE` → flag without value; effective default becomes `$default ?? false`.
- `VALUE_IS_ARRAY` bit set → effective default becomes `$default ?? []`.

### Raw Option Format
Built as `"-s, --name"` (shortcut present) or `"--name"` (no shortcut).

### Example
```php
// Flag option: processor.workers is a boolean flag
$this->addOption('verbose', 'v', self::VALUE_NONE, 'Verbose output');
// Required-value option
$this->addOption('host', null, self::VALUE_REQUIRED, 'Database host', 'localhost');
// Array-valued option
$this->addOption('tag', 't', self::VALUE_OPTIONAL | self::VALUE_IS_ARRAY, 'Filter tags');
```
```

--------------------------------

### ConfigSetCommand class declaration

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-set-command.md

Declares the ConfigSetCommand class that extends AbstractBaseCommand. This is the class definition for the config:set command.

```php
class ConfigSetCommand extends AbstractBaseCommand
```

--------------------------------

### Decode JSON config file

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-migrate-command.md

Reads the config file specified by `--config-file` and decodes it as an associative array. Uses `Json::decode` from the framework's JSON utility. If the file is missing or invalid, it may work with an empty array.

```php
$runwayConfig = Json::decode(file_get_contents($configFile), true) ?? [];
```

--------------------------------

### getConfig method signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-get-command.md

Signature of the protected getConfig method. Reads a PHP config file that must return an array and prints the requested key or the whole array.

```php
protected function getConfig(string $configPath, ?string $key = null): int
```

--------------------------------

### Merge .runway-config.json over PHP config

Source: https://github.com/flightphp/runway/blob/master/_autodocs/configuration.md

Merges the contents of .runway-config.json over the 'runway' key from app/config/config.php. The JSON file takes precedence for reads.

```php
$config['runway'] = array_merge($config['runway'], $dotConfig);  // .runway-config.json wins
```

--------------------------------

### Value parsing logic in setConfig and setConfigJson

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-set-command.md

PHP code that normalizes the value for both writers. Converts 'true', 'false', 'null' to lowercase, attempts JSON parsing, and falls back to string for printable values. Returns 1 on invalid JSON.

```php
$valueLowered = strtolower($value);
if (in_array($valueLowered, ['true', 'false', 'null'])) {
    $value = $valueLowered;
}

// Parse JSON value, but silently let it fail
$decoded = json_decode($value, true);
if ((isset($value[0]) === true && ($value[0] === '{' || $value[0] === '[')) && json_last_error() !== JSON_ERROR_NONE) {
    $io->error("Invalid JSON: " . json_last_error_msg(), true);
    return 1;
} elseif (ctype_print($value) === true && json_last_error() !== JSON_ERROR_NONE) {
    // Fallback: treat as string
    $decoded = $value;
}
```

--------------------------------

### addOption method signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Signature for the addOption method, a Symfony-style option shim mapping to Ahc\Cli's option().

```php
public function addOption(string $name, $shortcut = null, ?int $mode = null, string $description = '', $default = null): self
```

--------------------------------

### setConfigJson method signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-set-command.md

Signature of the public method that writes into a JSON config file (used when app/config/config.php is absent). Returns 0 on success, 1 on failure. Unlike setConfig, this method is public. It reads and decodes the JSON, strips the 'runway.' key prefix, deep-merges, always backs up the file, encodes with JSON_PRETTY_PRINT and JSON_UNESCAPED_SLASHES, and writes.

```php
public function setConfigJson(string $jsonPath, string $key, $value = ''): int
```

--------------------------------

### AbstractBaseCommand class declaration

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Declares the abstract base class for all Runway commands, extending Ahc\Cli\Input\Command to inherit CLI plumbing such as option(), argument(), usage(), app(), io(), and dispatch helpers.

```php
abstract class AbstractBaseCommand extends \Ahc\Cli\Input\Command
```

--------------------------------

### addArgument

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Adds a Symfony-style argument to the command, mapping to Ahc\Cli's `argument()` method. Supports required, optional, and array arguments.

```APIDOC
## addArgument

### Description
Adds a Symfony-style argument to the command, mapping to Ahc\Cli's `argument()` method. Supports required, optional, and array arguments.

### Method
addArgument

### Signature
```php
public function addArgument(string $name, ?int $mode = null, string $description = '', $default = null): self
```

### Parameters
- **$name** (string) - Required - Argument name
- **$mode** (?int) - Optional - `REQUIRED`, `OPTIONAL`, `IS_ARRAY`, or `REQUIRED | IS_ARRAY`
- **$description** (string) - Optional - Help text
- **$default** (mixed) - Optional - Default value

### Raw-Format Mapping per Mode
- `REQUIRED` → `<name>`; `REQUIRED | IS_ARRAY` → `<name...>`
- `OPTIONAL` → `[name]`; `OPTIONAL | IS_ARRAY` → `[name...]`

### Example
```php
$this->addArgument('key', self::REQUIRED, 'Config key (dot notation: database.host)');
```
```

--------------------------------

### outputValue method signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-get-command.md

Signature of the protected outputValue method. Renders a decoded value to stdout, handling arrays, objects, booleans, null, and other types.

```php
protected function outputValue($value): int
```

--------------------------------

### getConfigJson method signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/config-get-command.md

Signature of the protected getConfigJson method. Same contract as getConfig but for a JSON file, using json_decode.

```php
protected function getConfigJson(string $jsonPath, ?string $key = null): int
```

--------------------------------

### addArgument method signature

Source: https://github.com/flightphp/runway/blob/master/_autodocs/api-reference/abstract-base-command.md

Signature for the addArgument method, a Symfony-style argument shim mapping to Ahc\Cli's argument().

```php
public function addArgument(string $name, ?int $mode = null, string $description = '', $default = null): self
```
Tokens:
Raw