CENG-355: Add --show-all flag to display all results from repo/package list (#172)

* Add --show-all flag to paginated commands

Author: BartoszBlizniak

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.9.2
+current_version = 1.9.3
 commit = True
 tag = True
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<revision>\d+)

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.9.3] - 2025-11-07
+
+- [[Issue-170]](https://github.com/cloudsmith-io/cloudsmith-cli/issues/170) - Add flag to get all pages
+
 ## [1.9.2] - 2025-11-06
 
 ### Fixed

CONTRIBUTING.md

@@ -22,7 +22,6 @@ For most purposes, you probably just want `pip install -r requirements.txt`.
 
 Our [direnv config](./.envrc) file codifies the development environment setup which we use internally.
 
-
 ## Coding Conventions
 
 Please ensure code conforms to [PEP-8](https://www.python.org/dev/peps/pep-0008/) and [PEP-257](https://www.python.org/dev/peps/pep-0257/).

cloudsmith_cli/cli/commands/dependencies.py

@@ -42,7 +42,7 @@ def list_dependencies(ctx, opts, owner_repo_package):
     for the package format yet.
 
     - OWNER/REPO/PACKAGE: Specify the OWNER namespace (i.e. user or org), the
-    REPO name where the package is stored, and the PACKAGE name (identifier) of the
+    REPO name where the package is stored, and the PACKAGE name (identifier/slug) of the
     package itself. All separated by a slash.
 
     Example: 'your-org/awesome-repo/better-pkg'.

cloudsmith_cli/cli/commands/list_.py

@@ -7,6 +7,7 @@
 
 from ...core.api.distros import list_distros
 from ...core.api.packages import get_package_format_names_with_distros, list_packages
+from ...core.pagination import paginate_results
 from .. import command, decorators, utils, validators
 from ..exceptions import handle_api_exceptions
 from ..utils import maybe_spinner
@@ -156,7 +157,7 @@ def entitlements_(*args, **kwargs):  # pylint: disable=missing-docstring
     help=("Sort packages by field. Prefix with '-' for descending order."),
 )
 @click.pass_context
-def packages(ctx, opts, owner_repo, page, page_size, query, sort):
+def packages(ctx, opts, owner_repo, page, page_size, query, sort, show_all):
     """
     List packages for a repository.
 
@@ -217,11 +218,13 @@ def packages(ctx, opts, owner_repo, page, page_size, query, sort):
     context_msg = "Failed to get list of packages!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            packages_, page_info = list_packages(
-                owner=owner,
-                repo=repo,
+            packages_, page_info = paginate_results(
+                list_packages,
+                show_all=show_all,
                 page=page,
                 page_size=page_size,
+                owner=owner,
+                repo=repo,
                 query=query,
                 sort=sort,
             )
@@ -256,9 +259,12 @@ def packages(ctx, opts, owner_repo, page, page_size, query, sort):
     click.echo()
 
     num_results = len(packages_)
-    list_suffix = "package%s visible" % ("s" if num_results != 1 else "")
+    list_suffix = "package%s" % ("s" if num_results != 1 else "")
     utils.pretty_print_list_info(
-        num_results=num_results, page_info=page_info, suffix=list_suffix
+        num_results=num_results,
+        page_info=None if show_all else page_info,
+        suffix=f"{list_suffix} retrieved" if show_all else f"{list_suffix} visible",
+        show_all=show_all,
     )
 
 
@@ -276,7 +282,7 @@ def packages(ctx, opts, owner_repo, page, page_size, query, sort):
     required=False,
 )
 @click.pass_context
-def repos(ctx, opts, owner_repo, page, page_size):
+def repos(ctx, opts, owner_repo, page, page_size, show_all):
     """
     List repositories for a namespace (owner).
 

cloudsmith_cli/cli/commands/policy/license.py

@@ -5,6 +5,7 @@
 import click
 
 from ....core.api import orgs as api
+from ....core.pagination import paginate_results
 from ... import command, decorators, utils, validators
 from ...exceptions import handle_api_exceptions
 from ...utils import (
@@ -19,7 +20,6 @@
 
 def print_license_policies(policies):
     """Print license policies as a table or output in another format."""
-
     headers = [
         "Name",
         "Description",
@@ -57,10 +57,6 @@ def print_license_policies(policies):
     utils.pretty_print_table(headers, rows)
     click.echo()
 
-    num_results = len(rows)
-    list_suffix = "license polic%s" % ("y" if num_results == 1 else "ies")
-    utils.pretty_print_list_info(num_results=num_results, suffix=list_suffix)
-
 
 @policy.group(cls=command.AliasGroup, name="license", aliases=[])
 @decorators.common_cli_config_options
@@ -86,7 +82,7 @@ def licence(*args, **kwargs):
     "owner", metavar="OWNER", callback=validators.validate_owner, required=True
 )
 @click.pass_context
-def ls(ctx, opts, owner, page, page_size):
+def ls(ctx, opts, owner, page, page_size, show_all):
     """
     List license policies.
 
@@ -111,8 +107,8 @@ def ls(ctx, opts, owner, page, page_size):
     context_msg = "Failed to get license policies!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            policies, page_info = api.list_license_policies(
-                owner=owner, page=page, page_size=page_size
+            policies, page_info = paginate_results(
+                api.list_license_policies, show_all, page, page_size, owner=owner
             )
 
     click.secho("OK", fg="green", err=use_stderr)
@@ -122,6 +118,17 @@ def ls(ctx, opts, owner, page, page_size):
 
     print_license_policies(policies)
 
+    click.echo()
+
+    num_results = len(policies)
+    list_suffix = "license polic%s" % ("y" if num_results == 1 else "ies")
+    utils.pretty_print_list_info(
+        num_results=num_results,
+        page_info=None if show_all else page_info,
+        suffix=list_suffix,
+        show_all=show_all,
+    )
+
 
 @licence.command(aliases=["new"])
 @decorators.common_cli_config_options

cloudsmith_cli/cli/commands/policy/vulnerability.py

@@ -5,6 +5,7 @@
 import click
 
 from ....core.api import orgs as api
+from ....core.pagination import paginate_results
 from ... import command, decorators, utils, validators
 from ...exceptions import handle_api_exceptions
 from ...utils import fmt_bool, fmt_datetime, maybe_spinner, maybe_truncate_string
@@ -46,10 +47,6 @@ def print_vulnerability_policies(policies):
     utils.pretty_print_table(headers, rows, title="Vulnerability Policies")
     click.echo()
 
-    num_results = len(rows)
-    list_suffix = "vulnerability polic%s" % ("y" if num_results == 1 else "ies")
-    utils.pretty_print_list_info(num_results=num_results, suffix=list_suffix)
-
 
 @policy.group(cls=command.AliasGroup, name="vulnerability", aliases=[])
 @decorators.common_cli_config_options
@@ -75,7 +72,7 @@ def vulnerability(*args, **kwargs):
     "owner", metavar="OWNER", callback=validators.validate_owner, required=True
 )
 @click.pass_context
-def ls(ctx, opts, owner, page, page_size):
+def ls(ctx, opts, owner, page, page_size, show_all):
     """
     List vulnerability policies.
 
@@ -100,8 +97,8 @@ def ls(ctx, opts, owner, page, page_size):
     context_msg = "Failed to get package vulnerability policies!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            policies, page_info = api.list_vulnerability_policies(
-                owner=owner, page=page, page_size=page_size
+            policies, page_info = paginate_results(
+                api.list_vulnerability_policies, show_all, page, page_size, owner=owner
             )
 
     click.secho("OK", fg="green", err=use_stderr)
@@ -111,6 +108,17 @@ def ls(ctx, opts, owner, page, page_size):
 
     print_vulnerability_policies(policies)
 
+    click.echo()
+
+    num_results = len(policies)
+    list_suffix = "vulnerability polic%s" % ("y" if num_results == 1 else "ies")
+    utils.pretty_print_list_info(
+        num_results=num_results,
+        page_info=None if show_all else page_info,
+        suffix=list_suffix,
+        show_all=show_all,
+    )
+
 
 @vulnerability.command(aliases=["new"])
 @decorators.common_cli_config_options

cloudsmith_cli/cli/commands/repos.py

@@ -6,13 +6,14 @@
 import click
 
 from ...core.api import repos as api
+from ...core.pagination import paginate_results
 from .. import command, decorators, utils, validators
 from ..exceptions import handle_api_exceptions
 from ..utils import maybe_spinner
 from .main import main
 
 
-def print_repositories(opts, data, page_info=None, show_list_info=True):
+def print_repositories(opts, data, page_info=None, show_list_info=True, show_all=False):
     """Print repositories as a table or output in another format."""
     headers = [
         "Name",
@@ -48,10 +49,16 @@ def print_repositories(opts, data, page_info=None, show_list_info=True):
 
     click.echo()
 
+    if not show_list_info:
+        return
+
     num_results = len(data)
-    list_suffix = "repositor%s visible" % ("ies" if num_results != 1 else "y")
+    list_suffix = "repositor%s" % ("ies" if num_results != 1 else "y")
     utils.pretty_print_list_info(
-        num_results=num_results, page_info=page_info, suffix=list_suffix
+        num_results=num_results,
+        page_info=None if show_all else page_info,
+        suffix=f"{list_suffix} retrieved" if show_all else f"{list_suffix} visible",
+        show_all=show_all,
     )
 
 
@@ -83,7 +90,7 @@ def repositories(ctx, opts):  # pylink: disable=unused-argument
     required=False,
 )
 @click.pass_context
-def get(ctx, opts, owner_repo, page, page_size):
+def get(ctx, opts, owner_repo, page, page_size, show_all):
     """
     List repositories for a namespace (owner).
 
@@ -96,30 +103,34 @@ def get(ctx, opts, owner_repo, page, page_size):
     If OWNER isn't specified it'll default to the currently authenticated user
     (if any). If you're unauthenticated, no results will be returned.
     """
-    # Use stderr for messages if the output is something else (e.g.  # JSON)
+    # Use stderr for messages if the output is something else (e.g. JSON)
     use_stderr = opts.output != "pretty"
 
-    click.echo("Getting list of repositories ... ", nl=False, err=use_stderr)
-
     if isinstance(owner_repo, list):
         if len(owner_repo) == 1:
             owner = owner_repo[0]
             repo = None
         else:
             owner, repo = owner_repo
-    if isinstance(owner_repo, str):
+    elif isinstance(owner_repo, str):
+        repo = None
+        owner = owner_repo or None
+    else:
+        owner = None
         repo = None
 
-        if owner_repo:
-            owner = owner_repo
-        else:
-            owner = None
+    if show_all and repo:
+        raise click.UsageError(
+            "The --show-all option cannot be used when specifying a single repository (OWNER/REPO). Omit the repository slug or remove --show-all."
+        )
+
+    click.echo("Getting list of repositories ... ", nl=False, err=use_stderr)
 
     context_msg = "Failed to get list of repositories!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            repos_, page_info = api.list_repos(
-                owner=owner, repo=repo, page=page, page_size=page_size
+            repos_, page_info = paginate_results(
+                api.list_repos, show_all, page, page_size, owner=owner, repo=repo
             )
 
     click.secho("OK", fg="green", err=use_stderr)
@@ -128,7 +139,11 @@ def get(ctx, opts, owner_repo, page, page_size):
         return
 
     print_repositories(
-        opts=opts, data=repos_, show_list_info=False, page_info=page_info
+        opts=opts,
+        data=repos_,
+        show_list_info=True,
+        page_info=page_info,
+        show_all=show_all,
     )
 
 
@@ -192,7 +207,10 @@ def create(ctx, opts, owner, repo_config_file):
 
     click.secho("OK", fg="green", err=use_stderr)
 
-    print_repositories(opts=opts, data=[repository], show_list_info=False)
+    if utils.maybe_print_as_json(opts, [repository]):
+        return
+
+    print_repositories(opts=opts, data=[repository], show_list_info=True)
 
 
 @repositories.command()
@@ -252,7 +270,10 @@ def update(ctx, opts, owner_repo, repo_config_file):
 
     click.secho("OK", fg="green", err=use_stderr)
 
-    print_repositories(opts=opts, data=[repository], show_list_info=False)
+    if utils.maybe_print_as_json(opts, [repository]):
+        return
+
+    print_repositories(opts=opts, data=[repository], show_list_info=True)
 
 
 @repositories.command(aliases=["rm"])