cloudsmith-cli 1.10.2__py2.py3-none-any.whl → 1.10.4__py2.py3-none-any.whl

cloudsmith_cli/cli/command.py

@@ -6,6 +6,46 @@ import click.exceptions
 from click_didyoumean import DYMGroup
 
 
+def _is_json_output_requested(exception):
+    """Determine if JSON output was requested, checking context and argv."""
+    # Check context if available
+    ctx = getattr(exception, "ctx", None)
+    if ctx and ctx.params:
+        fmt = ctx.params.get("output")
+        if fmt in ("json", "pretty_json"):
+            return True
+
+    # Fallback: check sys.argv for output format flags
+    import sys
+
+    argv = sys.argv
+
+    if "--output-format=json" in argv or "--output-format=pretty_json" in argv:
+        return True
+
+    for idx, arg in enumerate(argv):
+        if arg in ("-F", "--output-format") and idx + 1 < len(argv):
+            if argv[idx + 1] in ("json", "pretty_json"):
+                return True
+
+    return False
+
+
+def _format_click_exception_as_json(exception):
+    """Format a ClickException as a JSON error dict."""
+    return {
+        "detail": exception.format_message(),
+        "meta": {
+            "code": exception.exit_code,
+            "description": "Usage Error",
+        },
+        "help": {
+            "context": "Invalid usage",
+            "hint": "Check your command arguments/flags.",
+        },
+    }
+
+
 class AliasGroup(DYMGroup):
     """A command group with DYM and alias support."""
 
@@ -92,3 +132,29 @@ class AliasGroup(DYMGroup):
     def format_commands(self, ctx, formatter):
         ctx.showing_help = True
         return super().format_commands(ctx, formatter)
+
+    def main(self, *args, **kwargs):
+        """Override main to intercept exceptions and format as JSON if requested."""
+        import sys
+
+        original_standalone_mode = kwargs.get("standalone_mode", True)
+        kwargs["standalone_mode"] = False
+
+        try:
+            return super().main(*args, **kwargs)
+        except click.exceptions.Abort:
+            if not original_standalone_mode:
+                raise
+            click.echo("Aborted!", err=True)
+            sys.exit(1)
+        except click.exceptions.ClickException as e:
+            if _is_json_output_requested(e):
+                import json
+
+                click.echo(json.dumps(_format_click_exception_as_json(e), indent=4))
+                sys.exit(e.exit_code)
+
+            if not original_standalone_mode:
+                raise
+            e.show()
+            sys.exit(e.exit_code)

cloudsmith_cli/cli/commands/auth.py

@@ -4,7 +4,7 @@ import webbrowser
 
 import click
 
-from .. import decorators, validators
+from .. import decorators, utils, validators
 from ..exceptions import handle_api_exceptions
 from ..saml import create_configured_session, get_idp_url
 from ..webserver import AuthenticationWebRequestHandler, AuthenticationWebServer
