feat: add models-list command

Author: GabrielVasilescu04

packages/uipath/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.10.55"
+version = "2.10.56"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

packages/uipath/src/uipath/_cli/__init__.py

@@ -45,6 +45,7 @@
     "server": "cli_server",
     "register": "cli_register",
     "debug": "cli_debug",
+    "list-models": "cli_list_models",
     "assets": "services.cli_assets",
     "buckets": "services.cli_buckets",
     "context-grounding": "services.cli_context_grounding",

packages/uipath/src/uipath/_cli/cli_list_models.py

@@ -0,0 +1,22 @@
+import click
+from rich.console import Console
+from rich.table import Table
+
+from ._utils._service_base import ServiceCommandBase, service_command
+
+
+@click.command(name="list-models")
+@service_command
+async def list_models(ctx):
+    """List available LLM models in a table for human discovery."""
+    client = ServiceCommandBase.get_client(ctx)
+    models = await client.agenthub.get_available_llm_models_async()
+
+    table = Table(title="Available LLM Models", show_lines=False)
+    table.add_column("Model", style="cyan", no_wrap=True)
+    table.add_column("Vendor", style="magenta")
+
+    for model in sorted(models, key=lambda m: (m.vendor or "", m.model_name)):
+        table.add_row(model.model_name, model.vendor or "")
+
+    Console().print(table)

packages/uipath/tests/cli/integration/test_list_models_commands.py

@@ -0,0 +1,137 @@
+"""Integration tests for the `uipath list-models` CLI command.
+
+The command renders a rich table for human discovery — no machine-readable
+output mode. Tests verify that each model appears in the rendered output,
+the command is registered, and auth/error paths produce friendly messages.
+"""
+
+from unittest.mock import AsyncMock, MagicMock, patch
+
+import pytest
+from click.testing import CliRunner
+
+from uipath._cli import cli
+from uipath.platform.agenthub import LlmModel
+
+
+@pytest.fixture
+def runner():
+    """Provide a Click CLI test runner."""
+    return CliRunner()
+
+
+@pytest.fixture
+def mock_client():
+    """Provide a mocked UiPath client with an async agenthub service."""
+    with patch("uipath.platform._uipath.UiPath") as mock:
+        client_instance = MagicMock()
+        mock.return_value = client_instance
+
+        client_instance.agenthub = MagicMock()
+        client_instance.agenthub.get_available_llm_models_async = AsyncMock()
+
+        yield client_instance
+
+
+def _make_models() -> list[LlmModel]:
+    """Build a small list of LlmModel instances spanning multiple vendors."""
+    return [
+        LlmModel(model_name="gpt-4o-mini", vendor="OpenAi"),
+        LlmModel(model_name="claude-sonnet-4-5", vendor="Anthropic"),
+        LlmModel(model_name="gemini-2.5-flash", vendor="VertexAi"),
+    ]
+
+
+def test_list_models_renders_each_model(runner, mock_client, mock_env_vars):
+    """Each model and vendor appears in the rendered table."""
+    mock_client.agenthub.get_available_llm_models_async.return_value = _make_models()
+
+    result = runner.invoke(cli, ["list-models"])
+
+    assert result.exit_code == 0
+    for model in _make_models():
+        assert model.model_name in result.output
+        assert (model.vendor or "") in result.output
+    mock_client.agenthub.get_available_llm_models_async.assert_awaited_once()
+
+
+def test_list_models_includes_table_title(runner, mock_client, mock_env_vars):
+    """The rich table renders its title for orientation."""
+    mock_client.agenthub.get_available_llm_models_async.return_value = _make_models()
+
+    result = runner.invoke(cli, ["list-models"])
+
+    assert result.exit_code == 0
+    assert "Available LLM Models" in result.output
+
+
+def test_list_models_handles_missing_vendor(runner, mock_client, mock_env_vars):
+    """A model with no vendor still renders cleanly."""
+    mock_client.agenthub.get_available_llm_models_async.return_value = [
+        LlmModel(model_name="custom-model", vendor=None),
+    ]
+
+    result = runner.invoke(cli, ["list-models"])
+
+    assert result.exit_code == 0
+    assert "custom-model" in result.output
+
+
+def test_list_models_empty(runner, mock_client, mock_env_vars):
+    """An empty model list renders the table without any rows or errors."""
+    mock_client.agenthub.get_available_llm_models_async.return_value = []
+
+    result = runner.invoke(cli, ["list-models"])
+
+    assert result.exit_code == 0
+    assert "Available LLM Models" in result.output
+
+
+def test_list_models_service_error(runner, mock_client, mock_env_vars):
+    """Exceptions from the service are surfaced as click errors."""
+    mock_client.agenthub.get_available_llm_models_async.side_effect = RuntimeError(
+        "boom"
+    )
+
+    result = runner.invoke(cli, ["list-models"])
+
+    assert result.exit_code != 0
+    assert "boom" in result.output
+
+
+def test_list_models_missing_url(runner, monkeypatch):
+    """Missing UIPATH_URL surfaces an auth-configuration error."""
+    monkeypatch.delenv("UIPATH_URL", raising=False)
+    monkeypatch.setenv("UIPATH_ACCESS_TOKEN", "mock_token")
+
+    result = runner.invoke(cli, ["list-models"])
+
+    assert result.exit_code != 0
+    assert "UIPATH_URL not configured" in result.output
+
+
+def test_list_models_missing_token(runner, monkeypatch):
+    """Missing UIPATH_ACCESS_TOKEN surfaces an auth-configuration error."""
+    monkeypatch.setenv("UIPATH_URL", "https://cloud.uipath.com/org/tenant")
+    monkeypatch.delenv("UIPATH_ACCESS_TOKEN", raising=False)
+
+    result = runner.invoke(cli, ["list-models"])
+
+    assert result.exit_code != 0
+    assert "Authentication required" in result.output
+
+
+def test_list_models_help_text(runner):
+    """--help surfaces the command description."""
+    result = runner.invoke(cli, ["list-models", "--help"])
+
+    assert result.exit_code == 0
+    assert "List available LLM models" in result.output
+
+
+def test_list_models_registered_in_cli(runner):
+    """The command is wired into the top-level CLI group."""
+    result = runner.invoke(cli, ["--help"])
+
+    assert result.exit_code == 0
+    assert "list-models" in result.output