feat: migrate config from JSON to YAML

lzwjava · lzwjava · commit dfa7bf72d747 · 2026-06-08T03:03:59.000+08:00
- Replace json with pyyaml (pyyaml&gt;=6.0) in config.py and auth.py
- Default config path: ~/.config/iclaw/config.json → config.yaml
- Update all tests (test_config, test_main, integration_tests/test_repl)
- Update docs (README, CLAUDE.md, specs, plans)
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -42,7 +42,7 @@ GITHUB_TOKEN_INTEGRATION=<token> python3 -m unittest discover integration_tests
 ## Architecture
 
 **Authentication flow:**
-1. `iclaw-login` runs GitHub OAuth Device Flow → saves `github_token` to `~/.config/iclaw/config.json`
+1. `iclaw-login` runs GitHub OAuth Device Flow → saves `github_token` to `~/.config/iclaw/config.yaml`
 2. `iclaw` startup reads the token via `iclaw/config.py:load_github_token()`, then exchanges it for a short-lived Copilot token (`iclaw/github_api.py:get_copilot_token()`)
 3. The Copilot token is refreshed every `TOKEN_REFRESH_INTERVAL` seconds (24 min) during the session
 
diff --git a/README.md b/README.md
@@ -46,8 +46,8 @@ pip install -e .
    ```
    /provider_model
    ```
-   - **Copilot**: select option 1, follow the GitHub device authorization flow. Your token is saved to `~/.config/iclaw/config.json`.
-   - **OpenRouter**: select option 2. iclaw reads `OPENROUTER_API_KEY` from the environment, or prompts for a key and saves it to `~/.config/iclaw/config.json`.
+   - **Copilot**: select option 1, follow the GitHub device authorization flow. Your token is saved to `~/.config/iclaw/config.yaml`.
+   - **OpenRouter**: select option 2. iclaw reads `OPENROUTER_API_KEY` from the environment, or prompts for a key and saves it to `~/.config/iclaw/config.yaml`.
 
 ### CLI Commands
 - `/provider_model`: Select and authenticate with the model provider.
diff --git a/README_CN.md b/README_CN.md
@@ -34,7 +34,7 @@ pip install -e .
    ```
    /provider_model
    ```
-   选择 `copilot`，然后按照 GitHub 设备授权流程操作。令牌将保存到 `~/.config/iclaw/config.json`。
+   选择 `copilot`，然后按照 GitHub 设备授权流程操作。令牌将保存到 `~/.config/iclaw/config.yaml`。
 
 ### 终端命令
 - `/provider_model`: 选择并认证模型提供商。
diff --git a/docs/superpowers/plans/2026-03-29-log-command.md b/docs/superpowers/plans/2026-03-29-log-command.md
@@ -4,7 +4,7 @@
 
 **Goal:** Add a `/log` command with `verbose`/`info` levels to control REPL output verbosity.
 
-**Architecture:** Central `log.py` module with `log_info()`/`log_verbose()` functions. All `print()` calls in tool modules replaced with these. Level persisted to config.json.
+**Architecture:** Central `log.py` module with `log_info()`/`log_verbose()` functions. All `print()` calls in tool modules replaced with these. Level persisted to config.yaml.
 
 **Tech Stack:** Python 3, unittest, prompt_toolkit (existing)
 
diff --git a/docs/superpowers/specs/2026-03-29-log-command-design.md b/docs/superpowers/specs/2026-03-29-log-command-design.md
@@ -22,7 +22,7 @@ New module providing centralized log output control.
 - `/log verbose` — sets level to VERBOSE
 - `/log info` — sets level to INFO
 - `/log <invalid>` — prints "Unknown log level: <invalid>. Use 'verbose' or 'info'."
-- Persisted to `config.json` as `"log_level": "verbose"` or `"log_level": "info"`
+- Persisted to `config.yaml` as `log_level: verbose` or `log_level: info`
 - Added to `COMMANDS` list in `completer.py` and `COMMANDS_HELP` in `main.py`
 
 ## Call Site Changes
diff --git a/docs/superpowers/specs/2026-03-29-proxy-ca-bundle-design.md b/docs/superpowers/specs/2026-03-29-proxy-ca-bundle-design.md
@@ -12,7 +12,7 @@ Add `/proxy` and `/ca_bundle` REPL commands that persist settings to config and
 
 ### Configuration (`config.py`)
 
-Two new keys in `~/.config/iclaw/config.json`:
+Two new keys in `~/.config/iclaw/config.yaml`:
 
 - `"proxy"` — string URL (e.g., `"http://127.0.0.1:7890"`) or absent/null when disabled
 - `"ca_bundle"` — string file path (e.g., `"/path/to/ca-cert.pem"`) or absent/null for system default
diff --git a/iclaw/commands/auth.py b/iclaw/commands/auth.py
@@ -1,6 +1,8 @@
-import json
 import sys
 from datetime import datetime, timezone
