[Feature]: Add JSON output option for CLI commands #3322 (WIP)

`dstack ps` support

Author: peterschmidt85

src/dstack/_internal/cli/commands/ps.py

@@ -10,6 +10,7 @@
     LIVE_TABLE_REFRESH_RATE_PER_SEC,
     console,
 )
+from dstack._internal.core.errors import CLIError
 
 
 class PsCommand(APIBaseCommand):
@@ -43,12 +44,31 @@ def _register(self):
             type=int,
             default=None,
         )
+        self._parser.add_argument(
+            "--format",
+            choices=["plain", "json"],
+            default="plain",
+            help="Output format (default: plain)",
+        )
+        self._parser.add_argument(
+            "--json",
+            action="store_const",
+            const="json",
+            dest="format",
+            help="Output in JSON format (equivalent to --format json)",
+        )
 
     def _command(self, args: argparse.Namespace):
         super()._command(args)
+        if args.watch and args.format == "json":
+            raise CLIError("JSON output is not supported together with --watch")
+
         runs = self.api.runs.list(all=args.all, limit=args.last)
         if not args.watch:
-            console.print(run_utils.get_runs_table(runs, verbose=args.verbose))
+            if args.format == "json":
+                run_utils.print_runs_json(self.api.project, runs)
+            else:
+                console.print(run_utils.get_runs_table(runs, verbose=args.verbose))
             return
 
         try:

src/dstack/_internal/cli/models/runs.py

@@ -0,0 +1,16 @@
+from typing import List
+
+from dstack._internal.core.models.common import CoreConfig, generate_dual_core_model
+from dstack._internal.core.models.runs import Run
+from dstack._internal.utils.json_utils import pydantic_orjson_dumps_with_indent
+
+
+class PsCommandOutputConfig(CoreConfig):
+    json_dumps = pydantic_orjson_dumps_with_indent
+
+
+class PsCommandOutput(generate_dual_core_model(PsCommandOutputConfig)):
+    """JSON output model for `dstack ps` command."""
+
+    project: str
+    runs: List[Run]

src/dstack/_internal/cli/utils/run.py

@@ -5,6 +5,7 @@
 from rich.table import Table
 
 from dstack._internal.cli.models.offers import OfferCommandOutput, OfferRequirements
+from dstack._internal.cli.models.runs import PsCommandOutput
 from dstack._internal.cli.utils.common import NO_OFFERS_WARNING, add_row_from_dict, console
 from dstack._internal.core.models.backends.base import BackendType
 from dstack._internal.core.models.configurations import DevEnvironmentConfiguration
@@ -64,6 +65,15 @@ def print_offers_json(run_plan: RunPlan, run_spec):
     print(output.json())
 
 
+def print_runs_json(project: str, runs: List[Run]) -> None:
+    """Print runs information in JSON format."""
+    output = PsCommandOutput(
+        project=project,
+        runs=[r._run for r in runs],
+    )
+    print(output.json())
+
+
 def print_run_plan(
     run_plan: RunPlan, max_offers: Optional[int] = None, include_run_properties: bool = True
 ):