Skip to content
v0.1.3

Info Command API Reference

This section documents the internals of the info command in Bijux CLI.

bijux_cli.commands.plugins.info

Implements the plugins info subcommand for the Bijux CLI.

This module contains the logic for displaying detailed metadata about a single installed plugin. It locates the plugin by name, reads its plugin.json manifest file, and presents the contents in a structured, machine-readable format.

Output Contract
  • Success: {"name": str, "path": str, ... (plugin.json contents)}
  • Verbose: Adds {"python": str, "platform": str} to the payload.
  • Error: {"error": "...", "code": int}
Exit Codes
  • 0: Success.
  • 1: The plugin was not found, or its metadata file was corrupt.
  • 2: An invalid flag was provided (e.g., bad format).
  • 3: An ASCII or encoding error was detected in the environment.

info_plugin 

info_plugin(
    name: str = Argument(..., help="Plugin name"),
    quiet: bool = Option(
        False, "-q", "--quiet", help=HELP_QUIET
    ),
    verbose: bool = Option(
        False, "-v", "--verbose", help=HELP_VERBOSE
    ),
    fmt: str = Option(
        "json", "-f", "--format", help=HELP_FORMAT
    ),
    pretty: bool = Option(
        True, "--pretty/--no-pretty", help=HELP_NO_PRETTY
    ),
    debug: bool = Option(
        False, "-d", "--debug", help=HELP_DEBUG
    ),
) -> None

Shows detailed metadata for a specific installed plugin.

This function locates an installed plugin by its directory name, parses its plugin.json manifest file, and emits the contents as a structured payload.

Parameters:

  • name (str, default: Argument(..., help='Plugin name') ) –

    The case-sensitive name of the plugin to inspect.

  • quiet (bool, default: Option(False, '-q', '--quiet', help=HELP_QUIET) ) –

    If True, suppresses all output except for errors.

  • verbose (bool, default: Option(False, '-v', '--verbose', help=HELP_VERBOSE) ) –

    If True, includes Python/platform details in the output.

  • fmt (str, default: Option('json', '-f', '--format', help=HELP_FORMAT) ) –

    The output format, "json" or "yaml".

  • pretty (bool, default: Option(True, '--pretty/--no-pretty', help=HELP_NO_PRETTY) ) –

    If True, pretty-prints the output.

  • debug (bool, default: Option(False, '-d', '--debug', help=HELP_DEBUG) ) –

    If True, enables debug diagnostics.

Returns:

  • None ( None ) –

Raises:

  • SystemExit –

    Always exits with a contract-compliant status code and payload, indicating success or detailing an error.

Source code in src/bijux_cli/commands/plugins/info.py 
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def info_plugin(
    name: str = typer.Argument(..., help="Plugin name"),
    quiet: bool = typer.Option(False, "-q", "--quiet", help=HELP_QUIET),
    verbose: bool = typer.Option(False, "-v", "--verbose", help=HELP_VERBOSE),
    fmt: str = typer.Option("json", "-f", "--format", help=HELP_FORMAT),
    pretty: bool = typer.Option(True, "--pretty/--no-pretty", help=HELP_NO_PRETTY),
    debug: bool = typer.Option(False, "-d", "--debug", help=HELP_DEBUG),
) -> None:
    """Shows detailed metadata for a specific installed plugin.

    This function locates an installed plugin by its directory name, parses its
    `plugin.json` manifest file, and emits the contents as a structured
    payload.

    Args:
        name (str): The case-sensitive name of the plugin to inspect.
        quiet (bool): If True, suppresses all output except for errors.
        verbose (bool): If True, includes Python/platform details in the output.
        fmt (str): The output format, "json" or "yaml".
        pretty (bool): If True, pretty-prints the output.
        debug (bool): If True, enables debug diagnostics.

    Returns:
        None:

    Raises:
        SystemExit: Always exits with a contract-compliant status code and
            payload, indicating success or detailing an error.
    """
    command = "plugins info"

    fmt_lower = validate_common_flags(fmt, command, quiet)

    plug_dir = get_plugins_dir() / name
    if not (plug_dir.is_dir() and (plug_dir / "plugin.py").is_file()):
        emit_error_and_exit(
            f'Plugin "{name}" not found',
            code=1,
            failure="not_found",
            command=command,
            fmt=fmt_lower,
            quiet=quiet,
            include_runtime=verbose,
            debug=debug,
        )

    meta_file = plug_dir / "plugin.json"
    meta: dict[str, Any] = {}
    if meta_file.is_file():
        try:
            meta = json.loads(meta_file.read_text("utf-8"))
            if not meta.get("name"):
                raise ValueError("Missing required fields")
        except Exception as exc:
            emit_error_and_exit(
                f'Plugin "{name}" metadata is corrupt: {exc}',
                code=1,
                failure="metadata_corrupt",
                command=command,
                fmt=fmt_lower,
                quiet=quiet,
                include_runtime=verbose,
                debug=debug,
            )

    payload = {"name": name, "path": str(plug_dir), **meta}

    new_run_command(
        command_name=command,
        payload_builder=lambda include: _build_payload(include, payload),
        quiet=quiet,
        verbose=verbose,
        fmt=fmt_lower,
        pretty=pretty,
        debug=debug,
    )