Add support for custom scripts found on PATH

Author: daneah

CHANGELOG.md

@@ -7,7 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-## [0.0.3] - 2025-05-09
+## [0.0.4] - 2025-04-10
+
+### Added
+
+- Support for custom scripts found on PATH
+
+## [0.0.3] - 2025-04-09
 
 ### Added
 

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 requires-python = ">=3.9"
 name = "minimal-pba-cli"
-version = "0.0.3"
+version = "0.0.4"
 description = "A minimal command-line interface using plugin-based architecture"
 authors = [
     { name = "Dane Hillard", email = "github@danehillard.com" }
@@ -21,8 +21,9 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "License :: OSI Approved :: MIT License",
 ]
+license = "MIT"
+dynamic = ["readme"]
 dependencies = [
     "packaging>=24.2",
     "requests>=2.32.3",

src/minimal_pba_cli/cli.py

@@ -9,6 +9,7 @@
 
 from minimal_pba_cli.upgrade import upgrade
 from minimal_pba_cli.plugin import plugin, find_plugins
+from minimal_pba_cli.customization import list_available_commands, create_command_wrapper
 
 
 app = typer.Typer()
@@ -31,6 +32,8 @@ def main():
     _register_plugins(app)
     app.add_typer(plugin, name="plugin", help="Manage plugins.")
     app.command()(upgrade)
+    for command, full_path in list_available_commands():
+        create_command_wrapper(app, command, full_path)
     app()
 
 

src/minimal_pba_cli/customization.py

@@ -0,0 +1,48 @@
+import contextlib
+import errno
+import os
+import sys
+from pathlib import Path
+
+import typer
+
+
+def list_available_commands(prefix: str = "minimal-pba-cli-") -> list[tuple[str, str]]:
+    """List all commands available on the PATH that match an optional prefix."""
+    commands = []
+
+    for path_str in os.getenv("PATH", "").split(os.pathsep):
+        path = Path(path_str)
+
+        with contextlib.suppress(PermissionError):
+            if path.is_dir():
+                for file in path.iterdir():
+                    if file.is_dir():
+                        continue
+
+                    if os.access(file, os.X_OK) and file.name.startswith(prefix):
+                        commands.append((file.name, str(file)))
+    return sorted(set(commands))
+
+
+def create_command_wrapper(cli: typer.Typer, command: str, full_path: str):
+    cli_command_name = command.replace("minimal-pba-cli-", "")
+
+    def typer_wrapper_command():
+        commands = [command, *sys.argv[2:]]
+        command_string = " ".join(commands)
+        display = typer.style(command_string, fg=typer.colors.CYAN, bold=True)
+        typer.echo(f"Running {display}", err=True)
+
+        try:
+            os.execlp(command, *commands)
+        except OSError as e:
+            if e.errno == errno.ENOEXEC:
+                typer.secho(f"Command {command} found, but does not specify a handler. Try adding a shebang line to the file.", fg=typer.colors.RED, err=True)
+
+    typer_wrapper_command.__doc__ = f"({full_path}): Custom command with unknown options. Try `pba-cli {cli_command_name} -- --help` for more information."
+
+    cli.command(
+        name=cli_command_name,
+        context_settings={"ignore_unknown_options": True, "allow_extra_args": True},
+    )(typer_wrapper_command)