+
+import yaml
+
 from iclaw.login import get_device_code, poll_for_access_token
 
 
@@ -36,7 +38,9 @@ def handle_login_command(config_path):
             "created_at": datetime.now(timezone.utc).isoformat(),
         }
         config_path.parent.mkdir(parents=True, exist_ok=True)
-        config_path.write_text(json.dumps(config, indent=2))
+        config_path.write_text(
+            yaml.dump(config, default_flow_style=False, sort_keys=False)
+        )
         print(f"\nSaved GitHub token to {config_path}")
         return github_token
 
diff --git a/iclaw/config.py b/iclaw/config.py
@@ -1,8 +1,9 @@
-import json
 import os
 from pathlib import Path
 
-_default_config = Path.home() / ".config" / "iclaw" / "config.json"
+import yaml
+
+_default_config = Path.home() / ".config" / "iclaw" / "config.yaml"
 CONFIG_PATH = Path(os.environ.get("ICLAW_CONFIG_PATH", str(_default_config)))
 TOKEN_REFRESH_INTERVAL = 24 * 60  # seconds
 
@@ -11,14 +12,15 @@ def _load_config() -> dict:
     if not CONFIG_PATH.exists():
         return {}
     try:
-        return json.loads(CONFIG_PATH.read_text())
-    except json.JSONDecodeError:
+        data = yaml.safe_load(CONFIG_PATH.read_text())
+        return data if isinstance(data, dict) else {}
+    except yaml.YAMLError:
         return {}
 
 
 def _save_config(config: dict) -> None:
     CONFIG_PATH.parent.mkdir(parents=True, exist_ok=True)
-    CONFIG_PATH.write_text(json.dumps(config, indent=2))
+    CONFIG_PATH.write_text(yaml.dump(config, default_flow_style=False, sort_keys=False))
 
 
 def load_github_token():
diff --git a/integration_tests/test_repl.py b/integration_tests/test_repl.py
@@ -18,6 +18,8 @@
 import tempfile
 import threading
 import time
+
+import yaml
 import unittest
 from http.server import BaseHTTPRequestHandler, HTTPServer
 
@@ -96,11 +98,11 @@ def stop(self):
 
 
 def _make_config_with_token(token="fake-github-token"):
-    """Write a config.json to a temp file and return its path."""
+    """Write a config.yaml to a temp file and return its path."""
     f = tempfile.NamedTemporaryFile(
-        mode="w", suffix=".json", delete=False, prefix="iclaw_config_"
+        mode="w", suffix=".yaml", delete=False, prefix="iclaw_config_"
     )
-    json.dump({"github_token": token}, f)
+    yaml.dump({"github_token": token}, f, default_flow_style=False, sort_keys=False)
     f.close()
     return f.name
 
@@ -116,7 +118,7 @@ def _make_env(config_path=None, port=None):
     env = os.environ.copy()
     env.pop("PYTHONPATH", None)
     # Point iclaw at the temp config (or a nonexistent path for no-token tests).
-    env["ICLAW_CONFIG_PATH"] = config_path or "/tmp/iclaw_no_such_config.json"
+    env["ICLAW_CONFIG_PATH"] = config_path or "/tmp/iclaw_no_such_config.yaml"
     if port:
         env["ICLAW_GITHUB_API_BASE"] = f"http://127.0.0.1:{port}"
         env["ICLAW_COPILOT_API_BASE"] = f"http://127.0.0.1:{port}"
@@ -186,7 +188,7 @@ def _send(process, text):
 
 
 class TestReplNoToken(unittest.TestCase):
-    """REPL behaviour when no config.json exists."""
+    """REPL behaviour when no config.yaml exists."""
 
     def setUp(self):
         self.process = _start_repl(_make_env())  # no config_path → no token
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,7 +8,7 @@ version = "0.1.0"
 description = "Interactive CLI REPL for chatting with GitHub Copilot"
 readme = "README.md"
 requires-python = ">=3.8"
-dependencies = ["requests>=2.32.0", "pyperclip>=1.8.0", "beautifulsoup4>=4.12.0", "readability-lxml>=0.8.1", "lxml>=5.0.0", "tavily-python>=0.3.0", "prompt-toolkit>=3.0.0", "playwright>=1.40.0", "rich>=13.0.0"]
+dependencies = ["requests>=2.32.0", "pyperclip>=1.8.0", "beautifulsoup4>=4.12.0", "readability-lxml>=0.8.1", "lxml>=5.0.0", "tavily-python>=0.3.0", "prompt-toolkit>=3.0.0", "playwright>=1.40.0", "rich>=13.0.0", "pyyaml>=6.0"]
 
 [project.scripts]
 iclaw = "iclaw.main:main"
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -1,27 +1,32 @@
-import json
 import unittest
 from unittest.mock import patch, MagicMock
 
