PHP's best friend for the terminal.

I'm using ANSICON (because default terminal don't support ANSI escape codes, in fact ANSICON don't do it well too) on Win8x64, CLImate just renders new line each time it increments, without erasing old one.

So it looks like this:

>
=>
==>
===>
====>
=====>
======>
=======>
========>
=========>
==========>
===========>
============>
=============>
==============>
===============>
================>
=================>
==================>
===================>
====================>
=====================>
======================>
=======================>
========================>
=========================>
==========================>
===========================>
============================>
=============================>
==============================>
===============================>
================================>
=================================>
==================================>
===================================>
====================================>
                         n%

Well, i know that it's a Windows problem, but look at Composer, it renders progress bar fine even on Windows ;)

Hi.

I can't get past tis error message. Can't find anything online regarding this for CLImate either. How can I get past this?

Here's what I did: I went to my project's folder and ran composer require league/climate. After that, I copied-pasted the code under "Usage" in README.md here on GitHub and reloaded the page for my project.

require_once 'vendor/autoload.php';
$climate = new \League\CLImate\CLImate;

$climate->red('Whoa now this text is red.');
$climate->blue('Blue? Wow!');

Warning: Use of undefined constant STDOUT - assumed 'STDOUT' (this will throw an Error in a future version of PHP) in /var/www/html/website/vendor/league/climate/src/Util/System/Linux.php on line 90
Fatal error: Uncaught Error: Undefined constant 'STDOUT' in /var/www/html/website/vendor/league/climate/src/Util/Writer/StdOut.php:14 Stack trace: #0 /var/www/html/website/vendor/league/climate/src/Util/Output.php(183): League\CLImate\Util\Writer\StdOut->write() #1 /var/www/html/website/vendor/league/climate/src/TerminalObject/Router/BasicRouter.php(37): League\CLImate\Util\Output->write() #2 /var/www/html/website/vendor/league/climate/src/TerminalObject/Router/Router.php(99): League\CLImate\TerminalObject\Router\BasicRouter->execute() #3 /var/www/html/website/vendor/league/climate/src/CLImate.php(384): League\CLImate\TerminalObject\Router\Router->execute() #4 /var/www/html/website/vendor/league/climate/src/CLImate.php(399): League\CLImate\CLImate->buildTerminalObject() #5 /var/www/html/website/vendor/league/climate/src/CLImate.php(435): League\CLImate\CLImate->routeRemainingMethod() #6 /var/www/html/website/vendor/league/climate/src/CLImate.php(440): League\CLImate\CLImate->__call() #7 /va in /var/www/html/website/vendor/league/climate/src/Util/Writer/StdOut.php on line 14

I've been using CLImate at work lately. I love it, but I hated having to use getopt() or $argv to talk to my command line arguments. I looked into various console libraries, but they also did output in addition to argument processing. I saw in #29 you said you weren't opposed to CLImate doing argument parsing, so I added it. I tried to follow the existing API and internal code conventions as much as I can.

This change adds an argument manager to the CLImate object. Users can define arguments against the argument manager, parse arguments on the command line into those defined arguments, retrieve CLI argument values, and generate a usage statement based on user defined arguments.

An argument is defined as something that's passed along to a script, either in a short form ("-a foo"), long form ("--foo bar"), both, or neither to process arguments after the prefixed argument list. Arguments can be:

• marked as required
• have default values
• have their values cast to string, int, float, or boolean data types
• set true if they're defined on the command line (for cases where a value isn't needed like "-f" to force or "--help" to show a usage statement).
• have values set in "-key value" or "-key=value" form on the command line.

Arguments that are required but not defined on the command line generate an exception that's sent back to calling code.

Here's a simple example. Assume you have a script that pushes a local directory to some SSH server. That script needs a username, a password, a host, maybe an option to print usage, one to overwrite existing files, maybe a verbosity option, and a path to push to my server. I may store the username and hostname internally, but let users enter their own if they like, but they have to provide a password. I'd probably call it by running:

php ./pusher.php -u myusername -p secret -h hostname --force -v ./push_me

That script would look like:

<?php

require __DIR__ . '/vendor/autoload.php';

use League\CLImate\CLImate;

