pipecatcloud 0.4.1__tar.gz → 0.4.2__tar.gz

{pipecatcloud-0.4.1 → pipecatcloud-0.4.2}/CHANGELOG.md

@@ -5,6 +5,30 @@ All notable changes to **Pipecat Cloud** will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.2] - 2026-04-02
+
+### Added
+
+- **Container health diagnostics in `agent status` and `deploy`**: When a
+  deployment is failing, the CLI now shows the failure reason (e.g.,
+  CrashLoopBackOff, OOMKilled, ImagePullBackOff), exit code, restart count,
+  and the actual error output (e.g., Python tracebacks). This information
+  appears under the revision line in both `pcc agent status` and during
+  deploy monitoring.
+
+### Changed
+
+- All API requests now include a `User-Agent: PipecatCloudCLI/<version>` header,
+  enabling server-side identification of CLI versions for debugging.
+
+### Fixed
+
+- **Default organization resolution for `PIPECAT_TOKEN` auth**: The CLI now
+  automatically resolves the user's default organization from the API when
+  a token is present but no org is configured locally. Previously,
+  `PIPECAT_TOKEN` required the org to be in the config file or `PIPECAT_ORG`
+  to be set as well.
+
 ## [0.4.1] - 2026-03-30
 
 ### Added

{pipecatcloud-0.4.1 → pipecatcloud-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pipecatcloud
-Version: 0.4.1
+Version: 0.4.2
 Summary: Cloud hosting for Pipecat AI applications
 License: BSD 2-Clause License
 Project-URL: Website, https://docs.pipecat.daily.co/

pipecatcloud-0.4.2/src/pipecatcloud/_utils/auth_utils.py

@@ -0,0 +1,67 @@
+#
+# Copyright (c) 2025, Daily
+#
+# SPDX-License-Identifier: BSD 2-Clause License
+#
+
+import functools
+from typing import Optional
+
+import aiohttp
+
+from pipecatcloud.__version__ import version
+from pipecatcloud._utils.console_utils import console
+from pipecatcloud.cli import PIPECAT_CLI_NAME
+from pipecatcloud.cli.config import config
+
+
+async def _resolve_default_org(token: str) -> Optional[str]:
+    """Fetch the user's default organization using the given token."""
+    from pipecatcloud.config import config as base_config
+
+    api_host = base_config.get("api_host")
+    org_path = base_config.get("organization_path")
+    url = f"{api_host}{org_path}"
+
+    async with aiohttp.ClientSession() as session:
+        async with session.get(
+            url,
+            headers={
+                "Authorization": f"Bearer {token}",
+                "User-Agent": f"PipecatCloudCLI/{version}",
+            },
+        ) as resp:
+            if resp.status == 200:
+                data = await resp.json()
+                organizations = data.get("organizations", [])
+                if organizations:
+                    return organizations[0]["name"]
+    return None
+
+
+def requires_login(func):
+    @functools.wraps(func)
+    async def wrapper(*args, **kwargs):
+        token = config.get("token")
+        if token is None:
+            console.error(
+                f"You are not logged in. Please run `{PIPECAT_CLI_NAME} auth login` first.",
+            )
+            return
+
+        # When org is not set locally (e.g. PIPECAT_TOKEN without a config file),
+        # resolve the user's default organization from the API.
+        if config.get("org") is None:
+            org_name = await _resolve_default_org(token)
+            if org_name:
+                config.override_locally("org", org_name)
+            else:
+                console.error(
+                    "Could not determine your organization. "
+                    f"Set PIPECAT_ORG or run `{PIPECAT_CLI_NAME} auth login`.",
+                )
+                return
+
+        return await func(*args, **kwargs)
+
+    return wrapper

{pipecatcloud-0.4.1 → pipecatcloud-0.4.2}/src/pipecatcloud/_utils/deploy_utils.py

@@ -75,7 +75,7 @@ def _format_elapsed(phase_started_at: Optional[str]) -> str:
 
 
 def _format_revision_line(label: str, rev: dict) -> str:
-    """Format a single revision as an indented detail line."""
+    """Format a single revision as an indented detail line, with health details if present."""
     deploy_id = rev.get("deploymentID", "unknown")[:8]
     phase = rev.get("phase", "Unknown")
     ready_replicas = rev.get("readyReplicas")
@@ -88,7 +88,53 @@ def _format_revision_line(label: str, rev: dict) -> str:
     if elapsed:
         parts.append(f"[dim]·[/dim] [dim]{elapsed}[/dim]")
 
-    return " ".join(parts)
+    lines = [" ".join(parts)]
+
+    # Append health details if present and unhealthy
+    health = rev.get("health")
+    if health and not (health.get("ready") and health.get("restartCount", 0) == 0):
+        lines.extend(format_health_lines(health))
+
+    if rev.get("hasInfrastructureIssue"):
+        lines.append("      [yellow]Infrastructure issue detected — contact support[/yellow]")
+
+    return "\n".join(lines)
+
+
+def format_health_lines(health: dict) -> list:
+    """Format health details as indented lines under a revision."""
+    lines = []
+    reason_parts = []
+    reason = health.get("reason", "")
+    term_reason = health.get("lastTerminationReason", "")
+    exit_code = health.get("lastExitCode")
+
+    if reason:
+        detail = reason
+        if term_reason and term_reason != reason:
+            detail += f" ({term_reason}"
+            if exit_code is not None:
+                detail += f", exit {exit_code}"
+            detail += ")"
+        elif exit_code is not None:
+            detail += f" (exit {exit_code})"
+        reason_parts.append(f"[red]{detail}[/red]")
+
+    restarts = health.get("restartCount", 0)
+    replicas_started = health.get("replicasStarted", 0)
+    if restarts > 0:
+        reason_parts.append(f"[dim]·[/dim] {restarts} restarts across {replicas_started} replicas")
+
+    if reason_parts:
+        lines.append("      " + " ".join(reason_parts))
+
+    message = health.get("message", "")
+    if message:
+        last_line = message.strip().split("\n")[-1].strip()
+        if last_line:
+            lines.append(f"      [dim]{last_line}[/dim]")
+
+    return lines
 
 
 def _build_status_message(headline: str, current_rev=None, previous_rev=None) -> str:

{pipecatcloud-0.4.1 → pipecatcloud-0.4.2}/src/pipecatcloud/api.py

@@ -12,6 +12,7 @@ from typing import Callable, List, Optional, Union
 import aiohttp
 from loguru import logger
 
+from pipecatcloud.__version__ import version
 from pipecatcloud._utils.deploy_utils import DeployConfigParams
 from pipecatcloud.config import config
 from pipecatcloud.exception import AgentStartError
@@ -49,9 +50,10 @@ class _API:
         return f"{config.get('api_host', '')}{config.get(path, '')}"
 
     def _configure_headers(self, override_token: Optional[str] = None) -> dict:
-        if not self.token and not override_token:
-            return {}
-        return {"Authorization": f"Bearer {override_token or self.token}"}
+        headers = {"User-Agent": f"PipecatCloudCLI/{version}"}
+        if self.token or override_token:
+            headers["Authorization"] = f"Bearer {override_token or self.token}"
+        return headers
 
     def _is_pat(self) -> bool:
         """Check if the current token is a Personal Access Token."""
@@ -109,6 +111,9 @@ class _API:
         self.token = new_token
         return new_token
 
+    # TODO: several auth.py and agent.py calls bypass _base_request() with their
+    # own aiohttp.ClientSession(). A longer-term cleanup could route all PCC API
+    # calls through _base_request() so headers (User-Agent, Auth) are set in one place.
     async def _base_request(
         self,
         method: str,

{pipecatcloud-0.4.1 → pipecatcloud-0.4.2}/src/pipecatcloud/cli/commands/agent.py

@@ -20,6 +20,7 @@ from rich.panel import Panel
 from rich.table import Table
 from rich.text import Text
 
+from pipecatcloud.__version__ import version as _cli_version
 from pipecatcloud._utils.async_utils import synchronizer
 from pipecatcloud._utils.auth_utils import requires_login
 from pipecatcloud._utils.console_utils import (
@@ -31,6 +32,7 @@ from pipecatcloud._utils.console_utils import (
 from pipecatcloud._utils.deploy_utils import (
     CONFIG_FILE_OPTION,
     DeployConfigParams,
+    format_health_lines,
     with_deploy_config,
 )
 from pipecatcloud._utils.regions import get_region_codes, validate_region
@@ -285,6 +287,18 @@ async def status(
                 current_parts.append(f"[dim]·[/dim] {rev_replicas} agents")
             health_lines.append(" ".join(current_parts))
 
+            # Show health details when available (skip if healthy with no restarts)
+            rev_health = current_rev.get("health")
+            if rev_health and not (
+                rev_health.get("ready") and rev_health.get("restartCount", 0) == 0
+            ):
+                health_lines.extend(format_health_lines(rev_health))
+
+            if current_rev.get("hasInfrastructureIssue"):
+                health_lines.append(
+                    "    [yellow]Infrastructure issue detected — contact support[/yellow]"
+                )
+
             if previous_rev:
                 prev_phase = previous_rev.get("phase", "Unknown")
                 prev_id = previous_rev.get("deploymentID", "")[:8]
@@ -720,7 +734,10 @@ async def deployments(
             async with aiohttp.ClientSession() as session:
                 response = await session.get(
                     f"{API.construct_api_url('services_deployments_path').format(org=org, service=agent_name)}",
-                    headers={"Authorization": f"Bearer {token}"},
+                    headers={
+                        "Authorization": f"Bearer {token}",
+                        "User-Agent": f"PipecatCloudCLI/{_cli_version}",
+                    },
                 )
             if response.status != 200:
                 error_code = str(response.status)

{pipecatcloud-0.4.1 → pipecatcloud-0.4.2}/src/pipecatcloud/cli/commands/auth.py

@@ -20,6 +20,7 @@ from loguru import logger
 from rich.columns import Columns
 from rich.live import Live
 
+from pipecatcloud.__version__ import version as _cli_version
 from pipecatcloud._utils.async_utils import synchronizer
 from pipecatcloud._utils.auth_utils import requires_login
 from pipecatcloud._utils.console_utils import console
@@ -34,7 +35,7 @@ from pipecatcloud.cli.config import (
 auth_cli = typer.Typer(name="auth", help="Manage Pipecat Cloud credentials", no_args_is_help=True)
 
 # Cloudflare blocks requests with default Python user-agent strings (error 1010).
-USER_AGENT = "PipecatCloudCLI/1.0"
+USER_AGENT = f"PipecatCloudCLI/{_cli_version}"
 
 # Ports to try for the localhost OAuth callback server.
 # Our audience is developers who may have services running on common ports.
@@ -105,7 +106,7 @@ async def _get_account_org(
     async with aiohttp.ClientSession() as session:
         async with session.get(
             f"{API.construct_api_url('organization_path')}",
-            headers={"Authorization": f"Bearer {token}"},
+            headers={"Authorization": f"Bearer {token}", "User-Agent": USER_AGENT},
         ) as resp:
             if resp.status == 200:
                 data = await resp.json()

{pipecatcloud-0.4.1 → pipecatcloud-0.4.2}/src/pipecatcloud.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pipecatcloud
-Version: 0.4.1
+Version: 0.4.2
 Summary: Cloud hosting for Pipecat AI applications
 License: BSD 2-Clause License
 Project-URL: Website, https://docs.pipecat.daily.co/

{pipecatcloud-0.4.1 → pipecatcloud-0.4.2}/tests/test_deployment_status.py

@@ -9,6 +9,7 @@ from pipecatcloud._utils.deploy_utils import (
     DeploymentPhase,
     _format_elapsed,
     _format_revision_line,
+    format_health_lines,
     interpret_deployment_status,
 )
 
@@ -476,3 +477,156 @@ class TestFormatElapsed:
         ts = (datetime.now(timezone.utc) - timedelta(seconds=45)).strftime("%Y-%m-%dT%H:%M:%SZ")
         result = _format_elapsed(ts)
         assert "s" in result
+
+
+class TestHealthLines:
+    """Tests for format_health_lines rendering."""
+
+    def test_crashloopbackoff_with_oomkilled(self):
+        lines = format_health_lines(
+            {
+                "reason": "CrashLoopBackOff",
+                "lastTerminationReason": "OOMKilled",
+                "lastExitCode": 137,
+                "restartCount": 42,
+                "replicasStarted": 3,
+            }
+        )
+        assert len(lines) >= 1
+        assert "CrashLoopBackOff" in lines[0]
+        assert "OOMKilled" in lines[0]
+        assert "exit 137" in lines[0]
+        assert "42 restarts" in lines[0]
+        assert "3 replicas" in lines[0]
+
+    def test_error_with_exit_code(self):
+        lines = format_health_lines(
+            {
+                "reason": "Error",
+                "lastExitCode": 1,
+                "restartCount": 4,
+                "replicasStarted": 2,
+            }
+        )
+        assert "Error" in lines[0]
+        assert "exit 1" in lines[0]
+        assert "4 restarts" in lines[0]
+
+    def test_message_shows_last_line(self):
+        lines = format_health_lines(
+            {
+                "reason": "Error",
+                "lastExitCode": 1,
+                "restartCount": 1,
+                "replicasStarted": 1,
+                "message": "Traceback (most recent call last):\n  File \"bot.py\"\nModuleNotFoundError: No module named 'foo'",
+            }
+        )
+        assert len(lines) == 2
+        assert "ModuleNotFoundError" in lines[1]
+        # Should NOT include the full traceback, just the last line
+        assert "Traceback" not in lines[1]
+
+    def test_image_pull_backoff(self):
+        lines = format_health_lines(
+            {
+                "reason": "ImagePullBackOff",
+                "restartCount": 0,
+                "replicasStarted": 2,
+                "message": 'Back-off pulling image "nonexistent:latest"',
+            }
+        )
+        assert "ImagePullBackOff" in lines[0]
+        # No restarts, so no restart text
+        assert "restarts" not in lines[0]
+        assert "nonexistent:latest" in lines[1]
+
+    def test_no_reason_no_restarts(self):
+        """Health with no reason and no restarts produces no lines."""
+        lines = format_health_lines(
+            {
+                "restartCount": 0,
+                "replicasStarted": 1,
+            }
+        )
+        assert len(lines) == 0
+
+    def test_same_reason_and_termination_reason(self):
+        """When reason == lastTerminationReason, don't duplicate."""
+        lines = format_health_lines(
+            {
+                "reason": "Error",
+                "lastTerminationReason": "Error",
+                "lastExitCode": 1,
+                "restartCount": 3,
+                "replicasStarted": 1,
+            }
+        )
+        # Should show "Error (exit 1)" not "Error (Error, exit 1)"
+        assert "Error (exit 1)" in lines[0]
+
+
+class TestRevisionLineWithHealth:
+    """Tests that _format_revision_line includes health details."""
+
+    def test_revision_with_crash_health(self):
+        output = _format_revision_line(
+            "Current ",
+            {
+                "deploymentID": "17baf1ed-1234",
+                "phase": "Validating",
+                "readyReplicas": 0,
+                "health": {
+                    "ready": False,
+                    "state": "terminated",
+                    "reason": "Error",
+                    "lastExitCode": 1,
+                    "lastTerminationReason": "Error",
+                    "restartCount": 4,
+                    "replicasStarted": 2,
+                    "message": "ModuleNotFoundError: No module named 'foo'",
+                },
+            },
+        )
+        lines = output.split("\n")
+        assert len(lines) >= 2
+        assert "Validating" in lines[0]
+        assert "Error" in lines[1]
+        assert "ModuleNotFoundError" in lines[2]
+
+    def test_revision_with_healthy_state_no_extra_lines(self):
+        output = _format_revision_line(
+            "Current ",
+            {
+                "deploymentID": "abc12345-5678",
+                "phase": "Active",
+                "readyReplicas": 3,
+                "health": {
+                    "ready": True,
+                    "state": "running",
+                    "restartCount": 0,
+                    "replicasStarted": 3,
+                },
+            },
+        )
+        lines = output.split("\n")
+        assert len(lines) == 1  # No health detail lines for healthy containers
+
+    def test_revision_with_infra_issue(self):
+        output = _format_revision_line(
+            "Current ",
+            {
+                "deploymentID": "abc12345-5678",
+                "phase": "Validating",
+                "readyReplicas": 0,
+                "health": {
+                    "ready": True,
+                    "state": "running",
+                    "restartCount": 0,
+                    "replicasStarted": 2,
+                },
+                "hasInfrastructureIssue": True,
+            },
+        )
+        assert "Infrastructure issue" in output
+        assert "contact support" in output

{pipecatcloud-0.4.1 → pipecatcloud-0.4.2}/tests/test_pat_auth.py

@@ -94,7 +94,8 @@ class TestAPIPATDetection:
     async def test_pat_sends_bearer_header(self, pat_client):
         """PAT should be sent as Bearer token in Authorization header."""
         headers = pat_client._configure_headers()
-        assert headers == {"Authorization": "Bearer pcc_pat_60ee796dc5bade735a3b0ef1b5730618"}
+        assert headers["Authorization"] == "Bearer pcc_pat_60ee796dc5bade735a3b0ef1b5730618"
+        assert headers["User-Agent"].startswith("PipecatCloudCLI/")
 
 
 class TestUsePATCommand:
@@ -121,13 +122,14 @@ class TestUsePATCommand:
             ) as mock_get_org,
             patch("pipecatcloud.cli.commands.auth.update_user_config") as mock_update,
             patch("pipecatcloud.cli.commands.auth.console") as mock_console,
+            patch("pipecatcloud.cli.commands.auth.config", {"org": None}),
         ):
             mock_get_org.return_value = ("my-org", "My Organization")
 
             await _use_pat_impl("pcc_pat_60ee796dc5bade735a3b0ef1b5730618")
 
-            # Should verify token
-            mock_get_org.assert_called_once_with("pcc_pat_60ee796dc5bade735a3b0ef1b5730618")
+            # Should verify token (active_org=None when no org in config)
+            mock_get_org.assert_called_once_with("pcc_pat_60ee796dc5bade735a3b0ef1b5730618", None)
 
             # Should store to config with cleared OAuth fields
             mock_update.assert_called_once_with(

pipecatcloud-0.4.1/src/pipecatcloud/_utils/auth_utils.py

@@ -1,26 +0,0 @@
-#
-# Copyright (c) 2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import functools
-
-from pipecatcloud._utils.console_utils import console
-from pipecatcloud.cli import PIPECAT_CLI_NAME
-from pipecatcloud.cli.config import config
-
-
-def requires_login(func):
-    @functools.wraps(func)
-    def wrapper(*args, **kwargs):
-        org = config.get("org")
-        token = config.get("token")
-        if org is None or token is None:
-            console.error(
-                f"You are not logged in. Please run `{PIPECAT_CLI_NAME} auth login` first.",
-            )
-            return
-        return func(*args, **kwargs)
-
-    return wrapper