Skip to content

Chore: Print a deprecation warning in the sqlmesh ui command #5046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
izeigerman merged 1 commit into from
Jul 29, 2025
Merged

Chore: Print a deprecation warning in the sqlmesh ui command #5046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/guides/ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Browser UI guide

!!! warning

Browser UI is deprecated. Please use the [VSCode extension](vscode.md) instead.


SQLMesh's free, open-source browser user interface (UI) makes it easy to understand, explore, and modify your SQLMesh project.

This page describes the UI's components and how they work.
Expand Down
4 changes: 4 additions & 0 deletions docs/quickstart/ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Browser UI

!!! warning

Browser UI is deprecated. Please use the [VSCode extension](../guides/vscode.md) instead.

In this quickstart, you'll use the SQLMesh browser user interface to get up and running with SQLMesh's scaffold generator. This example project will run locally on your computer using [DuckDB](https://duckdb.org/) as an embedded SQL engine.

??? info "Learn more about the quickstart project structure"
Expand Down
23 changes: 15 additions & 8 deletions sqlmesh/cli/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,14 @@ def cli(
if "--help" in sys.argv:
return

configure_logging(
debug,
log_to_stdout,
log_file_dir=log_file_dir,
ignore_warnings=ignore_warnings,
)
configure_console(ignore_warnings=ignore_warnings)

load = True

if len(paths) == 1:
Expand All @@ -117,14 +125,6 @@ def cli(
if ctx.invoked_subcommand in SKIP_LOAD_COMMANDS:
load = False

configure_logging(
debug,
log_to_stdout,
log_file_dir=log_file_dir,
ignore_warnings=ignore_warnings,
)
configure_console(ignore_warnings=ignore_warnings)

configs = load_configs(config, Context.CONFIG_TYPE, paths, dotenv_path=dotenv)
log_limit = list(configs.values())[0].log_limit

Expand Down Expand Up @@ -884,6 +884,13 @@ def info(obj: Context, skip_connection: bool, verbose: int) -> None:
@cli_analytics
def ui(ctx: click.Context, host: str, port: int, mode: str) -> None:
"""Start a browser-based SQLMesh UI."""
from sqlmesh.core.console import get_console

get_console().log_warning(
"The UI is deprecated and will be removed in a future version. Please use the SQLMesh VSCode extension instead. "
"Learn more at https://sqlmesh.readthedocs.io/en/stable/guides/vscode/"
)

try:
import uvicorn
except ModuleNotFoundError as e:
Expand Down