baris review

Author: safoinme

src/zenml/cli/__init__.py

@@ -225,6 +225,45 @@
 This syntax can also be combined to create more complex filters using the `or`
 and `and` keywords.
 
+Output formats
+--------------
+
+All ``list`` commands support multiple output formats, making it easy to
+pipe ZenML CLI output into scripts, CI/CD pipelines, or analysis tools.
+
+Use the ``--output`` (or ``-o``) option to specify the format:
+
+```bash
+# Get stack data as JSON for processing with jq
+zenml stack list --output=json | jq '.items[] | select(.name=="production")'
+
+# Export pipeline runs to CSV for analysis
+zenml pipeline runs list --output=csv > pipeline_runs.csv
+
+# Get deployment info as YAML for configuration management
+zenml deployment list --output=yaml
+
+# Filter columns to see only what you need
+zenml stack list --columns=id,name,orchestrator
+
+# Combine filtering with custom output formats
+zenml pipeline list --columns=id,name --output=json
+```
+
+Available formats:
+
+- **json** - Structured data with pagination info, ideal for programmatic use
+- **yaml** - Human-readable structured format, great for configuration
+- **csv** - Comma-separated values for spreadsheets and data analysis
+- **tsv** - Tab-separated values for simpler parsing
+- **table** (default) - Formatted tables with colors and alignment
+
+You can also control the default output format and table width using
+environment variables:
+
+- ``ZENML_DEFAULT_OUTPUT`` - Set the default output format (e.g., ``json``)
+- ``ZENML_CLI_COLUMN_WIDTH`` - Override terminal width for consistent formatting
+
 Artifact Stores
 ---------------
 

src/zenml/cli/model.py

@@ -86,9 +86,7 @@ def model() -> None:
         "id",
         "name",
         "latest_version_name",
-        "description",
         "tags",
-        "use_cases",
     ],
 )
 def list_models(

src/zenml/cli/pipeline.py

@@ -898,7 +898,7 @@ def builds() -> None:
 
 
 @builds.command("list", help="List all pipeline builds.")
-@list_options(PipelineBuildFilter, default_columns=["id", "name"])
+@list_options(PipelineBuildFilter, default_columns=["id"])
 def list_pipeline_builds(
     columns: str, output_format: OutputFormat, **kwargs: Any
 ) -> None:

src/zenml/cli/project.py

@@ -37,9 +37,7 @@ def project() -> None:
 
 
 @project.command("list")
-@list_options(
-    ProjectFilter, default_columns=["active", "id", "name", "description"]
-)
+@list_options(ProjectFilter, default_columns=["active", "id", "name"])
 @click.pass_context
 def list_projects(
     ctx: click.Context,

src/zenml/cli/utils.py

@@ -1946,6 +1946,24 @@ def _component_display_name(
     return name.replace("_", " ")
 
 
+def _active_status(
+    is_active: bool, output_format: OutputFormat
+) -> Union[str, bool]:
+    """Format active status based on output format.
+
+    Args:
+        is_active: Whether the item is active.
+        output_format: The output format.
+
+    Returns:
+        For table format: green dot if active, empty string if not.
+        For other formats: boolean value.
+    """
+    if output_format == "table":
+        return "[green]●[/green]" if is_active else ""
+    return is_active
+
+
 def get_execution_status_emoji(status: "ExecutionStatus") -> str:
     """Returns an emoji representing the given execution status.
 
@@ -2148,14 +2166,15 @@ def generate_stack_row(
     is_active = active_id is not None and stack.id == active_id
 
     row: Dict[str, Any] = {
-        "active": "[green]●[/green]"
-        if is_active and output_format == "table"
-        else ("Yes" if is_active else ""),
+        "active": _active_status(is_active, output_format),
     }
 
     for component_type in StackComponentType:
         components = stack.components.get(component_type)
-        header = component_type.value.upper().replace("_", " ")
+        if output_format == "table":
+            header = component_type.value.upper().replace("_", " ")
+        else:
+            header = component_type.value
         row[header] = components[0].name if components else "-"
 
     return row
@@ -2179,9 +2198,7 @@ def generate_project_row(
     is_active = active_id is not None and project.id == active_id
 
     return {
-        "active": "[green]●[/green]"
-        if is_active and output_format == "table"
-        else ("Yes" if is_active else ""),
+        "active": _active_status(is_active, output_format),
     }
 
 
@@ -2203,9 +2220,7 @@ def generate_user_row(
     is_active = active_id is not None and user.id == active_id
 
     return {
-        "active": "[green]●[/green]"
-        if is_active and output_format == "table"
-        else ("Yes" if is_active else ""),
+        "active": _active_status(is_active, output_format),
     }
 
 
@@ -2257,9 +2272,7 @@ def generate_component_row(
     is_active = active_id is not None and component.id == active_id
 
     return {
-        "active": "[green]●[/green]"
-        if is_active and output_format == "table"
-        else ("Yes" if is_active else ""),
+        "active": _active_status(is_active, output_format),
         "name": component.name,
         "component_id": component.id,
         "flavor": component.flavor_name,
@@ -2282,15 +2295,15 @@ def generate_connector_row(
     Returns:
         Dict with connector data for display.
     """
-    is_active = active_connector_ids and connector.id in active_connector_ids
+    is_active = bool(
+        active_connector_ids and connector.id in active_connector_ids
+    )
     labels = [f"{label}:{value}" for label, value in connector.labels.items()]
     resource_name = connector.resource_id or "<multiple>"
     resource_types_str = "\n".join(connector.emojified_resource_types)
 
     return {
-        "active": "[green]●[/green]"
-        if is_active and output_format == "table"
-        else ("Yes" if is_active else ""),
+        "active": _active_status(is_active, output_format),
         "name": connector.name,
         "id": connector.id,
         "type": connector.emojified_connector_type,
@@ -2868,8 +2881,11 @@ def is_sorted_or_filtered(ctx: click.Context) -> bool:
     Returns:
         True if any parameter source differs from default, else False.
     """
+    display_options = {"output_format", "columns"}
     try:
-        for _, source in ctx._parameter_source.items():
+        for param, source in ctx._parameter_source.items():
+            if param in display_options:
+                continue
             if source != click.core.ParameterSource.DEFAULT:
                 return True
         return False