hcli-core 0.11.8

An HCLI connector that can be used to expose any CLI expressed through hypertext command line interface (HCLI) semantics.

An HCLI Connector that can be used to expose a REST API with a built-in CLI, via hypertext command line interface (HCLI) semantics.

---

HCLI Core implements an HCLI Connector, a type of Service Connector, as a WSGI application and provides a way for developers to expose a service hosted CLI, as a REST API, via HCLI semantics. Such an API exposes a “built-in” CLI that can be interacted with dynamically with any HCLI client. Up to date, in-band, man page style API/CLI documentation is readily available for use to help understand how to interact with the API.

Most, if not all, programming languages have a way to issue shell commands. With the help of a generic HCLI client, such as Huckle [1], APIs that make use of HCLI semantics are readily consumable anywhere via the familiar command line (CLI) mode of operation, and this, without there being a need to write a custom and dedicated CLI to interact with a specific HCLI API.

You can find out more about HCLI on hcli.io [2]

The HCLI Internet-Draft [3] is a work in progress by the author and the current implementation leverages hal+json alongside a static form of ALPS (semantic profile) [4] to help enable widespread cross media-type support.

Help shape HCLI and it’s ecosystem by raising issues on github!

[1] https://github.com/cometaj2/huckle

[2] http://hcli.io

[3] https://github.com/cometaj2/I-D/tree/master/hcli

[4] http://alps.io

Installation

hcli_core requires a supported version of Python and pip.

You’ll need an WSGI compliant application server to run hcli_core. For example, you can use Green Unicorn (https://gunicorn.org/)

pip install gunicorn

Install hcli_core via pip. You can launch gunicorn from anywhere by using “hcli_core path”. You can also look at the hcli_core help file.

You can curl your new service to understand what is being exposed. The HCLI root URL, to use with an HCLI client, is the cli link relation.

Install an HCLI client, for example Huckle (https://github.com/cometaj2/huckle), and access the sample CLI (e.g. jsonf or hg) exposed by HCLI Core. You may need to restart your terminal to be able to use the sample CLI by name directly (e.g. jsonf or hg); otherwise you can attempt to source ~/.bash_profile or ~/.bashrc).

Note that no CLI is actually installed by huckle. Huckle reads the HCLI semantics dynamically and ends up behaving like the CLI it targets:

pip install hcli_core

hcli_core help

gunicorn --workers=5 --threads=2 -b 127.0.0.1:8000 --chdir `hcli_core path` "hcli_core:connector()"

curl http://127.0.0.1:8000

pip install huckle

huckle help

huckle cli install http://127.0.0.1:8000

jsonf help

If you want to load a sample HCLI other than the default sample application, you can try loading one of the sample HCLIs, for example, hg HCLI (hypertext GPT-3.5 chatbot).

A folder path to any other 3rd party HCLI can be provided in the same way provided they meet CLI interface (cli.py) and HCLI template (template.json) requirements:

gunicorn --workers=5 --threads=2 --chdir `hcli_core path` "hcli_core:connector(\"`hcli_core sample hg`\")"

huckle cli install http://127.0.0.1:8000

hg help

Versioning

This project makes use of semantic versioning (http://semver.org) and may make use of the “devx”, “prealphax”, “alphax” “betax”, and “rcx” extensions where x is a number (e.g. 0.3.0-prealpha1) on github. Only full major.minor.patch releases will be pushed to pip from now on.

Supports

• Supports HTTP/HTTPS

• HCLI version 1.0 server semantics for:

  • hal+json

• Streaming (application/octet-stream).

• Supports the Web Server Gateway Interface (WSGI) through PEP 3333 and Falcon. HCLI Core is deployable on any WSGI compliant web server (e.g. gunicorn).

• Exposing, via HCLI template, any HCLI as a usable client-side shell CLI.

• Bundled Sample HCLIs:

  • jsonf - a simple formatter for JSON.

  • hg - an HCLI for interacting with GPT-3.5-Turbo via terminal input and output streams.

  • hfm - a file upload and download manager that works with *nix terminal shell input and output streams.

  • hptt - a rudimentary HCLI Push To Talk (PTT) channel management service.

  • hub - a rudimentary HCLI service discovery hub.

  • nw - a flexible IP Address Management (IPAM) service.

• Support for use of any 3rd party HCLI code that meets CLI interface requirements and HCLI template requirements (i.e. see sample HCLIs).

• Support large input and output streams as application/octet-stream

To Do

• Automated tests for all bundled HCLI sample CLIs

• A memory layer for the GPT-3.5-Turbo HCLI sample CLI

  • Automatic context switching per NLP on received input stream.

  • Context blending to mary different contexts.

  • Automatic context compression to yield a more substantial memory footprint per context window.

• Separate out HCLI applications from HCLI Core to help avoid application dependencies bleeding onto HCLI Core (e.g. OpenAI).

Bugs

• No good handling of control over request and response in cli code which can lead to exceptions and empty response client side.

• The hfm sample HCLI fails disgracefully when copying a remote file name that doesn’t exist (server error).