minimal-pba-cli 0.0.4

A minimal command-line interface using plugin-based architecture

Minimal command-line interface using a plugin-based architecture

This project demonstrates a minimal (but featureful) command-line interface (CLI) using a plugin-based architecture (PBA). The CLI itself is constructed using Typer.

The PBA is achieved using a combination of:

• pipx
• importlib
• packaging
• Libraries.io

For a working plugin example, see minimal-pba-cli-plugin-example.

Installation

Install the core CLI using the following command:

$ pipx install minimal-pba-cli

Usage

List available commands using the help:

$ pba-cli --help

Plugins

List available plugins using the following command (requires a Libraries.io API key):

LIBRARIES_IO_API_KEY=<your API key> pba-cli plugin catalog

Install a plugin using the following command:

$ pba-cli plugin install <plugin name>

List installed plugins using the following command:

$ pba-cli plugin list

Install a plugin from a local directory using the following command:

$ pba-cli plugin install-local <path to plugin directory>

Uninstall a plugin using the following command:

$ pba-cli plugin uninstall <plugin name>