Feature/Improved CLI lists with enhanced tables and new formats #3866

znegrin · 2025-07-30T09:42:22Z

Describe changes

I implemented enhanced CLI table formatting and multiple output formats to achieve consistent, flexible, and user-friendly list outputs across all ZenML CLI commands.

This PR introduces:

Multiple output formats: table, json, yaml, tsv, and none
Advanced table options: --columns, --sort, --reverse, --no-truncate, --no-color, --output
Centralized table rendering system using zenml_table() function
Enhanced CLI decorator (enhanced_list_options) that adds consistent table functionality to all list commands
Special formatting features: active stack indicators, status colorization, responsive column sizing
Comprehensive test coverage with integration and unit tests

The changes affect all major CLI list commands, including stacks, models, pipelines, artifacts, users, and more, providing a unified and improved user experience.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
IMPORTANT: I made sure that my changes are reflected properly in the following resources:
- ZenML Docs - Documentation may need updates to reflect new CLI options
- Dashboard: Needs to be communicated to the frontend team.
- Templates: No template changes needed as this is CLI-only functionality
- Projects: No impact on project dependencies

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2025-07-30T09:42:29Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/improved-cli-tables

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

stefannica

I really like where this is going. It's been a long time that we needed some uniformity in how we list items in the CLI as well as give the user more options around the formatting.

However, not all list commands were created equal and I feel some of them have lost some of their glamour after this change. Perhaps allowing things like emojis and multi-line output in the table format can allow them to shine under new management as they currently do ? Or something like supporting multiple verbosity levels, if you feel the default amount of information is too verbose to be useful for the user.

src/zenml/cli/service_connectors.py

🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

Add missing parameter documentation and return values for CLI display functions to resolve CI docstring validation errors. This includes fixes for service connectors, table utilities, tags, pipelines, stack components, models, artifacts, authorized devices, secrets, and service accounts. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

Complete the docstring fixes for artifact versions and ensure all critical CLI table functions have proper parameter and return documentation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

- Add missing Args and Returns sections to functions in model.py - Fix docstring issues in stack_components.py flavor functions - Add parameter documentation to code_repository.py - Fix utils.py print_page_info docstring - Complete user_management.py docstring documentation - Add missing documentation to project.py functions All darglint docstring validation errors are now resolved for CLI files. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

- Fix Page[T] vs List[Any] type mismatches in prepare_list_data calls - Add type ignore comments for model_dump no-any-return issues - Fix missing type annotations in user_management.py - Handle object vs List[Any] issues with proper type ignore comments - Ensure proper handling of paginated vs non-paginated responses Resolves all remaining mypy errors that were causing CI failures. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

- Fix line formatting in project.py, service_accounts.py, tag.py, user_management.py - Ensure consistent formatting across all modified CLI files 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

src/zenml/zen_stores/rest_zen_store.py

bcdurak · 2025-08-06T14:51:32Z

@schustmi This commit should solve our output rerouting issues. Feel free to take a look.

github-actions · 2025-08-06T14:53:58Z

Documentation Link Check Results

❌ Absolute links check failed
There are broken absolute links in the documentation. See workflow logs for details
✅ Relative links check passed
_{Last checked: 2025-09-17 21:25:44 UTC}

src/zenml_cli/__init__.py

bcdurak · 2025-08-07T14:22:33Z

@schustmi I also removed the method that suppresses the server-client mismatch warning.

github-actions · 2025-08-29T12:43:17Z

✅ No broken links found!

schustmi

I didn't have the mental capacity to even start looking at the _render_table(...) function and all the helper functions it calls, I'll do that some other day.

schustmi · 2025-09-02T11:32:57Z

src/zenml/cli/utils.py

+                default=False,
+                help="Disable truncation of long values.",
+            ),
+            click.option(


Is there a way we can tell users what the available columns are?

Hmm, this is a bit more difficult. Maybe we can think about how we can generalize it. My first approach was about using the corresponding Response model. We can use the ID, name (if present), and the attributes in the ResponseBody. However, most entities have specific columns that are not present in the body, like:

active column is not present for the StackResponseBody or the StackResponseMetadata

stack column is not present for the RunResponseBody, but can be extracted from the RunResponseMetadata

flavor columns is named flavor_name in the ComponentResponseBody.

user columns come from the name column within the UserScopedResources

So, it is a bit hard to generate this before loading anything. But I will try to think of a way.

schustmi · 2025-09-02T11:33:44Z

src/zenml/constants.py

 ENV_ZENML_CODE_REPOSITORY_IGNORE_UNTRACKED_FILES = (
    "ZENML_CODE_REPOSITORY_IGNORE_UNTRACKED_FILES"
 )
+ENV_ZENML_DEFAULT_OUTPUT = "ZENML_DEFAULT_OUTPUT"


ZENML_CLI_DEFAULT_OUTPUT_FORMAT maybe?

schustmi · 2025-09-02T11:34:01Z

src/zenml/constants.py

    "ZENML_CODE_REPOSITORY_IGNORE_UNTRACKED_FILES"
 )
