CLI_Command::info() │ public │ WP-CLI 1.0

Prints various details about the WP-CLI environment.

Helpful for diagnostic purposes, this command shares:

• OS information.
• Shell information.
• PHP binary used.
• PHP binary version.
• php.ini configuration file used (which is typically different than web).
• WP-CLI root dir: where WP-CLI is installed (if non-Phar install).
• WP-CLI global config: where the global config YAML file is located.
• WP-CLI project config: where the project config YAML file is located.
• WP-CLI version: currently installed version.

See config docs for more details on global and project config YAML files.

OPTIONS

[--format=<format>]

Render output in a particular format.
--- default: list options:

• list
• json

EXAMPLES

# Display various data about the CLI environment.
$ wp cli info
OS:  Linux 4.10.0-42-generic #46~16.04.1-Ubuntu SMP Mon Dec 4 15:57:59 UTC 2017 x86_64
Shell:   /usr/bin/zsh
PHP binary:  /usr/bin/php
PHP version: 7.1.12-1+ubuntu16.04.1+deb.sury.org+1
php.ini used:    /etc/php/7.1/cli/php.ini
WP-CLI root dir:    phar://wp-cli.phar
WP-CLI packages dir:    /home/person/.wp-cli/packages/
WP-CLI global config:
WP-CLI project config:
WP-CLI version: 1.5.0

Method of the class: CLI_Command{}

No Hooks.

Return

null. Nothing (null).

Usage

$CLI_Command = new CLI_Command();
$CLI_Command->info( $_, $assoc_args );

$_ (required)

-

$assoc_args (required)

-

CLI_Command::info() CLI Command::info code ^{WP-CLI 2.8.0-alpha}

public function info( $_, $assoc_args ) {
	// php_uname() $mode argument was only added with PHP 7.0+. Fall back to
	// entire string for older versions.
	$system_os = PHP_MAJOR_VERSION < 7
		? php_uname()
		: sprintf(
			'%s %s %s %s',
			php_uname( 's' ),
			php_uname( 'r' ),
			php_uname( 'v' ),
			php_uname( 'm' )
		);

	$shell = getenv( 'SHELL' );
	if ( ! $shell && Utils\is_windows() ) {
		$shell = getenv( 'ComSpec' );
	}

	$php_bin = Utils\get_php_binary();

	$runner = WP_CLI::get_runner();

	$packages_dir = $runner->get_packages_dir_path();
	if ( ! is_dir( $packages_dir ) ) {
		$packages_dir = null;
	}

	if ( Utils\get_flag_value( $assoc_args, 'format' ) === 'json' ) {
		$info = [
			'system_os'                => $system_os,
			'shell'                    => $shell,
			'php_binary_path'          => $php_bin,
			'php_version'              => PHP_VERSION,
			'php_ini_used'             => get_cfg_var( 'cfg_file_path' ),
			'mysql_binary_path'        => Utils\get_mysql_binary_path(),
			'mysql_version'            => Utils\get_mysql_version(),
			'sql_modes'                => Utils\get_sql_modes(),
			'wp_cli_dir_path'          => WP_CLI_ROOT,
			'wp_cli_vendor_path'       => WP_CLI_VENDOR_DIR,
			'wp_cli_phar_path'         => defined( 'WP_CLI_PHAR_PATH' ) ? WP_CLI_PHAR_PATH : '',
			'wp_cli_packages_dir_path' => $packages_dir,
			'wp_cli_cache_dir_path'    => Utils\get_cache_dir(),
			'global_config_path'       => $runner->global_config_path,
			'project_config_path'      => $runner->project_config_path,
			'wp_cli_version'           => WP_CLI_VERSION,
		];

		WP_CLI::line( json_encode( $info ) );
	} else {
		WP_CLI::line( "OS:\t" . $system_os );
		WP_CLI::line( "Shell:\t" . $shell );
		WP_CLI::line( "PHP binary:\t" . $php_bin );
		WP_CLI::line( "PHP version:\t" . PHP_VERSION );
		WP_CLI::line( "php.ini used:\t" . get_cfg_var( 'cfg_file_path' ) );
		WP_CLI::line( "MySQL binary:\t" . Utils\get_mysql_binary_path() );
		WP_CLI::line( "MySQL version:\t" . Utils\get_mysql_version() );
		WP_CLI::line( "SQL modes:\t" . implode( ',', Utils\get_sql_modes() ) );
		WP_CLI::line( "WP-CLI root dir:\t" . WP_CLI_ROOT );
		WP_CLI::line( "WP-CLI vendor dir:\t" . WP_CLI_VENDOR_DIR );
		WP_CLI::line( "WP_CLI phar path:\t" . ( defined( 'WP_CLI_PHAR_PATH' ) ? WP_CLI_PHAR_PATH : '' ) );
		WP_CLI::line( "WP-CLI packages dir:\t" . $packages_dir );
		WP_CLI::line( "WP-CLI cache dir:\t" . Utils\get_cache_dir() );
		WP_CLI::line( "WP-CLI global config:\t" . $runner->global_config_path );
		WP_CLI::line( "WP-CLI project config:\t" . $runner->project_config_path );
		WP_CLI::line( "WP-CLI version:\t" . WP_CLI_VERSION );
	}
}