potherca/cli2web

Automated web UI for any CLI command

v0.6.1 2019-09-08 11:17 UTC

Requires

• php: ^5.6 | ^7.0
• hassankhan/config: ^2.0
• mustache/mustache: ^2.12
• vlucas/phpdotenv: ^3.0

GPL-3.0-or-later

• Ben Peachey

README

Introduction

The aim of this project is to make it trivial to expose a shell script("command-line script" or "CLI script") as a web application.

This library offers conversion, logic and templates to gather user input, feed it to a shell script and render the output in the browser.

All that has to be provided is a shell script and configuration. Optionally logic can be added to compliment the input, output or render process.

Requirements

• As this is a web application, it is assumed a web-server is available.
• This project is written in PHP. Any actively support version is fine.

Installation

Installation is done using composer:

composer require potherca/cli2web

As this is a web application, it is assumed a web-server is available.

Usage

• Create an index file in a public facing directory in the web-server
• Include the cli2web engine
• Feed the engine a configuration
• Done.

For more advanced scenario's any of the following steps can also be taken:

• Add logic that is called with the user input
  (instead of the CLI script being called directly)
• Add logic that is called with the shell script output
  (instead of the output being displayed directly, "raw", as-is)
• Add custom UI to display the returned output (instead of the output being displayed as plain-text)

License