common/hermes
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

feat(setup): auto-reconfigure on existing installs (#15879)

Browse Source 
Bare `hermes setup` on a returning user now drops straight into the
full reconfigure wizard — every prompt shows the current value as its
default, press Enter to keep or type a new value to change it. The
returning-user menu is gone.

Behavior:
- First-time user: first-time wizard (unchanged)
- Returning user, bare command: full reconfigure wizard (new default)
- Returning user, `--quick`: only prompt for missing/unset items
- Returning user, one section: `hermes setup model|terminal|gateway|tools|agent`
- `--reconfigure`: preserved as backwards-compat alias (no-op since it's now default)

The section functions already used current values as prompt defaults —
this change just removes the extra click to get to them.

The 'Quick Setup - configure missing items only' menu option is now
exposed as the explicit `--quick` flag; it's the narrow case of
filling in missing config (e.g. after a partial OpenClaw migration or
when a required API key got cleared).

Inspired by Mercury Agent's `mercury doctor` UX.

Also removes:
- RETURNING_USER_MENU_SECTION_KEYS (orphaned constant)
- Two returning-user menu tests in test_setup_noninteractive.py
  (guarding behavior that no longer exists — covered by
  test_setup_reconfigure.py instead)
This commit is contained in:
Teknium
2026-04-25 22:02:02 -07:00
committed by GitHub
parent cec0af02ad
commit a55de5bcd0
5 changed files with 335 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
tests/hermes_cli/test_setup_noninteractive.py
View File

@@ -144,91 +144,6 @@ class TestNonInteractiveSetup:
out = capsys.readouterr().out
assert "hermes config set model.provider custom" in out
def test_returning_user_terminal_menu_choice_dispatches_terminal_section(self, tmp_path):
"""Returning-user menu should map Terminal Backend to the terminal setup, not TTS."""
from hermes_cli import setup as setup_mod
args = _make_setup_args()
config = {}
model_section = MagicMock()
tts_section = MagicMock()
terminal_section = MagicMock()
gateway_section = MagicMock()
tools_section = MagicMock()
agent_section = MagicMock()
with (
patch.object(setup_mod, "ensure_hermes_home"),
patch.object(setup_mod, "load_config", return_value=config),
patch.object(setup_mod, "get_hermes_home", return_value=tmp_path),
patch.object(setup_mod, "is_interactive_stdin", return_value=True),
patch.object(
setup_mod,
"get_env_value",
side_effect=lambda key: "sk-test" if key == "OPENROUTER_API_KEY" else "",
),
patch("hermes_cli.auth.get_active_provider", return_value=None),
patch.object(setup_mod, "prompt_choice", return_value=3),
patch.object(
setup_mod,
"SETUP_SECTIONS",
[
("model", "Model & Provider", model_section),
("tts", "Text-to-Speech", tts_section),
("terminal", "Terminal Backend", terminal_section),
("gateway", "Messaging Platforms (Gateway)", gateway_section),
("tools", "Tools", tools_section),
("agent", "Agent Settings", agent_section),
],
),
patch.object(setup_mod, "save_config"),
patch.object(setup_mod, "_print_setup_summary"),
):
setup_mod.run_setup_wizard(args)
terminal_section.assert_called_once_with(config)
tts_section.assert_not_called()
def test_returning_user_menu_does_not_show_separator_rows(self, tmp_path):
"""Returning-user menu should only show selectable actions."""
from hermes_cli import setup as setup_mod
args = _make_setup_args()
captured = {}
def fake_prompt_choice(question, choices, default=0):
captured["question"] = question
captured["choices"] = list(choices)
return len(choices) - 1
with (
patch.object(setup_mod, "ensure_hermes_home"),
patch.object(setup_mod, "load_config", return_value={}),
patch.object(setup_mod, "get_hermes_home", return_value=tmp_path),
patch.object(setup_mod, "is_interactive_stdin", return_value=True),
patch.object(
setup_mod,
"get_env_value",
side_effect=lambda key: "sk-test" if key == "OPENROUTER_API_KEY" else "",
),
patch("hermes_cli.auth.get_active_provider", return_value=None),
patch.object(setup_mod, "prompt_choice", side_effect=fake_prompt_choice),
):
setup_mod.run_setup_wizard(args)
assert captured["question"] == "What would you like to do?"
assert "---" not in captured["choices"]
assert captured["choices"] == [
"Quick Setup - configure missing items only",
"Full Setup - reconfigure everything",
"Model & Provider",
"Terminal Backend",
"Messaging Platforms (Gateway)",
"Tools",
"Agent Settings",
"Exit",
]
def test_main_accepts_tts_setup_section(self, monkeypatch):
"""`hermes setup tts` should parse and dispatch like other setup sections."""
from hermes_cli import main as main_mod

287
tests/hermes_cli/test_setup_reconfigure.py Normal file
View File

@@ -0,0 +1,287 @@
"""Tests for the setup wizard's returning-user behavior.
On an existing install:
- Bare `hermes setup` drops straight into the full reconfigure wizard
(every prompt shows the current value as its default).
- `hermes setup --quick` runs the narrower "fill in missing items" flow.
- `hermes setup --reconfigure` is a backwards-compat alias for the
bare-setup default.
On a fresh install, all three are no-ops — fall through to first-time setup.
"""
from argparse import Namespace
from contextlib import ExitStack
from unittest.mock import patch
import pytest
def _make_setup_args(**overrides):
return Namespace(
non_interactive=overrides.get("non_interactive", False),
section=overrides.get("section", None),
reset=overrides.get("reset", False),
reconfigure=overrides.get("reconfigure", False),
quick=overrides.get("quick", False),
)
@pytest.fixture
def existing_install(tmp_path, monkeypatch):
"""Simulate a returning user with an existing configured install."""
home = tmp_path / ".hermes"
home.mkdir()
monkeypatch.setattr("pathlib.Path.home", lambda: tmp_path)
monkeypatch.setenv("HERMES_HOME", str(home))
return home
@pytest.fixture
def fresh_install(tmp_path, monkeypatch):
"""Simulate a first-time user with no existing configuration."""
home = tmp_path / ".hermes"
home.mkdir()
monkeypatch.setattr("pathlib.Path.home", lambda: tmp_path)
monkeypatch.setenv("HERMES_HOME", str(home))
return home
def _enter_existing_install_patches(stack, **extra):
"""Apply standard existing-install mocks via an ExitStack.
Returns a dict of mocks from the `extra` kwargs (which map mock-name to
target path) so callers can assert on them.
"""
# Unconditional mocks (no return values to assert against).
for target, kwargs in [
("hermes_cli.setup.ensure_hermes_home", {}),
("hermes_cli.setup.is_interactive_stdin", {"return_value": True}),
("hermes_cli.config.is_managed", {"return_value": False}),
("hermes_cli.setup.load_config", {"return_value": {}}),
("hermes_cli.setup.save_config", {}),
("hermes_cli.setup.get_env_value", {"return_value": None}),
("hermes_cli.auth.get_active_provider", {"return_value": "openrouter"}),
("hermes_cli.setup._print_setup_summary", {}),
("hermes_cli.setup._offer_launch_chat", {}),
("hermes_cli.setup._offer_openclaw_migration", {"return_value": False}),
]:
stack.enter_context(patch(target, **kwargs))
# Named mocks caller wants to assert on.
named = {}
for name, target in extra.items():
named[name] = stack.enter_context(patch(target))
return named
def _enter_fresh_install_patches(stack, **extra):
for target, kwargs in [
("hermes_cli.setup.ensure_hermes_home", {}),
("hermes_cli.setup.is_interactive_stdin", {"return_value": True}),
("hermes_cli.config.is_managed", {"return_value": False}),
("hermes_cli.setup.load_config", {"return_value": {}}),
("hermes_cli.setup.save_config", {}),
("hermes_cli.auth.get_active_provider", {"return_value": None}),
("hermes_cli.setup.get_env_value", {"return_value": None}),
("hermes_cli.setup._offer_openclaw_migration", {"return_value": False}),
]:
stack.enter_context(patch(target, **kwargs))
named = {}
for name, target_spec in extra.items():
if isinstance(target_spec, tuple):
target, kwargs = target_spec
named[name] = stack.enter_context(patch(target, **kwargs))
else:
named[name] = stack.enter_context(patch(target_spec))
return named
class TestExistingInstallDefault:
"""Bare `hermes setup` on an existing install = full reconfigure wizard."""
def test_bare_setup_runs_full_reconfigure_without_menu(self, existing_install):
"""No menu, no prompt_choice — just run every section in sequence."""
args = _make_setup_args() # no flags
with ExitStack() as stack:
m = _enter_existing_install_patches(
stack,
prompt_choice="hermes_cli.setup.prompt_choice",
quick="hermes_cli.setup._run_quick_setup",
model="hermes_cli.setup.setup_model_provider",
terminal="hermes_cli.setup.setup_terminal_backend",
agent="hermes_cli.setup.setup_agent_settings",
gateway="hermes_cli.setup.setup_gateway",
tools="hermes_cli.setup.setup_tools",
)
from hermes_cli.setup import run_setup_wizard
run_setup_wizard(args)
# No menu shown.
m["prompt_choice"].assert_not_called()
# Quick-setup path NOT taken.
m["quick"].assert_not_called()
# All five sections ran.
m["model"].assert_called_once()
m["terminal"].assert_called_once()
m["agent"].assert_called_once()
m["gateway"].assert_called_once()
m["tools"].assert_called_once()
def test_reconfigure_flag_is_backwards_compat_noop(self, existing_install):
"""`hermes setup --reconfigure` behaves the same as bare `hermes setup`."""
args = _make_setup_args(reconfigure=True)
with ExitStack() as stack:
m = _enter_existing_install_patches(
stack,
prompt_choice="hermes_cli.setup.prompt_choice",
model="hermes_cli.setup.setup_model_provider",
terminal="hermes_cli.setup.setup_terminal_backend",
agent="hermes_cli.setup.setup_agent_settings",
gateway="hermes_cli.setup.setup_gateway",
tools="hermes_cli.setup.setup_tools",
)
from hermes_cli.setup import run_setup_wizard
run_setup_wizard(args)
m["prompt_choice"].assert_not_called()
m["model"].assert_called_once()
m["terminal"].assert_called_once()
m["agent"].assert_called_once()
m["gateway"].assert_called_once()
m["tools"].assert_called_once()
class TestQuickFlag:
"""`--quick` on an existing install runs the fill-missing flow."""
def test_quick_flag_runs_quick_setup_only(self, existing_install):
args = _make_setup_args(quick=True)
with ExitStack() as stack:
m = _enter_existing_install_patches(
stack,
quick="hermes_cli.setup._run_quick_setup",
model="hermes_cli.setup.setup_model_provider",
terminal="hermes_cli.setup.setup_terminal_backend",
agent="hermes_cli.setup.setup_agent_settings",
gateway="hermes_cli.setup.setup_gateway",
tools="hermes_cli.setup.setup_tools",
)
from hermes_cli.setup import run_setup_wizard
run_setup_wizard(args)
m["quick"].assert_called_once()
# Full reconfigure sections must NOT run.
m["model"].assert_not_called()
m["terminal"].assert_not_called()
m["agent"].assert_not_called()
m["gateway"].assert_not_called()
m["tools"].assert_not_called()
class TestFreshInstall:
"""On a fresh install (no active provider), flags are no-ops."""
def test_bare_setup_runs_first_time_flow(self, fresh_install):
args = _make_setup_args()
with ExitStack() as stack:
m = _enter_fresh_install_patches(
stack,
prompt=("hermes_cli.setup.prompt_choice", {"return_value": 0}),
first="hermes_cli.setup._run_first_time_quick_setup",
)
from hermes_cli.setup import run_setup_wizard
run_setup_wizard(args)
m["prompt"].assert_called_once() # quick-vs-full prompt
m["first"].assert_called_once()
def test_reconfigure_on_fresh_install_falls_through(self, fresh_install):
args = _make_setup_args(reconfigure=True)
with ExitStack() as stack:
m = _enter_fresh_install_patches(
stack,
prompt=("hermes_cli.setup.prompt_choice", {"return_value": 0}),
first="hermes_cli.setup._run_first_time_quick_setup",
)
from hermes_cli.setup import run_setup_wizard
run_setup_wizard(args)
m["prompt"].assert_called_once()
m["first"].assert_called_once()
def test_quick_on_fresh_install_falls_through(self, fresh_install):
args = _make_setup_args(quick=True)
with ExitStack() as stack:
m = _enter_fresh_install_patches(
stack,
prompt=("hermes_cli.setup.prompt_choice", {"return_value": 0}),
first="hermes_cli.setup._run_first_time_quick_setup",
)
from hermes_cli.setup import run_setup_wizard
run_setup_wizard(args)
m["prompt"].assert_called_once()
m["first"].assert_called_once()
class TestArgparse:
"""The flags are plumbed through argparse to cmd_setup."""
def test_reconfigure_flag_reaches_cmd_setup(self, monkeypatch):
import sys
from hermes_cli.main import main
captured = {}
monkeypatch.setattr(
"hermes_cli.setup.run_setup_wizard",
lambda args: captured.setdefault("args", args),
)
monkeypatch.setattr(sys, "argv", ["hermes", "setup", "--reconfigure"])
try:
main()
except SystemExit:
pass
assert captured["args"].reconfigure is True
assert captured["args"].quick is False
def test_quick_flag_reaches_cmd_setup(self, monkeypatch):
import sys
from hermes_cli.main import main
captured = {}
monkeypatch.setattr(
"hermes_cli.setup.run_setup_wizard",
lambda args: captured.setdefault("args", args),
)
monkeypatch.setattr(sys, "argv", ["hermes", "setup", "--quick"])
try:
main()
except SystemExit:
pass
assert captured["args"].quick is True
assert captured["args"].reconfigure is False
def test_bare_setup_has_both_flags_false(self, monkeypatch):
import sys
from hermes_cli.main import main
captured = {}
monkeypatch.setattr(
"hermes_cli.setup.run_setup_wizard",
lambda args: captured.setdefault("args", args),
)
monkeypatch.setattr(sys, "argv", ["hermes", "setup"])
try:
main()
except SystemExit:
pass
assert captured["args"].reconfigure is False
assert captured["args"].quick is False