$climate = new CLImate;
$climate->description('Awesome SCP Pusher v0.01');
$climate->arguments->add([
    'user' => [
        'prefix' => 'u',
        'longPrefix' => 'user',
        'description' => 'SSH Username',
        'defaultValue' => 'myuser',
    ],
    'password' => [
        'prefix' => 'p',
        'longPrefix' => 'password',
        'description' => 'SSH Password',
        'required' => true,
    ],
    'host' => [
        'prefix' => 'H',
        'longPrefix' => 'host',
        'description' => 'SSH Hostname',
        'defaultValue' => 'myhost.local'
    ],
    'force' => [
        'prefix' => 'f',
        'longPrefix' => 'force',
        'description' => 'Overwrite files on copy',
        'definedOnly' => true,
    ],
    'verbose' => [
        'prefix' => 'v',
        'longPrefix' => 'verbose',
        'description' => 'Verbose output',
        'definedOnly' => true,
    ],
    'help' => [
        'prefix' => 'h',
        'longPrefix' => 'help',
        'description' => 'Print a usage statement',
        'definedOnly' => true,
    ],
    'path' => [
        'description' => 'The path to push',
    ],
]);

// Print a usage statement on --help
if ($climate->arguments->defined('help')) {
    $climate->usage();
    exit();
}

// Parse arguments.
try {
    $climate->arguments->parse();
} catch (Exception $e) {
    // Let us know if arguments were missing.
    $climate->error($e->getMessage());
    $climate->br();
    $climate->usage();
    exit();
}

// Echo instead of push.
$climate->out('Username: ' . $climate->arguments->get('user'));
$climate->out('Hostname: ' . $climate->arguments->get('host'));

if ($climate->arguments->get('force')) {
    $climate->out("I'm going to overwrite on copy.");
}

Here's an execution that echo's the usage statement:

$ php ./pusher.php -h
Awesome SCP Pusher v0.01

Usage: ./pusher.php [-f, --force] [-H host, --host host (default: myhost.local)] [-h, --help] [-p password, --password password] [-u user, --user user (default: myuser)] [-v, --verbose] [path]

Required Arguments:
    -p password, --password password
        SSH Password

Optional Arguments:
    -f, --force
        Overwrite files on copy
    -h, --help
        Print a usage statement
    -H host, --host host (default: myhost.local)
        SSH Hostname
    -u user, --user user (default: myuser)
        SSH Username
    -v, --verbose
        Verbose output

And an execution that spits out those debug out()s:

$ php ./pusher.php -u bob -p secret -f ./my-dir
Username: bob
Hostname: myhost.local
I'm going to overwrite on copy.

The new changes pass all tests with 100% new code coverage, minus one line that needs to talk to the global scope to get $argv. Tests use a mocked $argv.

Let me know if this looks okay to you. If it does and gets merged I can write public-facing documentation for this too.

Hi,

Great library!

Something has changed from 2.5 to 2.6 where colors are no longer being pushed to files. I have cronjob which outputs a lot of information to log files with a lot of color so I can easily see problems. 2.6 no longer appears to send the colors to the files when redirecting to a file.