@@ -22,14 +22,15 @@ def _perform_saml_authentication(opts, owner, enable_token_creation=False, json=
     api_host = opts.api_config.host
 
     idp_url = get_idp_url(api_host, owner, session=session)
-    if not json:
-        click.echo(
-            f"Opening your organization's SAML IDP URL in your browser: {click.style(idp_url, bold=True)}"
-        )
-    click.echo()
+
+    click.echo(
+        f"Opening your organization's SAML IDP URL in your browser: {click.style(idp_url, bold=True)}",
+        err=json,
+    )
+    click.echo(err=json)
     webbrowser.open(idp_url)
-    if not json:
-        click.echo("Starting webserver to begin authentication ... ")
+
+    click.echo("Starting webserver to begin authentication ... ", err=json)
 
     auth_server = AuthenticationWebServer(
         (AUTH_SERVER_HOST, AUTH_SERVER_PORT),
@@ -86,13 +87,25 @@ def _perform_saml_authentication(opts, owner, enable_token_creation=False, json=
 @click.pass_context
 def authenticate(ctx, opts, owner, token, force, save_config, json):
     """Authenticate to Cloudsmith using the org's SAML setup."""
-    owner = owner[0].strip("'[]'")
+    json = json or utils.should_use_stderr(opts)
+    # If using json output, we redirect info messages to stderr
+    use_stderr = json
 
-    if not json:
-        click.echo(
-            f"Beginning authentication for the {click.style(owner, bold=True)} org ... "
+    if json and not utils.should_use_stderr(opts):
+        click.secho(
+            "DEPRECATION WARNING: The `--json` flag is deprecated and will be removed in a future release. "
+            "Please use `--output-format json` instead.",
+            fg="yellow",
+            err=True,
         )
 
+    owner = owner[0].strip("'[]'")
+
+    click.echo(
+        f"Beginning authentication for the {click.style(owner, bold=True)} org ... ",
+        err=use_stderr,
+    )
+
     context_message = "Failed to authenticate via SSO!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_message):
         _perform_saml_authentication(

cloudsmith_cli/cli/commands/check.py

@@ -29,14 +29,18 @@ def check(ctx, opts):  # pylint: disable=unused-argument
 @click.pass_context
 def rates(ctx, opts):
     """Check current API rate limits."""
-    click.echo("Retrieving rate limits ... ", nl=False)
+    use_stderr = utils.should_use_stderr(opts)
+    click.echo("Retrieving rate limits ... ", nl=False, err=use_stderr)
 
     context_msg = "Failed to retrieve status!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
             resources_limits = get_rate_limits()
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
+
+    if utils.maybe_print_as_json(opts, resources_limits):
+        return
 
     headers = ["Resource", "Throttled", "Remaining", "Interval (Seconds)", "Reset"]
 
@@ -77,17 +81,27 @@ def rates(ctx, opts):
 @click.pass_context
 def service(ctx, opts):
     """Check the status of the Cloudsmith service."""
-    click.echo("Retrieving service status ... ", nl=False)
+    use_stderr = utils.should_use_stderr(opts)
+    click.echo("Retrieving service status ... ", nl=False, err=use_stderr)
 
     context_msg = "Failed to retrieve status!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
             status, version = get_status(with_version=True)
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
 
     config = cloudsmith_api.Configuration()
 
+    data = {
+        "endpoint": config.host,
+        "status": status,
+        "version": version,
+    }
+
+    if utils.maybe_print_as_json(opts, data):
+        return
+
     click.echo()
     click.echo(f"The service endpoint is: {click.style(config.host, bold=True)}")
     click.echo(f"The service status is:   {click.style(status, bold=True)}")

cloudsmith_cli/cli/commands/copy.py

@@ -3,7 +3,7 @@
 import click
 
 from ...core.api.packages import copy_package
-from .. import decorators, validators
+from .. import decorators, utils, validators
 from ..exceptions import handle_api_exceptions
 from ..utils import maybe_spinner
 from .main import main
@@ -56,6 +56,8 @@ def copy(
     """
     owner, source, slug = owner_repo_package
 
+    use_stderr = utils.should_use_stderr(opts)
+
     click.echo(
         "Copying %(slug)s package from %(source)s to %(dest)s ... "
         % {
@@ -64,6 +66,7 @@ def copy(
             "dest": click.style(destination, bold=True),
         },
         nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to copy package!"
@@ -75,9 +78,10 @@ def copy(
                 owner=owner, repo=source, identifier=slug, destination=destination
             )
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
 
     if no_wait_for_sync:
+        utils.maybe_print_status_json(opts, {"slug": new_slug, "status": "OK"})
         return
 
     wait_for_package_sync(
@@ -90,3 +94,5 @@ def copy(
         skip_errors=skip_errors,
         attempts=sync_attempts,
     )
+
+    utils.maybe_print_status_json(opts, {"slug": new_slug, "status": "OK"})

cloudsmith_cli/cli/commands/delete.py

@@ -45,12 +45,16 @@ def delete(ctx, opts, owner_repo_package, yes):
         "package": click.style(slug, bold=True),
     }
 
+    use_stderr = utils.should_use_stderr(opts)
+
     prompt = "delete the %(package)s from %(owner)s/%(repo)s" % delete_args
-    if not utils.confirm_operation(prompt, assume_yes=yes):
+    if not utils.confirm_operation(prompt, assume_yes=yes, err=use_stderr):
         return
 
     click.echo(
-        "Deleting %(package)s from %(owner)s/%(repo)s ... " % delete_args, nl=False
+        "Deleting %(package)s from %(owner)s/%(repo)s ... " % delete_args,
+        nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to delete the package!"
@@ -58,4 +62,6 @@ def delete(ctx, opts, owner_repo_package, yes):
         with maybe_spinner(opts):
             delete_package(owner=owner, repo=repo, identifier=slug)
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
+
+    utils.maybe_print_status_json(opts, {"slug": slug, "status": "OK"})

cloudsmith_cli/cli/commands/dependencies.py

@@ -50,7 +50,7 @@ def list_dependencies(ctx, opts, owner_repo_package):
     owner, repo, identifier = owner_repo_package
 
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     click.echo(
         "Getting direct (non-transitive) dependencies of %(package)s in "

cloudsmith_cli/cli/commands/download.py

@@ -12,7 +12,7 @@ from ...core.download import (
     resolve_package,
     stream_download,
 )
-from .. import decorators, validators
+from .. import decorators, utils, validators
 from ..exceptions import handle_api_exceptions
 from ..utils import maybe_spinner
 from .main import main
@@ -124,7 +124,7 @@ def download(  # noqa: C901
     owner, repo = owner_repo
 
     # Use stderr for messages if output is JSON
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     if not use_stderr:
         click.echo(
@@ -213,11 +213,13 @@ def download(  # noqa: C901
             return
 
         # Download all files
-        click.echo(f"\nDownloading {len(files_to_download)} files to: {output_dir}")
-        click.echo()
+        if not use_stderr:
+            click.echo(f"\nDownloading {len(files_to_download)} files to: {output_dir}")
+            click.echo()
 
         success_count = 0
         failed_files = []
+        downloaded_files = []
 
         for idx, file_info in enumerate(files_to_download, 1):
             filename = file_info["filename"]
@@ -232,6 +234,12 @@ def download(  # noqa: C901
                     f"[{idx}/{len(files_to_download)}] [{tag}] {filename}{primary_marker} ...",
                     nl=False,
                 )
+            else:
+                click.echo(
+                    f"[{idx}/{len(files_to_download)}] [{tag}] {filename}{primary_marker} ...",
+                    nl=False,
+                    err=True,
+                )
 
             try:
                 context_msg = f"Failed to download {filename}!"
@@ -246,11 +254,56 @@ def download(  # noqa: C901
                     )
                 if not use_stderr:
                     click.secho(" OK", fg="green")
+                else:
+                    click.echo(" OK", err=True)
                 success_count += 1
+                downloaded_files.append(
+                    {
+                        "filename": filename,
+                        "path": output_path,
+                        "tag": tag,
+                        "is_primary": file_info.get("is_primary", False),
+                        "size": file_info.get("size", 0),
+                        "status": "OK",
+                    }
+                )
             except Exception as e:  # pylint: disable=broad-except
                 if not use_stderr:
                     click.secho(" FAILED", fg="red")
+                else:
+                    click.echo(" FAILED", err=True)
                 failed_files.append((filename, str(e)))
+                downloaded_files.append(
+                    {
+                        "filename": filename,
+                        "path": output_path,
+                        "tag": tag,
+                        "is_primary": file_info.get("is_primary", False),
+                        "size": file_info.get("size", 0),
+                        "status": "FAILED",
+                        "error": str(e),
+                    }
+                )
+
+        # Build JSON output for all-files download
+        json_output = {
+            "package": {
+                "name": package.get("name"),
+                "version": package.get("version"),
+                "format": package.get("format"),
+                "slug": package.get("slug"),
+            },
+            "output_directory": output_dir,
+            "files": downloaded_files,
+            "summary": {
+                "total": len(files_to_download),
+                "success": success_count,
+                "failed": len(failed_files),
+            },
+        }
+
+        if utils.maybe_print_as_json(opts, json_output):
+            return
 
         click.echo()
         if success_count == len(files_to_download):
@@ -321,12 +374,40 @@ def download(  # noqa: C901
             session=session,
             headers=auth_headers,
             overwrite=overwrite,
-            quiet=opts.output != "pretty",
+            quiet=utils.should_use_stderr(opts),
         )
 
-    if opts.output == "pretty":
-        click.echo()
-        click.secho("Download completed successfully!", fg="green")
+    # Build JSON output for single-file download
+    json_output = {
+        "package": {
+            "name": package.get("name"),
+            "version": package.get("version"),
+            "format": package.get("format"),
+            "slug": package.get("slug"),
+        },
+        "output_directory": os.path.dirname(outfile),
+        "files": [
+            {
+                "filename": os.path.basename(outfile),
+                "path": outfile,
+                "tag": "file",
+                "is_primary": True,
+                "size": package.get("size", 0),
+                "status": "OK",
+            }
+        ],
+        "summary": {
+            "total": 1,
+            "success": 1,
+            "failed": 0,
+        },
+    }
+
+    if utils.maybe_print_as_json(opts, json_output):
+        return
+
+    click.echo()
+    click.secho("Download completed successfully!", fg="green")
 
 
 def _get_extension_for_format(pkg_format: str) -> str:

cloudsmith_cli/cli/commands/entitlements.py

@@ -89,7 +89,7 @@ def list_entitlements(ctx, opts, owner_repo, page, page_size, show_tokens, page_
     owner, repo = owner_repo
 
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     click.echo(
         "Getting list of entitlements for the %(repository)s "
@@ -323,7 +323,7 @@ def create(ctx, opts, owner_repo, show_tokens, name, token):
     owner, repo = owner_repo
 
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     click.secho(
         "Creating %(name)s entitlement for the %(repository)s "
@@ -391,13 +391,17 @@ def delete(ctx, opts, owner_repo_identifier, yes):
         "delete the %(identifier)s entitlement from the %(repository)s "
         "repository" % delete_args
     )
-    if not utils.confirm_operation(prompt, assume_yes=yes):
+
+    use_stderr = utils.should_use_stderr(opts)
+
+    if not utils.confirm_operation(prompt, assume_yes=yes, err=use_stderr):
         return
 
     click.secho(
         "Deleting %(identifier)s entitlement from the %(repository)s "
         "repository ... " % delete_args,
         nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to delete the entitlement!"
@@ -454,7 +458,7 @@ def update(ctx, opts, owner_repo_identifier, show_tokens, name, token):
     owner, repo, identifier = owner_repo_identifier
 
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     click.secho(
         "Updating %(identifier)s entitlement for the %(repository)s "
@@ -527,7 +531,7 @@ def refresh(ctx, opts, owner_repo_identifier, show_tokens, yes):
     }
 
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     prompt = (
         "refresh the %(identifier)s entitlement for the %(repository)s "
@@ -603,7 +607,7 @@ def sync(ctx, opts, owner_repo, show_tokens, source, yes):
     }
 
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     if not yes:
         click.secho(
@@ -768,7 +772,7 @@ def restrict(
     owner, repo, identifier = owner_repo_identifier
 
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     click.secho(
         "Updating %(identifier)s entitlement for the %(repository)s "

cloudsmith_cli/cli/commands/list_.py

@@ -53,7 +53,7 @@ def dependencies_(*args, **kwargs):  # pylint: disable=missing-docstring
 def distros(ctx, opts, package_format):
     """List available distributions."""
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     if not use_stderr:
         click.echo("Getting list of distributions ... ", nl=False, err=use_stderr)
@@ -210,7 +210,7 @@ def packages(ctx, opts, owner_repo, page, page_size, query, sort, page_all):
     owner, repo = owner_repo
 
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     if not use_stderr:
         click.echo("Getting list of packages ... ", nl=False, err=use_stderr)

cloudsmith_cli/cli/commands/login.py

@@ -6,7 +6,7 @@ import cloudsmith_api
 from ...core.api.exceptions import TwoFactorRequiredException
 from ...core.api.user import get_user_token
 from ...core.config import create_config_files, new_config_messaging
-from .. import decorators
+from .. import decorators, utils
 from ..exceptions import handle_api_exceptions
 from ..utils import maybe_spinner
 from .main import main
@@ -37,10 +37,12 @@ def validate_login(ctx, param, value):
 @click.pass_context
 def login(ctx, opts, login, password):  # pylint: disable=redefined-outer-name
     """Retrieve your API authentication token/key via login."""
+    use_stderr = utils.should_use_stderr(opts)
     click.echo(
         "Retrieving API token for %(login)s ... "
         % {"login": click.style(login, bold=True)},
         nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to retrieve the API token!"
@@ -49,14 +51,17 @@ def login(ctx, opts, login, password):  # pylint: disable=redefined-outer-name
             with maybe_spinner(opts):
                 api_key = get_user_token(login=login, password=password)
     except TwoFactorRequiredException as e:
-        click.echo("\r\033[K", nl=False)
-        click.echo("Two-factor authentication is required.")
+        click.echo("\r\033[K", nl=False, err=use_stderr)
+        click.echo("Two-factor authentication is required.", err=use_stderr)
 
-        totp_token = click.prompt("Enter your two-factor authentication code", type=str)
+        totp_token = click.prompt(
+            "Enter your two-factor authentication code", type=str, err=use_stderr
+        )
         click.echo(
             "Verifying two-factor code for %(login)s ... "
             % {"login": click.style(login, bold=True)},
             nl=False,
+            err=use_stderr,
         )
 
         try:
@@ -69,23 +74,26 @@ def login(ctx, opts, login, password):  # pylint: disable=redefined-outer-name
                         two_factor_token=e.two_factor_token,
                     )
         except cloudsmith_api.rest.ApiException:
-            click.echo("\r\033[K", nl=False)
+            click.echo("\r\033[K", nl=False, err=use_stderr)
             click.secho(
-                "Authentication failed: The entered TOTP token is not valid.", fg="red"
+                "Authentication failed: The entered TOTP token is not valid.",
+                fg="red",
+                err=use_stderr,
             )
             ctx.exit(1)
 
     except cloudsmith_api.rest.ApiException as e:
-        click.echo("\r\033[K", nl=False)
-        click.secho(f"Authentication failed: {str(e)}", fg="red")
+        click.echo("\r\033[K", nl=False, err=use_stderr)
+        click.secho(f"Authentication failed: {str(e)}", fg="red", err=use_stderr)
         ctx.exit(1)
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
 
-    click.echo(
-        "Your API key/token is: %(token)s"
-        % {"token": click.style(api_key, fg="magenta")}
-    )
+    if not utils.maybe_print_as_json(opts, {"token": api_key, "login": login}):
+        click.echo(
+            "Your API key/token is: %(token)s"
+            % {"token": click.style(api_key, fg="magenta")}
+        )
 
     create, has_errors = create_config_files(ctx, opts, api_key=api_key)
     new_config_messaging(has_errors, opts, create, api_key=api_key)

cloudsmith_cli/cli/commands/metrics/entitlements.py

@@ -109,8 +109,8 @@ def usage(ctx, opts, owner_repo, tokens, start, finish):
     If REPO isn't specified, all repositories will be included from the
     OWNER namespace.
     """
-    # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+
+    use_stderr = utils.should_use_stderr(opts)
 
     click.echo("Getting usage metrics ... ", nl=False, err=use_stderr)
 

cloudsmith_cli/cli/commands/metrics/packages.py

@@ -106,7 +106,7 @@ def usage(ctx, opts, owner_repo, packages, start, finish):
     metrics for that namespace/repository combination.
     """
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    use_stderr = utils.should_use_stderr(opts)
 
     click.echo("Getting usage metrics ... ", nl=False, err=use_stderr)
 

cloudsmith_cli/cli/commands/move.py

@@ -70,12 +70,16 @@ def move(
         "dest": click.style(destination, bold=True),
     }
 
+    use_stderr = utils.should_use_stderr(opts)
+
     prompt = "move the %(slug)s from %(source)s to %(dest)s" % move_args
-    if not utils.confirm_operation(prompt, assume_yes=yes):
+    if not utils.confirm_operation(prompt, assume_yes=yes, err=use_stderr):
         return
 
     click.echo(
-        "Moving %(slug)s package from %(source)s to %(dest)s ... " % move_args, nl=False
+        "Moving %(slug)s package from %(source)s to %(dest)s ... " % move_args,
+        nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to move package!"
@@ -87,9 +91,10 @@ def move(
                 owner=owner, repo=source, identifier=slug, destination=destination
             )
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
 
     if no_wait_for_sync:
+        utils.maybe_print_status_json(opts, {"slug": new_slug, "status": "OK"})
         return
 
     wait_for_package_sync(
@@ -102,3 +107,5 @@ def move(
         skip_errors=skip_errors,
         attempts=sync_attempts,
     )
+
+    utils.maybe_print_status_json(opts, {"slug": new_slug, "status": "OK"})