A collection of functions relating to the command-line
Find a file
2019-05-09 04:48:02 +00:00
src/Cli Initial commit 2019-05-08 22:04:47 +10:00
.gitignore Initial commit 2019-05-08 22:04:47 +10:00
CHANGELOG.md Initial commit 2019-05-08 22:04:47 +10:00
composer.json Fixed usage information in README. Version bump to 1.0.1 2019-05-09 04:48:02 +00:00
CONTRIBUTING.md Initial commit 2019-05-08 22:04:47 +10:00
LICENCE Initial commit 2019-05-08 22:04:47 +10:00
README.md Fixed usage information in README. Version bump to 1.0.1 2019-05-09 04:48:02 +00:00

PHP Helpers: Command-line Functions

A collection of functions relating to the command-line

Installation

This library is installed via Composer. To install, use composer require pointybeard/helpers-functions-cli or add "pointybeard/helpers-functions-cli": "~1.0" to your composer.json file.

And run composer to update your dependencies:

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar update

Requirements

There are no particuar requirements for this library other than PHP 5.6 or greater.

To include all the PHP Helpers packages on your project, use composer require pointybeard/helpers or add "pointybeard/helpers": "~1.0" to your composer file.

Usage

This library is a collection convenience function for command-line tasks. They are included by the vendor autoloader automatically. The functions have a namespace of pointybeard\Helpers\Functions\Cli

The following functions are provided:

  • can_invoke_bash() : bool
  • is_su() : bool

Example usage:

<?php

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

use pointybeard\Helpers\Functions\Cli;

var_dump(Cli\can_invoke_bash());
// bool(true)

var_dump(Cli\is_su());
// bool(false)

Support

If you believe you have found a bug, please report it using the GitHub issue tracker, or better yet, fork the library and submit a pull request.

Contributing

We encourage you to contribute to this project. Please check out the Contributing documentation for guidelines about how to get involved.

License

"PHP Helpers: Command-line Functions" is released under the MIT License.