+ENV_ZENML_DEFAULT_OUTPUT = "ZENML_DEFAULT_OUTPUT"
+ENV_ZENML_CLI_COLUMN_WIDTH = "ZENML_CLI_COLUMN_WIDTH"


ZENML_CLI_TABLE_COLUMN_WIDTH

schustmi · 2025-09-02T11:37:58Z

src/zenml/cli/utils.py

+    ZenML responses have a structured format:
+    - Top-level fields: id, name (extracted)
+    - Body: Core entity data (all fields extracted)
+    - Metadata: Domain-specific data (IGNORED as requested)


(IGNORED as requested): I will not approve this PR as long as there is any vibe-coded stuff like this anywhere.

schustmi · 2025-09-02T11:38:08Z

src/zenml/cli/utils.py

+
+    Args:
+        items: List of BaseResponse instances to format
+        enrichment_func: Optional function to add/modify fields


This is not the way we format docstrings.

schustmi · 2025-09-02T12:10:19Z

src/zenml/utils/table_utils.py

+
+    # Add pagination metadata if provided
+    if pagination:
+        output_data = {"items": prepared_data, "pagination": pagination}


If we put the pagination info at the root level, it would mirror our Page class which is nicer IMO

schustmi · 2025-09-02T12:10:39Z

src/zenml/utils/table_utils.py

+
+    # Add pagination metadata if provided
+    if pagination:
+        output_data = {"items": prepared_data, "pagination": pagination}


Same as for json

schustmi · 2025-09-02T12:11:35Z

src/zenml/cli/utils.py

