Merge pull request #51 from reacher-z/star-prompt

Add Star-us prompts across TUI, CLI, and README

Author: reacher-z

README.md

@@ -546,6 +546,27 @@ If you use ClawBench in your research, please cite:
 </tr>
 </table>
 
+## Support ClawBench
+
+If ClawBench is useful for your research or product work,
+the single most helpful thing you can do is **[star the repo](https://github.com/reacher-z/ClawBench)** —
+it surfaces the benchmark to other AI-agent researchers and helps us justify
+continued dataset curation.
+
+<p align="center">
+<a href="https://github.com/reacher-z/ClawBench">
+<img src="https://img.shields.io/badge/%E2%98%85%20Star%20this%20repo-181717?style=for-the-badge&logo=github&logoColor=white" alt="Star this repo">
+</a>
+</p>
+
+Open to contributions — new test cases, bug fixes, or evaluation submissions for a model we haven't scored yet. See [`CONTRIBUTING.md`](CONTRIBUTING.md).
+
+<p align="center">
+<a href="https://github.com/reacher-z/ClawBench/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=reacher-z/ClawBench" alt="Contributors">
+</a>
+</p>
+
 ## Star History
 
 <a href="https://star-history.com/#reacher-z/ClawBench&Date">

README.zh-CN.md

@@ -546,6 +546,26 @@ uv run --project test-driver test-driver/batch.py --all-models --case-range 1-50
 </tr>
 </table>
 
+## 支持 ClawBench
+
+如果 ClawBench 对你的研究或产品工作有帮助，
+最有用的支持就是**[给仓库点一个 Star](https://github.com/reacher-z/ClawBench)** ——
+这能让更多 AI agent 研究者发现这个 benchmark，也帮我们持续投入数据集维护。
+
+<p align="center">
+<a href="https://github.com/reacher-z/ClawBench">
+<img src="https://img.shields.io/badge/%E2%98%85%20Star%20this%20repo-181717?style=for-the-badge&logo=github&logoColor=white" alt="Star this repo">
+</a>
+</p>
+
+欢迎贡献 —— 新的 test case、bug 修复，或者是我们还没评测过的模型结果提交。参见 [`CONTRIBUTING.md`](CONTRIBUTING.md)。
+
+<p align="center">
+<a href="https://github.com/reacher-z/ClawBench/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=reacher-z/ClawBench" alt="Contributors">
+</a>
+</p>
+
 ## Star 历史
 
 <a href="https://star-history.com/#reacher-z/ClawBench&Date">

src/clawbench/batch.py

@@ -594,6 +594,9 @@ def on_signal() -> None:
                 hf_env,
             )
 
+    from clawbench.support import print_star_prompt
+    print_star_prompt()
+
     has_errors = any(j.status == "error" for j in jobs)
     return 1 if has_errors else 0
 

src/clawbench/run.py

@@ -998,6 +998,8 @@ def handle_sigint(sig, frame):
 
     if intercepted:
         print(f"\nINTERCEPTED — results in {output_dir}")
+        from clawbench.support import print_star_prompt
+        print_star_prompt()
     else:
         print(f"\nNOT INTERCEPTED — results in {output_dir}")
         sys.exit(1)

src/clawbench/support.py

@@ -0,0 +1,41 @@
+"""User-facing 'support us' prompts shared across run / batch / tui.
+
+A benchmark repo lives or dies by community reach. The cost of a one-line
+star prompt at end-of-run is trivial; the star rate from a user who just
+saw their run succeed is the highest we'll ever get.
+"""
+
+from __future__ import annotations
+
+import os
+import sys
+
+_STAR_URL = "https://github.com/reacher-z/ClawBench"
+
+
+def star_prompt_enabled() -> bool:
+    """Honor ``NO_COLOR``-style opt-out for non-interactive or CI use."""
+    if os.environ.get("CLAWBENCH_NO_STAR"):
+        return False
+    if not sys.stdout.isatty():
+        return False
+    return True
+
+
+def print_star_prompt() -> None:
+    """Plain-stdout variant — used from run.py / batch.py after completion."""
+    if not star_prompt_enabled():
+        return
+    print()
+    print(f"  If ClawBench helped, please star us: {_STAR_URL}")
+
+
+def rich_star_prompt(console) -> None:
+    """Rich-console variant — used from the TUI so it themes correctly."""
+    if not star_prompt_enabled():
+        return
+    console.print()
+    console.print(
+        f"  [dim]If ClawBench helped, please [bold]star us[/]: "
+        f"[link={_STAR_URL}]{_STAR_URL}[/][/]"
+    )

src/clawbench/tui.py

@@ -665,97 +665,41 @@ def mode_configure() -> None:
 
 
 # ---------------------------------------------------------------------------
-# Mode: Configure secrets
+# Mode: Star on GitHub
 # ---------------------------------------------------------------------------
 
-_SECRET_KEYS: list[tuple[str, str]] = [
-    ("PURELY_MAIL_API_KEY", "PurelyMail API key"),
-    ("PURELY_MAIL_DOMAIN", "PurelyMail domain"),
-    ("HF_TOKEN", "HuggingFace token (optional)"),
-    ("HF_REPO_ID", "HuggingFace dataset repo id (optional)"),
-]
-
-
-def _redact_secret(v: str) -> str:
-    if len(v) <= 4:
-        return "****"
-    return v[:2] + "****" + v[-2:]
-
-
-def _read_secrets_file(path: Path) -> dict[str, str]:
-    out: dict[str, str] = {}
-    if not path.exists():
-        return out
-    for line in path.read_text().splitlines():
-        line = line.strip()
-        if not line or line.startswith("#") or "=" not in line:
-            continue
-        k, v = line.split("=", 1)
-        out[k.strip()] = v.strip().strip('"').strip("'")
-    return out
+_STAR_URL = "https://github.com/reacher-z/ClawBench"
 
 
-def mode_configure_secrets() -> None:
-    """Prompt for PurelyMail + HF credentials and persist to secrets.env.
+def _open_star_page() -> None:
+    """Open the repo page in the user's default browser and print the URL.
 
-    Mirrors ``clawbench configure --secrets`` so TUI users have the same
-    capability without dropping to the CLI. Blank answers keep the existing
-    value; shipped defaults are shown in the clear so a new user can accept
-    them by hitting enter.
+    Browser-open is best-effort (headless VMs, SSH sessions, locked-down
+    kiosks) — we always print the URL so the user can click it from a
+    modern terminal emulator that auto-linkifies http URLs.
     """
-    # Import here — ``clawbench.run`` pulls heavier deps we don't want at
-    # TUI startup, and this screen is cold-path.
-    from clawbench.run import DEFAULT_SECRETS
-
-    target = _paths.user_secrets_path()
-    existing = _read_secrets_file(target)
+    import webbrowser
 
     console.print()
     console.print(Panel(
         Text.assemble(
-            Text("Configure secrets", style="bold"),
-            "\n",
-            Text(f"Writes to {target}", style="dim"),
+            Text("Thanks for using ClawBench", style="bold"),
             "\n",
-            Text("Leave blank to keep the current value.", style="dim"),
+            Text("Stars help other AI-agent researchers find the benchmark.",
+                 style="dim"),
+            "\n\n",
+            Text(_STAR_URL, style="bold"),
         ),
     ))
     console.print()
-
-    updated: dict[str, str] = dict(existing)
-    for key, label in _SECRET_KEYS:
-        cur = existing.get(key, "")
-        default = DEFAULT_SECRETS.get(key, "")
-        if cur:
-            hint = f"  [current: {_redact_secret(cur)}]"
-        elif default:
-            hint = f"  [default: {default}]"
-        else:
-            hint = ""
-        val = questionary.text(
-            f"{label}{hint}",
-            default="",
-            style=STYLE,
-        ).ask()
-        if val is None:
-            console.print("\n[dim]Cancelled.[/]")
-            return
-        val = val.strip()
-        if val:
-            updated[key] = val
-        elif not cur and default:
-            updated[key] = default
-
-    lines = ["# claw-bench secrets — chmod 600", ""]
-    lines += [f'{k}="{v}"' for k, v in updated.items()]
-    target.write_text("\n".join(lines) + "\n", encoding="utf-8")
     try:
-        target.chmod(stat.S_IRUSR | stat.S_IWUSR)
-    except OSError:
-        pass
-
-    console.print()
-    console.print(f"  [green]Wrote {len(updated)} key(s) to {target}[/]")
+        opened = webbrowser.open(_STAR_URL)
+    except Exception:
+        opened = False
+    if opened:
+        console.print("  [dim]Opened in your default browser.[/]")
+    else:
+        console.print("  [dim]Copy the link above to open it manually.[/]")
     console.print()
 
 
@@ -1602,15 +1546,22 @@ def main() -> None:
                 questionary.Choice("Configure models", value="configure"),
                 questionary.Choice("Configure secrets", value="configure_secrets"),
                 questionary.Choice("Change theme", value="theme"),
+                questionary.Choice("Star us on GitHub", value="star"),
                 questionary.Choice("Exit", value="exit"),
             ],
             style=STYLE,
         ).ask()
 
         if mode is None or mode == "exit":
+            from clawbench.support import rich_star_prompt
+            rich_star_prompt(console)
             console.print("\n[dim]Bye.[/]")
             return
 
+        if mode == "star":
+            _open_star_page()
+            continue
+
         if mode == "theme":
             theme = _pick_theme()
             STYLE = _make_style(theme)