+import yaml
+
 from iclaw.config import load_session_settings, save_session_settings
 
 
 class TestConfigProxySettings(unittest.TestCase):
     def test_load_defaults_when_no_proxy_or_ca_bundle(self):
         with patch("iclaw.config.CONFIG_PATH") as mp:
             mp.exists.return_value = True
-            mp.read_text.return_value = json.dumps({"model_provider": "copilot"})
+            mp.read_text.return_value = yaml.dump(
+                {"model_provider": "copilot"}, default_flow_style=False, sort_keys=False
+            )
             settings = load_session_settings()
         self.assertIsNone(settings["proxy"])
         self.assertIsNone(settings["ca_bundle"])
 
     def test_load_proxy_and_ca_bundle_when_set(self):
         with patch("iclaw.config.CONFIG_PATH") as mp:
             mp.exists.return_value = True
-            mp.read_text.return_value = json.dumps(
+            mp.read_text.return_value = yaml.dump(
                 {
                     "proxy": "http://127.0.0.1:8080",
                     "ca_bundle": "/path/to/cert.pem",
-                }
+                },
+                default_flow_style=False,
+                sort_keys=False,
             )
             settings = load_session_settings()
         self.assertEqual(settings["proxy"], "http://127.0.0.1:8080")
@@ -30,7 +35,9 @@ def test_load_proxy_and_ca_bundle_when_set(self):
     def test_save_session_settings_with_proxy_and_ca_bundle(self):
         with patch("iclaw.config.CONFIG_PATH") as mp:
             mp.exists.return_value = True
-            mp.read_text.return_value = json.dumps({"github_token": "gt"})
+            mp.read_text.return_value = yaml.dump(
+                {"github_token": "gt"}, default_flow_style=False, sort_keys=False
+            )
             mp.parent = MagicMock()
             save_session_settings(
                 model_provider="copilot",
@@ -40,15 +47,17 @@ def test_save_session_settings_with_proxy_and_ca_bundle(self):
                 ca_bundle="/path/cert.pem",
                 log_level="verbose",
             )
-            written = json.loads(mp.write_text.call_args[0][0])
+            written = yaml.safe_load(mp.write_text.call_args[0][0])
         self.assertEqual(written["proxy"], "http://proxy:8080")
         self.assertEqual(written["ca_bundle"], "/path/cert.pem")
         self.assertEqual(written["github_token"], "gt")
 
     def test_save_session_settings_clears_null_proxy(self):
         with patch("iclaw.config.CONFIG_PATH") as mp:
             mp.exists.return_value = True
-            mp.read_text.return_value = json.dumps({"proxy": "http://old:1234"})
+            mp.read_text.return_value = yaml.dump(
+                {"proxy": "http://old:1234"}, default_flow_style=False, sort_keys=False
+            )
             mp.parent = MagicMock()
             save_session_settings(
                 model_provider="copilot",
@@ -58,21 +67,25 @@ def test_save_session_settings_clears_null_proxy(self):
                 ca_bundle=None,
                 log_level="verbose",
             )
-            written = json.loads(mp.write_text.call_args[0][0])
+            written = yaml.safe_load(mp.write_text.call_args[0][0])
         self.assertIsNone(written["proxy"])
         self.assertIsNone(written["ca_bundle"])
 
     def test_load_log_level_default(self):
         with patch("iclaw.config.CONFIG_PATH") as mp:
             mp.exists.return_value = True
-            mp.read_text.return_value = json.dumps({})
+            mp.read_text.return_value = yaml.dump(
+                {}, default_flow_style=False, sort_keys=False
+            )
             settings = load_session_settings()
         self.assertEqual(settings["log_level"], "verbose")
 
     def test_load_log_level_set(self):
         with patch("iclaw.config.CONFIG_PATH") as mp:
             mp.exists.return_value = True
-            mp.read_text.return_value = json.dumps({"log_level": "info"})
+            mp.read_text.return_value = yaml.dump(
+                {"log_level": "info"}, default_flow_style=False, sort_keys=False
+            )
             settings = load_session_settings()
         self.assertEqual(settings["log_level"], "info")
 
diff --git a/tests/test_main.py b/tests/test_main.py
@@ -56,10 +56,10 @@ def test_load_github_token_no_config(self):
             mp.exists.return_value = False
             self.assertIsNone(main.load_github_token())
 
-    def test_load_github_token_invalid_json(self):
+    def test_load_github_token_invalid_yaml(self):
         with patch("iclaw.config.CONFIG_PATH") as mp:
             mp.exists.return_value = True
-            mp.read_text.return_value = "not json"
+            mp.read_text.return_value = "not yaml: [invalid"
             self.assertIsNone(main.load_github_token())
 
     @patch("iclaw.main.http")
