Skip to content
v0.1.3

Cli Module API Reference

This section documents the internals of the cli module in Bijux CLI.

bijux_cli.cli

Constructs the main Typer application for the Bijux CLI.

This module serves as the primary builder for the entire CLI. It defines the root Typer app, orchestrates the registration of all core commands and the discovery of dynamic plugins, and sets the default behavior for when the CLI is invoked without any command.

build_app 

build_app() -> Typer

Builds and configures the root Typer application.

This factory function performs the main steps of assembling the CLI: 1. Creates the root Typer app instance. 2. Registers all core, built-in commands. 3. Discovers and registers all dynamic plugins. 4. Sets the default callback to launch the REPL.

Returns:

  • Typer –

    typer.Typer: The fully constructed Typer application.

Source code in src/bijux_cli/cli.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def build_app() -> typer.Typer:
    """Builds and configures the root `Typer` application.

    This factory function performs the main steps of assembling the CLI:
    1.  Creates the root `Typer` app instance.
    2.  Registers all core, built-in commands.
    3.  Discovers and registers all dynamic plugins.
    4.  Sets the default callback to launch the REPL.

    Returns:
        typer.Typer: The fully constructed `Typer` application.
    """
    app = typer.Typer(
        help="Bijux CLI – Lean, plug-in‑driven command‑line interface.",
        invoke_without_command=True,
        context_settings={
            "ignore_unknown_options": True,
            "allow_extra_args": True,
        },
    )
    register_commands(app)
    register_dynamic_plugins(app)
    app.callback(invoke_without_command=True)(maybe_default_to_repl)
    return app

maybe_default_to_repl 

maybe_default_to_repl(ctx: Context) -> None

Invokes the repl command if no other subcommand is specified.

This function is used as the root callback for the main Typer application. It checks if a subcommand was invoked and, if not, re-executes the CLI with the repl command.

Parameters:

  • ctx (Context) –

    The Typer context, used to check for an invoked subcommand.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/cli.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def maybe_default_to_repl(ctx: Context) -> None:
    """Invokes the `repl` command if no other subcommand is specified.

    This function is used as the root callback for the main `Typer` application.
    It checks if a subcommand was invoked and, if not, re-executes the CLI
    with the `repl` command.

    Args:
        ctx (Context): The Typer context, used to check for an invoked subcommand.

    Returns:
        None:
    """
    if ctx.invoked_subcommand is None:
        subprocess.call([sys.argv[0], "repl"])  # noqa: S603  # nosec B603