Files
ZY-Agent/scripts/setup_wizard.py
1445043649 eae0190184 feat(wizard): add Postgres backend question to setup wizard
setup_wizard.py 在 Step 3 (Execution) 之后新增一个 Database 问答:
"Use Postgres? (y = postgres, n = sqlite)",默认 y(Stage 0+ 推荐 PG)。
选 y 时引导填 DATABASE_URL(可留空稍后写 .env);DATABASE_URL 进 .env,
config.yaml 写入 database.backend=postgres + postgres_url=\$DATABASE_URL。

writer.py build_minimal_config 加 database_backend 参数,postgres 时
覆盖 base_config 的 database 段;默认 sqlite 时沿用 base_config 行为
(继承 config.example.yaml 的 sqlite_dir 等)。

minimal pattern:不新建 wizard/steps/database.py,inline 在 main 里加 1
问答 + writer 加 1 参数。后续如果需要更复杂数据库选项再升为完整 step 模块。

Stage 0 PR1 T1.8.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-10 22:55:19 +08:00

196 lines
7.5 KiB
Python

#!/usr/bin/env python3
"""DeerFlow Interactive Setup Wizard.
Usage:
uv run python scripts/setup_wizard.py
"""
from __future__ import annotations
import sys
from pathlib import Path
# Make the scripts/ directory importable so wizard.* works
sys.path.insert(0, str(Path(__file__).resolve().parent))
def _is_interactive() -> bool:
return sys.stdin.isatty() and sys.stdout.isatty()
def main() -> int:
try:
if not _is_interactive():
print(
"Non-interactive environment detected.\n"
"Please edit config.yaml and .env directly, or run 'make setup' in a terminal."
)
return 1
from wizard.ui import (
ask_yes_no,
bold,
cyan,
green,
print_header,
print_info,
print_success,
yellow,
)
from wizard.writer import write_config_yaml, write_env_file
project_root = Path(__file__).resolve().parents[1]
config_path = project_root / "config.yaml"
env_path = project_root / ".env"
print()
print(bold("Welcome to DeerFlow Setup!"))
print("This wizard will help you configure DeerFlow in a few minutes.")
print()
if config_path.exists():
print(yellow("Existing configuration detected."))
print()
should_reconfigure = ask_yes_no("Do you want to reconfigure?", default=False)
if not should_reconfigure:
print()
print_info("Keeping existing config. Run 'make doctor' to verify your setup.")
return 0
print()
total_steps = 4
from wizard.steps.llm import run_llm_step
llm = run_llm_step(f"Step 1/{total_steps}")
from wizard.steps.search import run_search_step
search = run_search_step(f"Step 2/{total_steps}")
search_provider = search.search_provider
search_api_key = search.search_api_key
fetch_provider = search.fetch_provider
fetch_api_key = search.fetch_api_key
from wizard.steps.execution import run_execution_step
execution = run_execution_step(f"Step 3/{total_steps}")
# Database backend (Stage 0+ recommends Postgres; SQLite kept as
# offline dev fallback). Inline question rather than a separate
# wizard step — minimal addition, full step module can come later.
print()
print_header("Database backend")
print("Stage 0+ recommends Postgres for parity with production.")
print("SQLite is kept as an offline dev fallback.")
print()
use_postgres = ask_yes_no("Use Postgres? (y = postgres, n = sqlite)", default=True)
database_backend = "postgres" if use_postgres else "sqlite"
database_url: str | None = None
if use_postgres:
print()
print_info(
"Set DATABASE_URL in your .env file. Example:\n"
" postgresql+asyncpg://deerflow:deerflow_dev@localhost:5432/deerflow\n"
"Or for a remote RDS:\n"
" postgresql+asyncpg://USER:PASS@HOST:5432/DB"
)
print()
try:
raw = input("DATABASE_URL (leave blank to set later in .env): ").strip()
except EOFError:
raw = ""
if raw:
database_url = raw
print_header(f"Step {total_steps}/{total_steps} · Writing configuration")
write_config_yaml(
config_path,
provider_use=llm.provider.use,
model_name=llm.model_name,
display_name=f"{llm.provider.display_name} / {llm.model_name}",
api_key_field=llm.provider.api_key_field,
env_var=llm.provider.env_var,
extra_model_config=llm.provider.extra_config or None,
base_url=llm.base_url,
search_use=search_provider.use if search_provider else None,
search_tool_name=search_provider.tool_name if search_provider else "web_search",
search_extra_config=search_provider.extra_config if search_provider else None,
web_fetch_use=fetch_provider.use if fetch_provider else None,
web_fetch_tool_name=fetch_provider.tool_name if fetch_provider else "web_fetch",
web_fetch_extra_config=fetch_provider.extra_config if fetch_provider else None,
sandbox_use=execution.sandbox_use,
allow_host_bash=execution.allow_host_bash,
include_bash_tool=execution.include_bash_tool,
include_write_tools=execution.include_write_tools,
database_backend=database_backend,
)
print_success(f"Config written to: {config_path.relative_to(project_root)}")
if not env_path.exists():
env_example = project_root / ".env.example"
if env_example.exists():
import shutil
shutil.copyfile(env_example, env_path)
env_pairs: dict[str, str] = {}
if llm.api_key:
env_pairs[llm.provider.env_var] = llm.api_key
if search_api_key and search_provider and search_provider.env_var:
env_pairs[search_provider.env_var] = search_api_key
if fetch_api_key and fetch_provider and fetch_provider.env_var:
env_pairs[fetch_provider.env_var] = fetch_api_key
if database_url:
env_pairs["DATABASE_URL"] = database_url
if env_pairs:
write_env_file(env_path, env_pairs)
print_success(f"API keys written to: {env_path.relative_to(project_root)}")
frontend_env = project_root / "frontend" / ".env"
frontend_env_example = project_root / "frontend" / ".env.example"
if not frontend_env.exists() and frontend_env_example.exists():
import shutil
shutil.copyfile(frontend_env_example, frontend_env)
print_success("frontend/.env created from example")
print_header("Setup complete!")
print(f" {green('✓')} LLM: {llm.provider.display_name} / {llm.model_name}")
if search_provider:
print(f" {green('✓')} Web search: {search_provider.display_name}")
else:
print(f" {'—':>3} Web search: not configured")
if fetch_provider:
print(f" {green('✓')} Web fetch: {fetch_provider.display_name}")
else:
print(f" {'—':>3} Web fetch: not configured")
sandbox_label = "Local sandbox" if execution.sandbox_use.endswith("LocalSandboxProvider") else "Container sandbox"
print(f" {green('✓')} Execution: {sandbox_label}")
if execution.include_bash_tool:
bash_label = "enabled"
if execution.allow_host_bash:
bash_label += " (host bash)"
print(f" {green('✓')} Bash: {bash_label}")
else:
print(f" {'—':>3} Bash: disabled")
if execution.include_write_tools:
print(f" {green('✓')} File write: enabled")
else:
print(f" {'—':>3} File write: disabled")
print()
print("Next steps:")
print(f" {cyan('make install')} # Install dependencies (first time only)")
print(f" {cyan('make dev')} # Start DeerFlow")
print()
print(f"Run {cyan('make doctor')} to verify your setup at any time.")
print()
return 0
except KeyboardInterrupt:
print("\n\nSetup cancelled.")
return 130
if __name__ == "__main__":
sys.exit(main())