glaip-sdk 0.1.3__py3-none-any.whl → 0.6.10__py3-none-any.whl

glaip_sdk/cli/commands/agents.py

@@ -9,6 +9,7 @@ from __future__ import annotations
 import json
 import os
 from collections.abc import Mapping
+from copy import deepcopy
 from pathlib import Path
 from typing import Any
 
@@ -18,6 +19,7 @@ from rich.console import Console
 from glaip_sdk.branding import (
     ACCENT_STYLE,
     ERROR_STYLE,
+    HINT_PREFIX_STYLE,
     INFO,
     SUCCESS,
     SUCCESS_STYLE,
@@ -32,7 +34,8 @@ from glaip_sdk.cli.agent_config import (
 from glaip_sdk.cli.agent_config import (
     sanitize_agent_config_for_cli as sanitize_agent_config,
 )
-from glaip_sdk.cli.context import detect_export_format, get_ctx_value, output_flags
+from glaip_sdk.cli.constants import DEFAULT_AGENT_INSTRUCTION_PREVIEW_LIMIT
+from glaip_sdk.cli.context import get_ctx_value, output_flags
 from glaip_sdk.cli.display import (
     build_resource_result_data,
     display_agent_run_suggestions,
@@ -44,9 +47,7 @@ from glaip_sdk.cli.display import (
     handle_rich_output,
     print_api_error,
 )
-from glaip_sdk.cli.io import (
-    export_resource_to_file_with_validation as export_resource_to_file,
-)
+from glaip_sdk.cli.hints import in_slash_mode
 from glaip_sdk.cli.io import (
     fetch_raw_resource_details,
 )
@@ -64,9 +65,11 @@ from glaip_sdk.cli.utils import (
     build_renderer,
     coerce_to_row,
     get_client,
+    handle_resource_export,
     output_list,
     output_result,
     spinner_context,
+    with_client_and_spinner,
 )
 from glaip_sdk.cli.validators import (
     validate_agent_instruction_cli as validate_agent_instruction,
@@ -77,7 +80,7 @@ from glaip_sdk.cli.validators import (
 from glaip_sdk.cli.validators import (
     validate_timeout_cli as validate_timeout,
 )
-from glaip_sdk.config.constants import DEFAULT_AGENT_RUN_TIMEOUT, DEFAULT_MODEL
+from glaip_sdk.config.constants import AGENT_CONFIG_FIELDS, DEFAULT_AGENT_RUN_TIMEOUT, DEFAULT_MODEL
 from glaip_sdk.exceptions import AgentTimeoutError
 from glaip_sdk.icons import ICON_AGENT
 from glaip_sdk.utils import format_datetime, is_uuid
@@ -91,6 +94,8 @@ console = Console()
 # Error message constants
 AGENT_NOT_FOUND_ERROR = "Agent not found"
 
+# Instruction preview controls
+
 
 def _safe_agent_attribute(agent: Any, name: str) -> Any:
     """Return attribute value for ``name`` while filtering Mock sentinels."""
@@ -143,10 +148,7 @@ def _build_fallback_agent_mapping(agent: Any) -> dict[str, Any]:
         "description",
         "model",
         "agent_config",
-        "tools",
-        "agents",
-        "mcps",
-        "timeout",
+        *[field for field in AGENT_CONFIG_FIELDS if field not in ("name", "instruction", "model")],
         "tool_configs",
     )
 
@@ -310,12 +312,92 @@ def _format_fallback_agent_data(client: Any, agent: Any) -> dict:
     return result_data
 
 
-def _display_agent_details(ctx: Any, client: Any, agent: Any) -> None:
+def _clamp_instruction_preview_limit(limit: int | None) -> int:
+    """Normalise preview limit; 0 disables trimming."""
+    default = DEFAULT_AGENT_INSTRUCTION_PREVIEW_LIMIT
+    if limit is None:  # pragma: no cover
+        return default
+    try:
+        limit_value = int(limit)
+    except (TypeError, ValueError):  # pragma: no cover - defensive parsing
+        return default
+
+    if limit_value <= 0:
+        return 0
+
+    return limit_value
+
+
+def _build_instruction_preview(value: Any, limit: int) -> tuple[Any, bool]:
+    """Return a trimmed preview for long instruction strings."""
+    if not isinstance(value, str) or limit <= 0:  # pragma: no cover
+        return value, False
+
+    if len(value) <= limit:
+        return value, False
+
+    trimmed_value = value[:limit].rstrip()
+    preview = f"{trimmed_value}\n\n... (preview trimmed)"
+    return preview, True
+
+
+def _prepare_agent_details_payload(
+    data: dict[str, Any],
+    *,
+    instruction_preview_limit: int,
+) -> tuple[dict[str, Any], bool]:
+    """Return payload ready for rendering plus trim indicator."""
+    payload = deepcopy(data)
+    trimmed = False
+    if instruction_preview_limit > 0:
+        preview, trimmed = _build_instruction_preview(payload.get("instruction"), instruction_preview_limit)
+        if trimmed:
+            payload["instruction"] = preview
+    return payload, trimmed
+
+
+def _show_instruction_trim_hint(
+    ctx: Any,
+    *,
+    trimmed: bool,
+    preview_limit: int,
+) -> None:
+    """Render hint describing how to expand or collapse the instruction preview."""
+    if not trimmed or preview_limit <= 0:
+        return
+
+    view = get_ctx_value(ctx, "view", "rich") if ctx is not None else "rich"
+    if view != "rich":  # pragma: no cover - non-rich view handling
+        return
+
+    suffix = f"[dim](preview: {preview_limit:,} chars)[/]"
+    if in_slash_mode(ctx):
+        console.print(
+            f"[{HINT_PREFIX_STYLE}]Tip:[/] Use '/details' again to toggle between trimmed and full prompts {suffix}"
+        )
+        return
+
+    console.print(  # pragma: no cover - fallback hint rendering
+        f"[{HINT_PREFIX_STYLE}]Tip:[/] Run 'aip agents get <agent> --instruction-preview <n>' "
+        f"to control prompt preview length {suffix}"
+    )
+
+
+def _display_agent_details(
+    ctx: Any,
+    client: Any,
+    agent: Any,
+    *,
+    instruction_preview_limit: int | None = None,
+) -> None:
     """Display full agent details using raw API data to preserve ALL fields."""
     if agent is None:
         handle_rich_output(ctx, markup_text(f"[{ERROR_STYLE}]❌ No agent provided[/]"))
         return
 
+    preview_limit = _clamp_instruction_preview_limit(instruction_preview_limit)
+    trimmed_instruction = False
+
     # Try to fetch and format raw agent data first
     with spinner_context(
         ctx,
@@ -327,9 +409,13 @@ def _display_agent_details(ctx: Any, client: Any, agent: Any) -> None:
     if formatted_data:
         # Use raw API data - this preserves ALL fields including account_id
         panel_title = f"{ICON_AGENT} {formatted_data.get('name', 'Unknown')}"
+        payload, trimmed_instruction = _prepare_agent_details_payload(
+            formatted_data,
+            instruction_preview_limit=preview_limit,
+        )
         output_result(
             ctx,
-            formatted_data,
+            payload,
             title=panel_title,
         )
     else:
@@ -347,12 +433,22 @@ def _display_agent_details(ctx: Any, client: Any, agent: Any) -> None:
             result_data = _format_fallback_agent_data(client, agent)
 
         # Display using output_result
+        payload, trimmed_instruction = _prepare_agent_details_payload(
+            result_data,
+            instruction_preview_limit=preview_limit,
+        )
         output_result(
             ctx,
-            result_data,
+            payload,
             title="Agent Details",
         )
 
+    _show_instruction_trim_hint(
+        ctx,
+        trimmed=trimmed_instruction,
+        preview_limit=preview_limit,
+    )
+
 
 @click.group(name="agents", no_args_is_help=True)
 def agents_group() -> None:
@@ -367,26 +463,38 @@ def _resolve_agent(
     select: int | None = None,
     interface_preference: str = "fuzzy",
 ) -> Any | None:
-    """Resolve agent reference (ID or name) with ambiguity handling.
+    """Resolve an agent by ID or name, supporting fuzzy and questionary interfaces.
+
+    This function provides agent-specific resolution with flexible UI options.
+    It wraps resolve_resource_reference with agent-specific configuration, allowing
+    users to choose between fuzzy search and traditional questionary selection.
 
     Args:
-        ctx: Click context object for CLI operations.
-        client: AIP client instance for API operations.
-        ref: Agent reference (ID or name) to resolve.
-        select: Pre-selected agent index for non-interactive mode.
-        interface_preference: "fuzzy" for fuzzy picker, "questionary" for up/down list.
+        ctx: Click context for CLI command execution.
+        client: AIP SDK client instance.
+        ref: Agent identifier (UUID or name string).
+        select: Pre-selected index for non-interactive resolution (1-based).
+        interface_preference: UI preference - "fuzzy" for search or "questionary" for list.
 
     Returns:
-        Resolved agent object or None if not found.
+        Agent object when found, None when resolution fails.
     """
+    # Configure agent-specific resolution parameters
+    resolution_config = {
+        "resource_type": "agent",
+        "get_by_id": client.agents.get_agent_by_id,
+        "find_by_name": client.agents.find_agents,
+        "label": "Agent",
+    }
+    # Use agent-specific resolution with flexible interface preference
     return resolve_resource_reference(
         ctx,
         client,
         ref,
-        "agent",
-        client.agents.get_agent_by_id,
-        client.agents.find_agents,
-        "Agent",
+        resolution_config["resource_type"],
+        resolution_config["get_by_id"],
+        resolution_config["find_by_name"],
+        resolution_config["label"],
         select=select,
         interface_preference=interface_preference,
     )
@@ -416,19 +524,20 @@ def list_agents(
 ) -> None:
     """List agents with optional filtering."""
     try:
-        client = get_client(ctx)
-        with spinner_context(
+        with with_client_and_spinner(
             ctx,
             "[bold blue]Fetching agents…[/bold blue]",
             console_override=console,
-        ):
-            agents = client.agents.list_agents(
-                agent_type=agent_type,
-                framework=framework,
-                name=name,
-                version=version,
-                sync_langflow_agents=sync_langflow,
-            )
+        ) as client:
+            # Query agents with specified filters
+            filter_params = {
+                "agent_type": agent_type,
+                "framework": framework,
+                "name": name,
+                "version": version,
+                "sync_langflow_agents": sync_langflow,
+            }
+            agents = client.agents.list_agents(**filter_params)
 
         # Define table columns: (data_key, header, style, width)
         columns = [
@@ -441,6 +550,14 @@ def list_agents(
 
         # Transform function for safe attribute access
         def transform_agent(agent: Any) -> dict[str, Any]:
+            """Transform an agent object to a display row dictionary.
+
+            Args:
+                agent: Agent object to transform.
+
+            Returns:
+                Dictionary with id, name, type, framework, and version fields.
+            """
             row = coerce_to_row(agent, ["id", "name", "type", "framework", "version"])
             # Ensure id is always a string
             row["id"] = str(row["id"])
@@ -459,7 +576,10 @@ def list_agents(
             and len(agents) > 0
         )
 
+        # Track picker attempt so the fallback table doesn't re-open the palette
+        picker_attempted = False
         if interactive_enabled:
+            picker_attempted = True
             picked_agent = _fuzzy_pick_for_resources(agents, "agent", "")
             if picked_agent:
                 _display_agent_details(ctx, client, picked_agent)
@@ -474,7 +594,12 @@ def list_agents(
             f"{ICON_AGENT} Available Agents",
             columns,
             transform_agent,
-            skip_picker=simple or any(param is not None for param in (agent_type, framework, name, version)),
+            skip_picker=(
+                not interactive_enabled
+                or picker_attempted
+                or simple
+                or any(param is not None for param in (agent_type, framework, name, version))
+            ),
             use_pager=False,
         )
 
@@ -490,61 +615,64 @@ def list_agents(
     type=click.Path(dir_okay=False, writable=True),
     help="Export complete agent configuration to file (format auto-detected from .json/.yaml extension)",
 )
+@click.option(
+    "--instruction-preview",
+    type=int,
+    default=0,
+    show_default=True,
+    help="Instruction preview length when printing instructions (0 shows full prompt).",
+)
 @output_flags()
 @click.pass_context
-def get(ctx: Any, agent_ref: str, select: int | None, export: str | None) -> None:
-    """Get agent details.
+def get(
+    ctx: Any,
+    agent_ref: str,
+    select: int | None,
+    export: str | None,
+    instruction_preview: int,
+) -> None:
+    r"""Get agent details.
 
+    \b
     Examples:
         aip agents get my-agent
         aip agents get my-agent --export agent.json    # Exports complete configuration as JSON
         aip agents get my-agent --export agent.yaml    # Exports complete configuration as YAML
     """
     try:
-        client = get_client(ctx)
+        # Initialize API client for agent retrieval
+        api_client = get_client(ctx)
+
+        # Resolve agent reference using questionary interface for better UX
+        agent = _resolve_agent(ctx, api_client, agent_ref, select, interface_preference="questionary")
 
-        # Resolve agent with ambiguity handling - use questionary interface for traditional UX
-        agent = _resolve_agent(ctx, client, agent_ref, select, interface_preference="questionary")
+        if not agent:
+            raise click.ClickException(f"Agent '{agent_ref}' not found")
 
-        # Handle export option
+        # Handle export option if requested
         if export:
-            export_path = Path(export)
-            # Auto-detect format from file extension
-            detected_format = detect_export_format(export_path)
-
-            # Always export comprehensive data - re-fetch agent with full details
-            try:
-                with spinner_context(
-                    ctx,
-                    "[bold blue]Fetching complete agent data…[/bold blue]",
-                    console_override=console,
-                ):
-                    agent = client.agents.get_agent_by_id(agent.id)
-            except Exception as e:
-                handle_rich_output(
-                    ctx,
-                    markup_text(f"[{WARNING_STYLE}]⚠️  Could not fetch full agent details: {e}[/]"),
-                )
-                handle_rich_output(
-                    ctx,
-                    markup_text(f"[{WARNING_STYLE}]⚠️  Proceeding with available data[/]"),
-                )
-
-            export_resource_to_file(agent, export_path, detected_format)
-            handle_rich_output(
+            handle_resource_export(
                 ctx,
-                markup_text(
-                    f"[{SUCCESS_STYLE}]✅ Complete agent configuration exported to: {export_path} "
-                    f"(format: {detected_format})[/]"
-                ),
+                agent,
+                Path(export),
+                resource_type="agent",
+                get_by_id_func=api_client.agents.get_agent_by_id,
+                console_override=console,
             )
 
         # Display full agent details using the standardized helper
-        _display_agent_details(ctx, client, agent)
+        _display_agent_details(
+            ctx,
+            api_client,
+            agent,
+            instruction_preview_limit=instruction_preview,
+        )
 
         # Show run suggestions via centralized display helper
         handle_rich_output(ctx, display_agent_run_suggestions(agent))
 
+    except click.ClickException:
+        raise
     except Exception as e:
         raise click.ClickException(str(e)) from e
 
@@ -706,10 +834,11 @@ def run(
     files: tuple[str, ...] | None,
     verbose: bool,
 ) -> None:
-    """Run an agent with input text.
+    r"""Run an agent with input text.
 
     Usage: aip agents run <agent_ref> <input_text> [OPTIONS]
 
+    \b
     Examples:
         aip agents run my-agent "Hello world"
         aip agents run agent-123 "Process this data" --timeout 600
@@ -778,11 +907,13 @@ def run(
 
 
 def _running_in_slash_mode(ctx: Any) -> bool:
+    """Return True if the command is executing inside the slash session."""
     ctx_obj = getattr(ctx, "obj", None)
     return isinstance(ctx_obj, dict) and bool(ctx_obj.get("_slash_session"))
 
 
 def _emit_verbose_guidance(ctx: Any) -> None:
+    """Explain the modern alternative to the deprecated --verbose flag."""
     if _running_in_slash_mode(ctx):
         message = (
             "[dim]Tip:[/] Verbose streaming has been retired in the command palette. Run the agent normally and open "
@@ -1037,8 +1168,9 @@ def create(
     timeout: float | None,
     import_file: str | None,
 ) -> None:
-    """Create a new agent.
+    r"""Create a new agent.
 
+    \b
     Examples:
         aip agents create --name "My Agent" --instruction "You are a helpful assistant"
         aip agents create --import agent.json
@@ -1232,8 +1364,9 @@ def update(
     timeout: float | None,
     import_file: str | None,
 ) -> None:
-    """Update an existing agent.
+    r"""Update an existing agent.
 
+    \b
     Examples:
         aip agents update my-agent --instruction "New instruction"
         aip agents update my-agent --import agent.json
@@ -1257,6 +1390,12 @@ def update(
 
         if merged_data:
             _handle_update_import_config(import_file, merged_data, update_data)
+            # Ensure instruction from import file is included if not already set via CLI
+            # This handles the case where instruction is None in CLI args but exists in import file
+            if import_file and (instruction is None or "instruction" not in update_data):
+                import_instruction = merged_data.get("instruction")
+                if import_instruction is not None:
+                    update_data["instruction"] = import_instruction
 
         if not update_data:
             raise click.ClickException("No update fields specified")
@@ -1327,7 +1466,7 @@ def delete(ctx: Any, agent_id: str, yes: bool) -> None:
 @output_flags()
 @click.pass_context
 def sync_langflow(ctx: Any, base_url: str | None, api_key: str | None) -> None:
-    """Sync agents with LangFlow server flows.
+    r"""Sync agents with LangFlow server flows.
 
     This command fetches all flows from the configured LangFlow server and
     creates/updates corresponding agents in the platform.
@@ -1336,6 +1475,7 @@ def sync_langflow(ctx: Any, base_url: str | None, api_key: str | None) -> None:
     - Command options (--base-url, --api-key)
     - Environment variables (LANGFLOW_BASE_URL, LANGFLOW_API_KEY)
 
+    \b
     Examples:
         aip agents sync-langflow
         aip agents sync-langflow --base-url https://my-langflow.com --api-key my-key

glaip_sdk/cli/commands/common_config.py

@@ -0,0 +1,101 @@
+"""Shared helpers for configuration/account flows."""
+
+import click
+import logging
+from rich.console import Console
+from rich.text import Text
+
+from glaip_sdk import Client
+from glaip_sdk.branding import PRIMARY, SUCCESS_STYLE, WARNING_STYLE, AIPBranding
+from glaip_sdk.cli.utils import sdk_version
+
+
+def render_branding_header(console: Console, rule_text: str) -> None:
+    """Render the standard CLI branding header with a custom rule text."""
+    branding = AIPBranding.create_from_sdk(sdk_version=sdk_version(), package_name="glaip-sdk")
+    heading = "[bold]>_ GDP Labs AI Agents Package (AIP CLI)[/bold]"
+    console.print(heading)
+    console.print()
+    console.print(branding.get_welcome_banner())
+    console.rule(rule_text, style=PRIMARY)
+
+
+def check_connection(
+    api_url: str,
+    api_key: str,
+    console: Console,
+    *,
+    abort_on_error: bool = False,
+    extra_hint: str | None = None,
+) -> bool:
+    """Test connectivity and report results.
+
+    Returns True on success, False on handled failures. Raises click.Abort when
+    abort_on_error is True and a fatal error occurs.
+    """
+    console.print("\n🔌 Testing connection...")
+    client: Client | None = None
+    try:
+        # Import lazily so test patches targeting glaip_sdk.Client are honored
+        from importlib import import_module  # noqa: PLC0415
+
+        client_module = import_module("glaip_sdk")
+        client = client_module.Client(api_url=api_url, api_key=api_key)
+        try:
+            agents = client.list_agents()
+            console.print(Text(f"✅ Connection successful! Found {len(agents)} agents", style=SUCCESS_STYLE))
+            return True
+        except Exception as exc:  # pragma: no cover - API failures depend on network
+            console.print(Text(f"⚠️  Connection established but API call failed: {exc}", style=WARNING_STYLE))
+            console.print("   You may need to check your API permissions or network access")
+            if extra_hint:
+                console.print(extra_hint)
+            if abort_on_error:
+                raise click.Abort() from exc
+            return False
+    except Exception as exc:
+        console.print(Text(f"❌ Connection failed: {exc}"))
+        console.print("   Please check your API URL and key")
+        if extra_hint:
+            console.print(extra_hint)
+        if abort_on_error:
+            raise click.Abort() from exc
+        return False
+    finally:
+        if client is not None:
+            client.close()
+
+
+def check_connection_with_reason(
+    api_url: str,
+    api_key: str,
+    *,
+    abort_on_error: bool = False,
+) -> tuple[bool, str]:
+    """Test connectivity and return structured reason."""
+    client: Client | None = None
+    try:
+        # Import lazily so test patches targeting glaip_sdk.Client are honored
+        from importlib import import_module  # noqa: PLC0415
+
+        client_module = import_module("glaip_sdk")
+        client = client_module.Client(api_url=api_url, api_key=api_key)
+        try:
+            client.list_agents()
+            return True, ""
+        except Exception as exc:  # pragma: no cover - API failures depend on network
+            if abort_on_error:
+                raise click.Abort() from exc
+            return False, f"api_failed: {exc}"
+    except Exception as exc:
+        # Log unexpected exceptions in debug while keeping CLI-friendly messaging
+        logging.getLogger(__name__).debug("Unexpected connection error", exc_info=exc)
+        if abort_on_error:
+            raise click.Abort() from exc
+        return False, f"connection_failed: {exc}"
+    finally:
+        if client is not None:
+            try:
+                client.close()
+            except Exception:
+                pass