hydra_config.cli

Hydra Config CLI utilities.

Functions

register_cli([func])	Register a CLI command.
run_cli(func, /, **kwargs)	Run a CLI command.

Module Contents

register_cli(func=None, /, **kwargs)

Register a CLI command.

Example

from typing import Any

from hydra_config.cli import register_cli, run_cli


class Config:
    def __init__(self, param: Any):
        self.param = param


class ConfigInt(Config):
    def __init__(self, param: int):
        super().__init__(param)


class ConfigFloat(Config):
    def __init__(self, param: float):
        super().__init__(param)


class System:
    def __init__(self, config: Config):
        self.config = config


@register_cli
def standalone_cli(system: System, x: int, flag: bool = False):
    print(
        "System Config Param:",
        system.config.param,
        type(system.config),
        type(system.config.param),
    )
    print("X:", x, type(x))
    print("Flag:", flag, type(flag))


if __name__ == "__main__":
    run_cli(standalone_cli)

Parameters:

func (Callable | None) – The CLI function to register. If None, returns a decorator.

Returns:

Callable – The registered CLI function or a decorator if func is None.

run_cli(func, /, **kwargs)

Run a CLI command.

Parameters:

func (Callable) – The CLI command to run.