Feat: Add environments command to list environments

docs/reference/cli.md

@@ -25,6 +25,7 @@ Commands:
   dag                     Render the DAG as an html file.
   diff                    Show the diff between the local state and the...
   dlt_refresh             Attaches to a DLT pipeline with the option to...
+  environments            Prints the list of SQLMesh environments with...
   evaluate                Evaluate a model and return a dataframe with a...
   fetchdf                 Run a SQL query and display the results.
   format                  Format all SQL models and audits.
@@ -146,6 +147,17 @@ Options:
   --help  Show this message and exit.
 ```
 
+## environments
+```
+Usage: sqlmesh environments [OPTIONS]
+
+  Prints the list of SQLMesh environments with its expiration datetime.
+
+Options:
+  -e, --expiry-ds  Prints the expiration datetime of the environments.
+  --help           Show this message and exit.
+```
+
 ## evaluate
 
 ```

docs/reference/notebook.md

@@ -243,6 +243,14 @@ options:
   --force, -f              If set it will overwrite existing models with the new generated models from the DLT tables.
 ```
 
+#### environments
+```
+%environments [--expiry-ds]
+Prints the list of SQLMesh environments with its expiration datetime.
+options:
+  --expiry-ds, -e  If set will print the expiration datetime of the environments
+```
+
 #### fetchdf
 ```
 %%fetchdf [df_var]

sqlmesh/cli/main.py

@@ -14,7 +14,7 @@
 from sqlmesh.core.analytics import cli_analytics
 from sqlmesh.core.config import load_configs
 from sqlmesh.core.context import Context
-from sqlmesh.utils.date import TimeLike
+from sqlmesh.utils.date import TimeLike, time_like_to_str
 from sqlmesh.utils.errors import MissingDependencyError
 
 logger = logging.getLogger(__name__)
@@ -966,3 +966,30 @@ def dlt_refresh(
         ctx.obj.console.log_success(f"Updated SQLMesh project with models:\n{model_names}")
     else:
         ctx.obj.console.log_success("All SQLMesh models are up to date.")
+
+
+@cli.command("environments")
+@click.option(
+    "-e",
+    "--expiry-ds",
+    is_flag=True,
+    help="Prints the expiration datetime of the environments.",
+    default=False,
+)
+@click.pass_obj
+@error_handler
+@cli_analytics
+def environments(obj: Context, expiry_ds: bool) -> None:
+    """Prints the list of SQLMesh environments with its expiration datetime."""
+    environments = {e.name: e.expiration_ts for e in obj.state_sync.get_environments()}
+    environment_names = list(environments.keys())
+    if expiry_ds:
+        max_width = len(max(environment_names, key=len))
+        print(
+            "\n".join(
+                f"{k:<{max_width}} {time_like_to_str(v)}" if v else f"{k:<{max_width}} no-expiry"
+                for k, v in environments.items()
+            ),
+        )
+        return
+    print("\n".join(environment_names))

sqlmesh/magics.py

@@ -29,7 +29,7 @@
 from sqlmesh.core.dialect import format_model_expressions, parse
 from sqlmesh.core.model import load_sql_based_model
 from sqlmesh.core.test import ModelTestMetadata, get_all_model_tests
-from sqlmesh.utils import sqlglot_dialects, yaml
+from sqlmesh.utils import date, sqlglot_dialects, yaml
 from sqlmesh.utils.errors import MagicError, MissingContextException, SQLMeshError
 
 logger = logging.getLogger(__name__)
@@ -1007,6 +1007,33 @@ def clean(self, context: Context, line: str) -> None:
         context.clear_caches()
         context.console.log_success("SQLMesh cache and build artifacts cleared")
 
+    @magic_arguments()
+    @argument(
+        "--expiry-ds",
+        "-e",
+        action="store_true",
+        help="Prints the expiration datetime of the environments.",
+    )
+    @line_magic
+    @pass_sqlmesh_context
+    def environments(self, context: Context, line: str) -> None:
+        """Prints the list of SQLMesh environments with its expiration datetime."""
+        args = parse_argstring(self.environments, line)
+        environments = {e.name: e.expiration_ts for e in context.state_sync.get_environments()}
+        environment_names = list(environments.keys())
+        if args.expiry_ds:
+            max_width = len(max(environment_names, key=len))
+            context.console.log_status_update(
+                "\n".join(
+                    f"{k:<{max_width}} {date.time_like_to_str(v)}"
+                    if v
+                    else f"{k:<{max_width}} no-expiry"
+                    for k, v in environments.items()
+                ),
+            )
+            return
+        context.console.log_status_update("\n".join(environment_names))
+
 
 def register_magics() -> None:
     try:

tests/cli/test_cli.py

@@ -11,7 +11,7 @@
 from sqlmesh.cli.main import cli
 from sqlmesh.core.context import Context
 from sqlmesh.integrations.dlt import generate_dlt_models
-from sqlmesh.utils.date import yesterday_ds
+from sqlmesh.utils.date import now_ds, time_like_to_str, timedelta, to_datetime, yesterday_ds
 
 FREEZE_TIME = "2023-01-01 00:00:00 UTC"
 
@@ -971,3 +971,68 @@ def test_init_project_dialects(runner, tmp_path):
             assert config == f"{config_start}{expected_config}{config_end}"
 
             remove(tmp_path / "config.yaml")
+
+
+def test_environments(runner, tmp_path):
+    create_example_project(tmp_path)
+
+    # create dev environment and backfill
+    runner.invoke(
+        cli,
+        [
+            "--log-file-dir",
+            tmp_path,
+            "--paths",
+            tmp_path,
+            "plan",
+            "dev",
+            "--no-prompts",
+            "--auto-apply",
+        ],
+    )
+
+    # # create dev2 environment from dev environment
+    # # Input: `y` to apply and virtual update
+    runner.invoke(
+        cli,
+        [
+            "--log-file-dir",
+            tmp_path,
+            "--paths",
+            tmp_path,
+            "plan",
+            "dev2",
+            "--create-from",
+            "dev",
+            "--include-unmodified",
+        ],
+        input="y\n",
+    )
+
+    result = runner.invoke(
+        cli,
+        [
+            "--log-file-dir",
+            tmp_path,
+            "--paths",
+            tmp_path,
+            "environments",
+        ],
+    )
+    assert result.exit_code == 0
+    assert result.output == "dev\ndev2\n"
+
+    result = runner.invoke(
+        cli,
+        [
+            "--log-file-dir",
+            tmp_path,
+            "--paths",
+            tmp_path,
+            "environments",
+            "--expiry-ds",
+        ],
+    )
+    assert result.exit_code == 0
+    ttl = time_like_to_str(to_datetime(now_ds()) + timedelta(days=7))
+    assert result.output == f"dev  {ttl}\ndev2 {ttl}\n"