An HCLI Connector that can be used to expose a REST API as a CLI, via hypertext command line interface (HCLI) semantics.
|pypi| |build status| |pyver| |huckle| |hc| |hg|
An HCLI Connector that can be used to expose a REST API as a 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
hcli-hc, a python package for an HCL (hc) that can act both as a gcode streamer (e.g. for OpenBuilds Blackbox controller v1.1g) and CNC interface. In other words, this HCLI acts in the same capacity as the OpenBuilds CONTROL software and OpenBuilds Interface CNC Touch hardware to help control a GRBL v1.1g controlled CNC. [5]
hcli-hai, a python package wrapper for an HCLI (hai) that can interact with LLMs via terminal input and output streams. [6]
[5] https://github.com/cometaj2/hcli_hc
[6] https://github.com/cometaj2/hcli_hai
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/), and an HCLI client such as Huckle (https://github.com/cometaj2/huckle). The following runs the default jsonf HCLI bundled with HCLI Core.
.. code-block:: console
pip install hcli-core
pip install gunicorn
pip install huckle
gunicorn --workers=5 --threads=2 -b 127.0.0.1:8000 "hcli_core:connector()"
Open a different shell window.
Setup the huckle env eval in your .bash_profile (or other bash configuration) to avoid having to execute eval everytime you want to invoke HCLIs by name (e.g. jsonf).
Note that no CLI is actually installed by Huckle. Huckle reads the HCLI semantics exposed by the API and ends up behaving like the CLI it targets.
.. code-block:: console
huckle cli install http://127.0.0.1:8000
eval $(huckle env)
jsonf help
If you want to load a sample HCLI other than the default sample application, you can try loading one of the other sample HCLIs developped independently of HCLI Core. For example, the hai HCLI (hypertext LLM command line chat application).
A folder path to any other 3rd party HCLI can be provided in the same way to the HCLI Connector, provided the 3rd party HCLI meets CLI interface (cli.py) and HCLI template (template.json) requirements:
.. code-block:: console
pip install hcli-hai
pip install hcli-core
pip install gunicorn
pip install huckle
gunicorn --workers=5 --threads=2 "hcli_core:connector(\"`hcli_hai path`\")"
Open a different shell window.
Setup the huckle env eval in your .bash_profile (or other bash configuration) to avoid having to execute eval everytime you want to invoke HCLIs by name (e.g. hg).
.. code-block:: console
huckle cli install http://127.0.0.1:8000
eval $(huckle env)
hg help
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.
.. |build status| image:: https://circleci.com/gh/cometaj2/hcli_core.svg?style=shield :target: https://circleci.com/gh/cometaj2/hcli_core .. |pypi| image:: https://img.shields.io/pypi/v/hcli-core?label=hcli-core :target: https://pypi.org/project/hcli-core .. |pyver| image:: https://img.shields.io/pypi/pyversions/hcli-core.svg :target: https://pypi.org/project/hcli-core .. |huckle| image:: https://img.shields.io/pypi/v/huckle?label=huckle :target: https://pypi.org/project/huckle .. |hc| image:: https://img.shields.io/pypi/v/hcli-hc?label=hcli-hc :target: https://pypi.org/project/hcli-hc .. |hg| image:: https://img.shields.io/pypi/v/hcli-hg?label=hcli-hai :target: https://pypi.org/project/hcli-hai
FAQs
An HCLI Connector that can be used to expose a REST API as a CLI, via hypertext command line interface (HCLI) semantics.
We found that hcli-core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.