commands.console

Console commands for Datalayer CLI.

console_callback

@app.callback()
def console_callback(ctx: typer.Context) -> None

Agent console commands.

console_connect

@app.command(name="connect")
def console_connect(
        runtime_name: Optional[str] = typer.Option(
            None,
            "--agent",
            help="The name of the Agent to connect to",
        ),
        datalayer_url: Optional[str] = typer.Option(
            None,
            "--datalayer-url",
            help="Datalayer URL",
        ),
        token: Optional[str] = typer.Option(
            None,
            "--api-key",
            help="API key",
        ),
        external_token: Optional[str] = typer.Option(
            None,
            "--external-token",
            help="External authentication token",
        ),
        no_browser: bool = typer.Option(
            False,
            "--no-browser",
            help="Will prompt for user and password on the CLI",
        ),
        kernel_name: Optional[str] = typer.Option(
            None,
            "--kernel-name",
            help="The name of the kernel to connect to",
        ),
        kernel_path: Optional[str] = typer.Option(
            None,
            "--kernel-path",
            help="The path where the kernel should be started",
        ),
        existing: Optional[str] = typer.Option(
            None,
            "--existing",
            help="Connect to an existing kernel instead of starting a new one",
        ),
        extra_args: Optional[List[str]] = typer.Argument(
            None,
            help="Additional arguments to pass to the console application")
) -> None

Connect to a Datalayer agent console.

console_callback_default

@app.callback(invoke_without_command=True)
def console_callback_default(
    ctx: typer.Context,
    runtime_name: Optional[str] = typer.Option(
        None,
        "--agent",
        help="The name of the Agent to connect to",
    ),
    datalayer_url: Optional[str] = typer.Option(
        None,
        "--datalayer-url",
        help="Datalayer URL",
    ),
    token: Optional[str] = typer.Option(
        None,
        "--api-key",
        help="API key",
    ),
    external_token: Optional[str] = typer.Option(
        None,
        "--external-token",
        help="External authentication token",
    ),
    no_browser: bool = typer.Option(
        False,
        "--no-browser",
        help="Will prompt for user and password on the CLI",
    ),
    kernel_name: Optional[str] = typer.Option(
        None,
        "--kernel-name",
        help="The name of the kernel to connect to",
    ),
    kernel_path: Optional[str] = typer.Option(
        None,
        "--kernel-path",
        help="The path where the kernel should be started",
    ),
    existing: Optional[str] = typer.Option(
        None,
        "--existing",
        help="Connect to an existing kernel instead of starting a new one",
    )
) -> None

Connect to a Datalayer agent console (default behavior).