Sometimes it can useful to pad content out to a particular length (requested in issue #14)

$padding = $climate->padding(50);
$padding->pad("Line one stuff");
$padding->pad("More stuff on line two");
$padding->pad("Final content on line three");

Will output:

Line one stuff....................................
More stuff on line two............................
Final content on line three.......................

If no width is passed to the padding method then the full terminal width is used. The length can also be specified using the length() method.

An alternative character can be specified with the padWidth() method, or as the second parameter to padding(). Multiple characters can also be used

$padding = $climate->padding(5, ".-");
$padding->pad("AAA");
$padding->pad("BB");
$padding->pad("CCCC");

Will output:

AAA-.-
BB.-.-
CCCC.-

Would you like me to submit a pull request for the documentation to explain all the features?

So, the next step is creating a package website for this project. To make this process a little easier, we've created a ready-made theme that's powered by Sculpin.

You can find the full instructions on how to set this up here. Since you have most of your documentation worked out already this should be pretty straightforward. However, being honest, the process can be a little confusing at first. Do your best, and hit me up if you have any questions!

Hi, I really like this little lib because of its minimalism, very quick to get up! Thank you very much!

However, after adding some functions to a small tool I need to start thinking about how to organize multiple levels of (mostly radiobutton) menus - do you have some hints or examples for how to handle this? Or is there any other library / extension / addon that helps with that? I really would like to make it a little bit more declarative, so menus could be defined with a config file with the option key as function name to execute when selected, but before I get lost I just wanted to ask if I could learn from someone who has solved that already...?

Thanks for your attention!

@joetannenbaum thanks for this great package. I use CLImate over at PHPloy. Lately I've run into an issue. I use this argument:

phploy --sync
phploy --sync="hash-goes-here"

The second command works fine, the first one causes this notice and fails:

PHP Notice:  Undefined offset: 1 in phar:///usr/local/bin/deploy/vendor/league/climate/src/Argument/Parser.php on line 195

Here is the implementation of the argument:

'sync' => [
    'longPrefix' => 'sync',
    'description' => 'Syncs revision to a given version',
    'defaultValue' => 'LAST',
]

What seems to be wrong? Is this a bug in the parser?

Thanks a lot, Baki

Hi When trying to use $climate->table($X); and the Array of (Associative Arrays) only contains 1 record you get the following error

PHP Fatal error: Uncaught TypeError: Argument 1 passed to League\CLImate\TerminalObject\Basic\Table::getDefaultColumnWidths() must be of the type array, integer given, called in /scripts/vendor/league/climate/src/TerminalObject/Basic/Table.php on line 206 and defined in /scripts/vendor/league/climate/src/TerminalObject/Basic/Table.php:224 Stack trace: #0 /scripts/vendor/league/climate/src/TerminalObject/Basic/Table.php(206): League\CLImate\TerminalObject\Basic\Table->getDefaultColumnWidths(6311133) #1 /scripts/vendor/league/climate/src/TerminalObject/Basic/Table.php(72): League\CLImate\TerminalObject\Basic\Table->getColumnWidths() #2 /scripts/vendor/league/climate/src/TerminalObject/Router/BasicRouter.php(28): League\CLImate\TerminalObject\Basic\Table->result() #3 /scripts/vendor/league/climate/src/TerminalObject/Router/Router.php(99): League\CLImate\TerminalObject\Router\BasicRouter->execute(Object(League\CLImate\TerminalObject\Basic\Table)) #4 /scripts/vendor/league/climate/src/CLImate.php(381): League\CLImate\TerminalObjec in /scripts/vendor/league/climate/src/TerminalObject/Basic/Table.php on line 224

https://github.com/thephpleague/climate/blob/4d3ddf97b6db22c76efe2340f603c0d9834ddf72/src/Util/System/Windows.php#L72

^ getenv() will never return true, this check should probably be !== false.

Inspired by #57 I created a simple Logger class that implements the PSR-3 LoggerInterface.

Including some of the other features from: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md

• Objects with __toString()
• Exceptions in context
• Placeholders in context

For long running progress bars, seeing it sit at 1% isn't exciting, so I added the ability to change the precision of the percentage.

Usage is straightforward:

$progress = $this->cli->progress(3);
$progress->precision(3);
$progress->current(1);

===>         33.333%

I tried to write a test, but I'm not well versed in unit-testing so this causes an error I'm not sure how to fix:

vendor/bin/phpunit --filter it_can_output_a_progress_bar_with_precision tests/ProgressTest.php
PHPUnit 9.5.27 by Sebastian Bergmann and contributors.

E                                                                   1 / 1 (100%)

Time: 00:00.015, Memory: 6.00 MB

There was 1 error:

=======================>                                                33.3%'). Either the method was unexpected or its arguments matched no expected argument list for this method
Mockery\Exception\NoMatchingExpectationException: No matching handler found for Mockery_2_League_CLImate_Util_Output::write('


/var/www/html/climate/vendor/mockery/mockery/library/Mockery/ExpectationDirector.php:92
/var/www/html/climate/src/TerminalObject/Dynamic/Progress.php:198
/var/www/html/climate/src/TerminalObject/Dynamic/Progress.php:125
/var/www/html/climate/tests/ProgressTest.php:104

ERRORS!
Tests: 1, Assertions: 0, Errors: 1.

https://github.com/thephpleague/climate/blob/a785a3ac8f584eed4abd45e4e16fe64c46659a28/src/CLImate.php#L143

There is no encapsulation also property is public.

I've been getting these intermittently and haven't been able to figure out why yet. Any ideas?

fwrite(): Write of 1 bytes failed with errno=32 Broken pipe {"exception":"[object] (ErrorException(code: 0): fwrite(): Write of 1 bytes failed with errno=32 Broken pipe at /var/www/REMOVED/vendor/league/climate/src/Util/Writer/StdOut.php:14)

It would be useful to be able to retrieve the current & total values from a progress bar.

My use case is that I define the progress bar in one method in a class, then use it in other methods. I'd like my label to be updated with the count, ie (23/1176) without having to track those numbers separately.

I'm happy to do this & submit a PR, but I wonder if this package is actively maintained?

Hello,

I am using climate with PHP8.1, and I have this log : PHP Deprecated: strlen(): Passing null to parameter #1 ($string) of type string is deprecated in /Users/Toto/Sites/Sandbox/vendor/league/climate/src/TerminalObject/Basic/BasicTerminalObject.php on line 21

To fix this warning message, I just add this $value && strlen($value) in https://github.com/thephpleague/climate/blob/637555fdf6285c8077297f326760d9d8a5112f28/src/TerminalObject/Basic/BasicTerminalObject.php#L21

protected function set($key, $value)
{
    if ($value && strlen($value)) {
        $this->$key = $value;
    }
}

Is it possible to include this fix in the next release ?

Best