cmdbox-cli 1.0.0__tar.gz

cmdbox_cli-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Phantom Lamb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cmdbox_cli-1.0.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: cmdbox-cli
+Version: 1.0.0
+Summary: A cross-platform command manager for terminal workflows.
+Author-email: MalloyDelacroix <malloydelacroix@phantomlamb.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.21.0
+Requires-Dist: rich>=14.0.0
+Requires-Dist: peewee>=3.18.3
+Requires-Dist: prompt-toolkit>=3.0.52
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: tomlkit>=0.13.3
+Requires-Dist: psutil>=7.2.1
+Provides-Extra: dev
+Requires-Dist: black>=25.0.0; extra == "dev"
+Requires-Dist: isort>=5.13.0; extra == "dev"
+Requires-Dist: mkdocs>=1.6.1; extra == "dev"
+Requires-Dist: ruff>=0.14.0; extra == "dev"
+Requires-Dist: mypy>=1.10.0; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Dynamic: license-file
+
+# CmdBox
+
+A fast, structured, and searchable command runner for the terminal.
+
+CmdBox replaces fragile shell history and scattered notes with a clean, organized system for
+storing, searching, and executing commands. Designed for anyone who works in the terminal,
+from occasional users to seasoned developers.
+
+---
+
+## Why CmdBox?
+
+Most terminal users have commands they run regularly. Some are short. Many are long and
+complex, packed with flags and options that are easy to forget. Recalling them means digging
+through shell history, hunting through notes, or searching online every time.
+
+CmdBox gives every command a short, memorable alias. Run it instantly. No retyping, no
+searching, no forgetting.
+
+---
+
+## Features
+
+- Named commands with short, memorable aliases
+- Parameterized templates with saved and runtime variables
+- Stored execution context per command (working directory, shell, environment variables, and timeout) with runtime
+  overrides
+- Command execution history with the ability to rerun past executions
+- Tag-based organization and filtering
+- Field-based search across commands, variables, and tags
+- Multi-line template execution via script
+- Rich terminal UI with configurable display fields
+
+---
+
+## Quick Start
+
+#### Save and run a command
+
+```bash
+# Save a command under an alias
+cb cmd add git-graph "git log --oneline --graph --decorate --all"
+
+# Run it by alias, no subcommand needed
+cb git-graph
+
+# List all saved commands
+cb cmd list
+
+# Search saved commands
+cb cmd search git
+```
+
+#### Use variables for flexible commands
+
+```bash
+# Save a command with variable placeholders
+cb cmd add ssh-connect "ssh <user>@<host> -p <port>"
+
+# Save variable values so they fill in automatically
+cb var add user admin
+cb var add host 10.0.0.5
+cb var add port 22
+
+# Run the command, variables are resolved before executing
+cb ssh-connect
+
+# What gets executed:
+ssh admin@10.0.0.5 -p 22
+
+# Supply a different value at runtime to override a saved one
+cb ssh-connect --host 192.168.1.1
+```
+
+---
+
+## Installation
+
+```bash
+pip install cmdbox-cli
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/PhantomLambSoft/CmdBox.git
+cd cmdbox
+pip install .
+```
+
+After installation, verify it worked:
+
+```bash
+cb --version
+```
+
+---
+
+## Documentation
+
+Full documentation is available at [phantomlambsoft.github.io/CmdBox](https://phantomlambsoft.github.io/CmdBox).

cmdbox_cli-1.0.0/README.md

@@ -0,0 +1,101 @@
+# CmdBox
+
+A fast, structured, and searchable command runner for the terminal.
+
+CmdBox replaces fragile shell history and scattered notes with a clean, organized system for
+storing, searching, and executing commands. Designed for anyone who works in the terminal,
+from occasional users to seasoned developers.
+
+---
+
+## Why CmdBox?
+
+Most terminal users have commands they run regularly. Some are short. Many are long and
+complex, packed with flags and options that are easy to forget. Recalling them means digging
+through shell history, hunting through notes, or searching online every time.
+
+CmdBox gives every command a short, memorable alias. Run it instantly. No retyping, no
+searching, no forgetting.
+
+---
+
+## Features
+
+- Named commands with short, memorable aliases
+- Parameterized templates with saved and runtime variables
+- Stored execution context per command (working directory, shell, environment variables, and timeout) with runtime
+  overrides
+- Command execution history with the ability to rerun past executions
+- Tag-based organization and filtering
+- Field-based search across commands, variables, and tags
+- Multi-line template execution via script
+- Rich terminal UI with configurable display fields
+
+---
+
+## Quick Start
+
+#### Save and run a command
+
+```bash
+# Save a command under an alias
+cb cmd add git-graph "git log --oneline --graph --decorate --all"
+
+# Run it by alias, no subcommand needed
+cb git-graph
+
+# List all saved commands
+cb cmd list
+
+# Search saved commands
+cb cmd search git
+```
+
+#### Use variables for flexible commands
+
+```bash
+# Save a command with variable placeholders
+cb cmd add ssh-connect "ssh <user>@<host> -p <port>"
+
+# Save variable values so they fill in automatically
+cb var add user admin
+cb var add host 10.0.0.5
+cb var add port 22
+
+# Run the command, variables are resolved before executing
+cb ssh-connect
+
+# What gets executed:
+ssh admin@10.0.0.5 -p 22
+
+# Supply a different value at runtime to override a saved one
+cb ssh-connect --host 192.168.1.1
+```
+
+---
+
+## Installation
+
+```bash
+pip install cmdbox-cli
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/PhantomLambSoft/CmdBox.git
+cd cmdbox
+pip install .
+```
+
+After installation, verify it worked:
+
+```bash
+cb --version
+```
+
+---
+
+## Documentation
+
+Full documentation is available at [phantomlambsoft.github.io/CmdBox](https://phantomlambsoft.github.io/CmdBox).

cmdbox_cli-1.0.0/pyproject.toml

@@ -0,0 +1,77 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cmdbox-cli"
+version = "1.0.0"
+description = "A cross-platform command manager for terminal workflows."
+readme = "README.md"
+authors = [
+    { name = "MalloyDelacroix", email = "malloydelacroix@phantomlamb.com" }
+]
+requires-python = ">=3.12"
+
+dependencies = [
+    "typer>=0.21.0",
+    "rich>=14.0.0",
+    "peewee>=3.18.3",
+    "prompt-toolkit>=3.0.52",
+    "pyyaml>=6.0.0",
+    "tomlkit>=0.13.3",
+    "psutil>=7.2.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "black>=25.0.0",
+    "isort>=5.13.0",
+    "mkdocs>=1.6.1",
+    "ruff>=0.14.0",
+    "mypy>=1.10.0",
+    "pytest>=8.0.0",
+]
+
+[project.scripts]
+cb = "cmdbox.cli.app:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["cmdbox*"]
+
+[tool.setuptools.package-data]
+cmdbox = ["*.yaml", "*.json", "*.txt", "init/integrations/*"]
+
+[tool.black]
+line-length = 88
+target-version = ["py310", "py311"]
+
+[tool.isort]
+profile = "black"
+line_length = 88
+known_first_party = ["cmdbox"]
+src_paths = ["src", "tests"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+src = ["src", "tests"]
+select = [
+    "E",
+    "F",
+    "I",
+    "B",
+    "UP",
+]
+ignore = [
+    "E501",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["cmdbox"]
+
+[tool.mypy]
+python_version = "3.14"
+strict = false
+ignore_missing_imports = true
+show_error_codes = true

cmdbox_cli-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cmdbox_cli-1.0.0/src/cmdbox/cli/app.py

@@ -0,0 +1,125 @@
+import uuid
+from typing import Annotated
+
+import typer
+
+from cmdbox import container
+from cmdbox.cli.commands.alias_fallback import AliasFallbackGroup
+from cmdbox.cli.ui.presenters.app_presenter import render_version
+from cmdbox.logging_setup.log_handlers import configure_logging
+from cmdbox.logging_setup.log_config import build_log_config, get_logger
+from cmdbox.version import __version__
+from cmdbox.database import ensure_schema, get_db
+from .commands.command_crud import app as command_crud_app
+from .commands.command_run import app as command_run_app
+from .commands.variable_crud import app as variable_crud_app
+from .commands.tag_crud import app as tag_crud_app
+from .commands.init import app as init_app
+from .commands.settings import app as settings_app
+from .commands.history import app as history_app
+
+app = typer.Typer(
+    name="cb",
+    cls=AliasFallbackGroup,
+    help="CmdBox is a CLI tool for storing and recalling commands with many helpful quality of life features.",
+    no_args_is_help=True,
+)
+
+app.add_typer(
+    command_crud_app,
+    name="cmd",
+    help="CRUD (Create, Read, Update, Delete) operations for commands.",
+)
+app.add_typer(variable_crud_app, name="var", help="CRUD operations for variables.")
+app.add_typer(tag_crud_app, name="tag", help="CRUD operations for tags.")
+app.add_typer(command_run_app)
+app.add_typer(init_app)
+app.add_typer(settings_app, name="settings", help="Manage CmdBox settings.")
+app.add_typer(
+    history_app, name="history", help="View and re-run command execution history."
+)
+
+
+def version_callback(value: bool):
+    if value:
+        console = container.get_console()
+        rendered_version = render_version(__version__)
+        console.print(rendered_version)
+        raise typer.Exit()
+
+
+@app.callback()
+def common(
+    test: Annotated[
+        bool,
+        typer.Option(
+            "--test",
+            "-t",
+            help="Enables testing mode.  Database will be created in memory and will not affect the "
+            "applications persistent database.",
+        ),
+    ] = False,
+    verbose: Annotated[
+        bool,
+        typer.Option(
+            "--verbose",
+            "-v",
+            help="Enable additional diagnostic output in the terminal. Sets console log level to INFO.",
+        ),
+    ] = False,
+    debug: Annotated[
+        bool,
+        typer.Option(
+            "--debug",
+            "-d",
+            help="Enable full diagnostic output in the terminal. Sets console log level to DEBUG.",
+        ),
+    ] = False,
+    file_logs: Annotated[
+        bool | None,
+        typer.Option(
+            "--file-logs/--no-file-logs",
+            help="Enable/disables writing diagnostic logs to a file. Defaults to settings.",
+        ),
+    ] = None,
+    version: Annotated[
+        bool,
+        typer.Option(
+            "--version",
+            "-V",
+            callback=version_callback,
+            is_eager=True,
+            help="Print the app version and exit.",
+        ),
+    ] = None,
+) -> None:
+    if test:
+        get_db(testing=True)
+
+    settings = container.get_settings()
+
+    run_id = uuid.uuid4().hex[:6]
+    log_config = build_log_config(
+        settings=settings, verbose=verbose, debug=debug, file_logs=file_logs
+    )
+    configure_logging(log_config, run_id=run_id)
+
+    log = get_logger()
+    log.debug(
+        f"startup: test={test}, verbose={verbose}, debug={debug}, file_logs={file_logs}"
+    )
+    log.debug(f"file_logging={log_config.file_enabled} path={log_config.file_path}")
+
+    ensure_schema()
+
+    if test:
+        console = container.get_console()
+        console.info("Testing mode is active, database is in memory.")
+
+
+def main() -> None:
+    app()
+
+
+if __name__ == "__main__":
+    main()

cmdbox_cli-1.0.0/src/cmdbox/cli/commands/alias_fallback.py

@@ -0,0 +1,102 @@
+import click
+from typer.core import TyperGroup
+
+
+class AliasFallbackGroup(TyperGroup):
+    """
+    Handles command grouping with support for alias-based fallback.
+
+    This class extends the functionality of TyperGroup to include command alias
+    resolution. When a command is not directly found, it attempts to resolve the
+    command name using a predefined alias mapping and dynamically generates an
+    alias command that forwards its arguments to a core `run` command. This allows
+    users to define shorter or alternate names for commands while maintaining
+    flexibility.
+
+    Attributes:
+        _command_aliases (dict[str, str]): A mapping of alias names to their
+            corresponding actual command names. Used for resolving commands
+            through aliases.
+    """
+
+    _command_aliases: dict[str, str] = {
+        "cmds": "cmd",
+        "vars": "var",
+        "tags": "tag",
+        "hist": "history",
+    }
+
+    """
+    The second item in the list is the name of the command as configured by
+    `@app.command("command_name")`, not the method name. Further items in the list
+    will be supplied to that sub-command as args.
+    """
+    _shortcut_commands: dict[str, list[str]] = {"!!": ["history", "last"]}
+
+    def get_command(self, ctx: click.Context, cmd_name: str):
+        """
+        Retrieves a command based on the command name, creating an alias command if
+        the command was not directly found.
+
+        If the command corresponding to `cmd_name` doesn't exist, a new alias
+        command is generated using the `run` command, forwarding all its parameters
+        except the `alias` parameter.
+
+        Args:
+            ctx (click.Context): The Click context in which the command is being
+                invoked.
+            cmd_name (str): The name of the command to retrieve.
+
+        Returns:
+            click.Command: The command object corresponding to the given
+            `cmd_name`, or an alias command if the original command does not exist.
+            Returns None if `run` command is also unavailable.
+        """
+        cmd_name = self._command_aliases.get(cmd_name, cmd_name)
+
+        rv = super().get_command(ctx, cmd_name)
+        if rv is not None:
+            return rv
+
+        run_cmd = super().get_command(ctx, "run")
+        if run_cmd is None:
+            return None
+
+        forwarded_params = [p for p in run_cmd.params if p.name != "alias"]
+
+        @click.command(
+            cmd_name,
+            params=forwarded_params,
+            help=f"Run stored command '{cmd_name}'.",
+            context_settings=run_cmd.context_settings,
+        )
+        @click.pass_context
+        def _alias_cmd(inner_ctx: click.Context, **kwargs):
+            inner_ctx.meta["_extra_args"] = inner_ctx.args[:]
+            inner_ctx.invoke(run_cmd, alias=cmd_name, **kwargs)
+
+        return _alias_cmd
+
+    def resolve_command(self, ctx: click.Context, args: list):
+        """
+        Resolves the command by expanding shortcut commands if applicable.
+
+        This method checks whether the provided command arguments include a shortcut
+        command. If a shortcut command is detected, it is expanded into its full form
+        and the resulting extended argument list is passed to the parent class's
+        `resolve_command` method. If no shortcut is found, the original argument list
+        is passed directly.
+
+        Args:
+            ctx (click.Context): The Click context containing information about the
+                execution of the command.
+            args (list): A list of command-line arguments passed to the command.
+
+        Returns:
+            tuple: A tuple containing the command name, the command object, and a list
+            of remaining arguments.
+        """
+        if args and args[0] in self._shortcut_commands:
+            expanded = self._shortcut_commands[args[0]]
+            return super().resolve_command(ctx, expanded + list(args[1:]))
+        return super().resolve_command(ctx, args)