+            click.option(
+                "--output",
+                "-o",
+                type=click.Choice(["table", "json", "yaml", "tsv", "none"]),


Missing csv

schustmi · 2025-09-02T12:12:44Z

src/zenml/utils/table_utils.py

+        return yaml.dump(prepared_data, default_flow_style=False)
+
+
+def _render_tsv(


This is essentially a CSV with a different separator. There are classes in the python stdlib to convert items to a CSV that even allow configuring separators, I think we should use them here.

schustmi · 2025-09-02T12:13:42Z

src/zenml/utils/table_utils.py

+    if not data:
+        return []
+
+    # Clean internal fields if requested (for JSON/YAML output)


Why would any format want to display internal fields?

github-actions · 2025-09-17T21:26:17Z

ZenML CLI Performance Comparison (Threshold: 1.0s, Timeout: 60s, Slow: 5s)

❌ Failed Commands on Current Branch (feat/improved-cli-tables)

zenml pipeline list: Command failed on run 1 (exit code: 1)
zenml model list: Command failed on run 1 (exit code: 1)

🚨 New Failures Introduced

The following commands fail on your branch but worked on the target branch:

zenml pipeline list
zenml model list

Performance Comparison

Command	develop Time (s)	feat/improved-cli-tables Time (s)	Difference	Status
`zenml --help`	1.550903 ± 0.008888	1.557977 ± 0.017029	+0.007s	✓ No significant change
`zenml model list`	Not tested	Failed	N/A	❌ Broken in current branch
`zenml pipeline list`	Not tested	Failed	N/A	❌ Broken in current branch
`zenml stack --help`	1.577334 ± 0.026926	1.552941 ± 0.012806	-0.024s	✓ No significant change
`zenml stack list`	3.686741 ± 2.202377	2.652729 ± 0.033690	-1.034s	✅ Improved

Summary

Total commands analyzed: 5
Commands compared for timing: 3
Commands improved: 1 (33.3% of compared)
Commands degraded: 0 (0.0% of compared)
Commands unchanged: 2 (66.7% of compared)
Failed commands: 2 (NEW FAILURES INTRODUCED)
Timed out commands: 0
Slow commands: 0

Environment Info

Target branch: Linux 6.11.0-1018-azure
Current branch: Linux 6.11.0-1018-azure
Test timestamp: 2025-09-17T21:25:23Z
Timeout: 60 seconds
Slow threshold: 5 seconds

znegrin added 3 commits July 30, 2025 11:18

Improving the list outputs and adding new formats

f5d863b

Merge develop into feat/improved-cli-tables

78af737

Fix type annotation for overflow parameter in table_utils

4ecfdfc

znegrin requested review from bcdurak and schustmi July 30, 2025 09:42

znegrin changed the title ~~Feat/improved cli tables~~ Feature/Improved CLI lists with enhanced tables and new formats Jul 30, 2025

znegrin linked an issue Jul 30, 2025 that may be closed by this pull request

Improve the CLI lists and add multiple output formats #3867

Open

stefannica requested changes Jul 31, 2025

View reviewed changes

src/zenml/cli/service_connectors.py Outdated Show resolved Hide resolved

znegrin and others added 2 commits August 1, 2025 10:07

Update service connector table to bring back previous data

6403d92

🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

Merge branch 'develop' into feat/improved-cli-tables

4514cfc

znegrin marked this pull request as ready for review August 1, 2025 08:19

znegrin requested a review from stefannica August 1, 2025 08:20

znegrin added the run-slow-ci label Aug 1, 2025

stefannica approved these changes Aug 1, 2025

View reviewed changes

znegrin and others added 5 commits August 1, 2025 11:30

Apply code formatting to CLI files

ebebd80

- Fix line formatting in project.py, service_accounts.py, tag.py, user_management.py - Ensure consistent formatting across all modified CLI files 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

schustmi requested changes Aug 1, 2025

View reviewed changes

src/zenml/zen_stores/rest_zen_store.py Outdated Show resolved Hide resolved

bcdurak and others added 5 commits August 4, 2025 09:49

Merge branch 'develop' into feat/improved-cli-tables

038940d

fix one test

7bed4be

removed unused import

bf13b44

new module for the CLI

fbeef0c

merged develop

15d2247

formatting

783304d

Merge branch 'develop' into feat/improved-cli-tables

a0b63dd

schustmi requested changes Aug 7, 2025

View reviewed changes

src/zenml_cli/__init__.py Outdated Show resolved Hide resolved

src/zenml_cli/__init__.py Outdated Show resolved Hide resolved

bcdurak added 2 commits August 7, 2025 16:16

new changes

a36632a

removing warning suppresion

ff9acec

bcdurak requested a review from schustmi August 7, 2025 14:21

bcdurak and others added 4 commits August 7, 2025 16:22

Merge branch 'develop' into feat/improved-cli-tables

6fb4e3c

checkpoint

79e75a7

some other fixes

4eea33f

merged

8fa6b5a

schustmi removed their request for review August 8, 2025 10:17

bcdurak added 3 commits August 27, 2025 14:20

docstring changes

c383943

merged develop, resolved conflicts

783f8eb

removed unused stuff

81045c5

bcdurak and others added 7 commits September 1, 2025 10:29

new formatting

277e774

docstrings and linting

932d61d

Merge branch 'develop' into feat/improved-cli-tables

6ef6bc7

formatting linting

39a7c43

formatting

06e2ad5

add id to pipeline runs

494df98

some more formatting

ffe3bf1

bcdurak requested review from schustmi and removed request for bcdurak September 1, 2025 10:14

bcdurak linked an issue Sep 1, 2025 that may be closed by this pull request

[FEATURE]: Implement CLI output rerouting #3877

Closed

1 task

removed unneccessary tests

1ea0f32

schustmi requested changes Sep 2, 2025

View reviewed changes

bcdurak and others added 3 commits September 11, 2025 16:42

Merge branch 'develop' into feat/improved-cli-tables

0341fd5

fixed merge conflicts

44a7b1c

some checkpoint

99399c0

		return yaml.dump(prepared_data, default_flow_style=False)


		def _render_tsv(

Feature/Improved CLI lists with enhanced tables and new formats #3866

Are you sure you want to change the base?

Feature/Improved CLI lists with enhanced tables and new formats #3866

Conversation

znegrin commented Jul 30, 2025

Describe changes

Pre-requisites

Types of changes

Uh oh!

coderabbitai bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

stefannica left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bcdurak commented Aug 6, 2025

Uh oh!

github-actions bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Link Check Results

Uh oh!

Uh oh!

Uh oh!

bcdurak commented Aug 7, 2025

Uh oh!

github-actions bot commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

schustmi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 17, 2025

ZenML CLI Performance Comparison (Threshold: 1.0s, Timeout: 60s, Slow: 5s)

❌ Failed Commands on Current Branch (feat/improved-cli-tables)

🚨 New Failures Introduced

Performance Comparison

Summary

Environment Info

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coderabbitai bot commented Jul 30, 2025 •

edited

Loading

github-actions bot commented Aug 6, 2025 •

edited

Loading

github-actions bot commented Aug 29, 2025 •

edited

Loading