drydock-cli 3.1.9__tar.gz → 3.1.10__tar.gz

{drydock_cli-3.1.9/drydock_cli.egg-info → drydock_cli-3.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drydock-cli
-Version: 3.1.9
+Version: 3.1.10
 Summary: Drydock — a local, provider-agnostic terminal coding agent for local LLMs
 Author: Frank Bobe III
 License-Expression: Apache-2.0
@@ -450,15 +450,16 @@ conventions.
 ### Custom system prompt
 
 For standing instructions applied on **every** turn (stronger than the
-per-project `AGENTS.md`, which is framed as optional background), set a custom
-system prompt via either:
-
-- a file: `~/.drydock/system_prompt.md` — write your instructions there, or
-- a config key in `~/.drydock/config.toml`: `system_prompt = "..."`.
-
-The file wins if both are set; contents are capped at 8000 chars. It's injected
-after drydock's base prompt and before any project `AGENTS.md`, and applies in
-both the TUI and CLI.
+per-project `AGENTS.md`, which is framed as optional background), edit
+**`~/.drydock/system_prompt.md`**. Drydock creates this file for you (a
+commented template) on first run, so you never have to know where it lives —
+just open it and write your instructions. It has no effect until you add text
+(the template is all comments, which are ignored).
+
+Prefer keeping it in the config file instead? Set `system_prompt = "..."` in
+`~/.drydock/config.toml`. The `system_prompt.md` file wins if both are set;
+contents are capped at 8000 chars, injected after drydock's base prompt and
+before any project `AGENTS.md`, and apply in both the TUI and CLI.
 
 ## Safety
 

{drydock_cli-3.1.9 → drydock_cli-3.1.10}/README.md

@@ -426,15 +426,16 @@ conventions.
 ### Custom system prompt
 
 For standing instructions applied on **every** turn (stronger than the
-per-project `AGENTS.md`, which is framed as optional background), set a custom
-system prompt via either:
-
-- a file: `~/.drydock/system_prompt.md` — write your instructions there, or
-- a config key in `~/.drydock/config.toml`: `system_prompt = "..."`.
-
-The file wins if both are set; contents are capped at 8000 chars. It's injected
-after drydock's base prompt and before any project `AGENTS.md`, and applies in
-both the TUI and CLI.
+per-project `AGENTS.md`, which is framed as optional background), edit
+**`~/.drydock/system_prompt.md`**. Drydock creates this file for you (a
+commented template) on first run, so you never have to know where it lives —
+just open it and write your instructions. It has no effect until you add text
+(the template is all comments, which are ignored).
+
+Prefer keeping it in the config file instead? Set `system_prompt = "..."` in
+`~/.drydock/config.toml`. The `system_prompt.md` file wins if both are set;
+contents are capped at 8000 chars, injected after drydock's base prompt and
+before any project `AGENTS.md`, and apply in both the TUI and CLI.
 
 ## Safety
 

{drydock_cli-3.1.9 → drydock_cli-3.1.10}/drydock/config.py

@@ -13,6 +13,7 @@ All logic original to Drydock.
 """
 from __future__ import annotations
 
+import re
 import tomllib
 from pathlib import Path
 
@@ -123,23 +124,64 @@ def system_prompt_path() -> Path:
     return Path.home() / ".drydock" / "system_prompt.md"
 
 
+# The template drydock drops at ~/.drydock/system_prompt.md so the file is always
+# THERE and discoverable — the user never has to know the path or filename. It's
+# ALL comments, so it has ZERO effect until the user writes real text below them
+# (load_user_system_prompt strips <!-- --> blocks before use).
+_SYSTEM_PROMPT_TEMPLATE = """\
+<!--
+  Drydock custom system prompt.
+
+  Whatever you write in this file (OUTSIDE these comment blocks) is added to the
+  system prompt on EVERY turn, in both the TUI and CLI — your standing instructions.
+  Examples you might add below:
+    - Always run the test suite after editing code.
+    - Prefer the standard library; avoid adding new dependencies.
+    - State your plan in one sentence before making changes.
+
+  This template has NO effect until you add your own text below this comment.
+  Comment blocks like this one are ignored. Capped at 8000 characters.
+  Restart drydock after editing for changes to take effect.
+-->
+"""
+
+
+def _strip_comments(text: str) -> str:
+    """Drop HTML comment blocks so the shipped template is inert until edited."""
+    return re.sub(r"<!--.*?-->", "", text, flags=re.DOTALL)
+
+
+def ensure_system_prompt_file(config_dir: Path | None = None) -> None:
+    """Create <config_dir>/system_prompt.md (the commented template) if it's absent,
+    so users discover the feature without knowing the path/name. `config_dir`
+    defaults to ~/.drydock. NEVER overwrites an existing file (can't clobber a real
+    prompt) and never raises."""
+    try:
+        p = (config_dir / "system_prompt.md") if config_dir is not None else system_prompt_path()
+        if not p.exists():
+            p.parent.mkdir(parents=True, exist_ok=True)
+            p.write_text(_SYSTEM_PROMPT_TEMPLATE, encoding="utf-8")
+    except OSError:
+        pass
+
+
 def load_user_system_prompt(config: dict | None = None) -> str:
     """The user's custom system prompt, injected every turn as standing orders.
 
-    Source (first non-empty wins): the file ~/.drydock/system_prompt.md, then the
-    inline `system_prompt` config key. Wrapped with a clear header and capped at
-    8000 chars. Returns '' when neither is set. Never raises.
+    Source (first non-empty wins): the file ~/.drydock/system_prompt.md (comment
+    blocks stripped, so the shipped template is inert), then the inline
+    `system_prompt` config key. Wrapped with a clear header and capped at 8000
+    chars. Returns '' when neither has real content. Never raises.
     """
     text = ""
     try:
         p = system_prompt_path()
         if p.exists():
-            text = p.read_text()
+            text = _strip_comments(p.read_text()).strip()
     except OSError:
         text = ""
     if not text and config:
-        text = str(config.get("system_prompt", "") or "")
-    text = text.strip()
+        text = str(config.get("system_prompt", "") or "").strip()
     if not text:
         return ""
     return (
@@ -289,6 +331,10 @@ def resolve(cli_overrides: dict, path: Path | None = None) -> dict:
     has an editable v3 config with a visible endpoint.
     """
     path = path or default_config_path()
+    # Drop the discoverable custom-system-prompt template alongside config.toml so
+    # the user never has to know its path/name. Inert (all comments) until edited;
+    # never overwrites an existing file.
+    ensure_system_prompt_file(path.parent)
     if not path.exists():
         save_file(dict(DEFAULTS), path)
         file_cfg = {}

{drydock_cli-3.1.9 → drydock_cli-3.1.10/drydock_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drydock-cli
-Version: 3.1.9
+Version: 3.1.10
 Summary: Drydock — a local, provider-agnostic terminal coding agent for local LLMs
 Author: Frank Bobe III
 License-Expression: Apache-2.0
@@ -450,15 +450,16 @@ conventions.
 ### Custom system prompt
 
 For standing instructions applied on **every** turn (stronger than the
-per-project `AGENTS.md`, which is framed as optional background), set a custom
-system prompt via either:
-
-- a file: `~/.drydock/system_prompt.md` — write your instructions there, or
-- a config key in `~/.drydock/config.toml`: `system_prompt = "..."`.
-
-The file wins if both are set; contents are capped at 8000 chars. It's injected
-after drydock's base prompt and before any project `AGENTS.md`, and applies in
-both the TUI and CLI.
+per-project `AGENTS.md`, which is framed as optional background), edit
+**`~/.drydock/system_prompt.md`**. Drydock creates this file for you (a
+commented template) on first run, so you never have to know where it lives —
+just open it and write your instructions. It has no effect until you add text
+(the template is all comments, which are ignored).
+
+Prefer keeping it in the config file instead? Set `system_prompt = "..."` in
+`~/.drydock/config.toml`. The `system_prompt.md` file wins if both are set;
+contents are capped at 8000 chars, injected after drydock's base prompt and
+before any project `AGENTS.md`, and apply in both the TUI and CLI.
 
 ## Safety
 

{drydock_cli-3.1.9 → drydock_cli-3.1.10}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 # PyPI distribution name is drydock-cli (the established install name, continued
 # from the retired v2 fork); the import package + CLI command stay `drydock`.
 name = "drydock-cli"
-version = "3.1.9"
+version = "3.1.10"
 description = "Drydock — a local, provider-agnostic terminal coding agent for local LLMs"
 readme = "README.md"
 requires-python = ">=3.11"

{drydock_cli-3.1.9 → drydock_cli-3.1.10}/tests/test_config.py

@@ -125,3 +125,37 @@ def test_user_system_prompt_capped_at_8000(monkeypatch, tmp_path):
 def test_system_prompt_key_in_defaults():
     assert "system_prompt" in cfg.DEFAULTS
     assert cfg.DEFAULTS["system_prompt"] == ""
+
+
+def test_resolve_creates_inert_system_prompt_template(tmp_path):
+    # resolve() drops the template next to config.toml, and it has NO effect until edited
+    cfgpath = tmp_path / "config.toml"
+    cfg.resolve({}, cfgpath)
+    tmpl = tmp_path / "system_prompt.md"
+    assert tmpl.exists(), "template should be auto-created"
+    assert "<!--" in tmpl.read_text()
+    # inert: all-comments template contributes nothing to the prompt
+    assert cfg._strip_comments(tmpl.read_text()).strip() == ""
+
+
+def test_ensure_system_prompt_never_overwrites(tmp_path):
+    f = tmp_path / "system_prompt.md"
+    f.write_text("MY REAL PROMPT")
+    cfg.ensure_system_prompt_file(tmp_path)
+    assert f.read_text() == "MY REAL PROMPT"
+
+
+def test_load_strips_comments_keeps_real_text(monkeypatch, tmp_path):
+    d = tmp_path / ".drydock"; d.mkdir()
+    (d / "system_prompt.md").write_text("<!-- ignore me -->\nReal instruction here.")
+    monkeypatch.setattr(cfg.Path, "home", staticmethod(lambda: tmp_path))
+    out = cfg.load_user_system_prompt({})
+    assert "Real instruction here." in out
+    assert "ignore me" not in out
+
+
+def test_load_ignores_comment_only_file(monkeypatch, tmp_path):
+    d = tmp_path / ".drydock"; d.mkdir()
+    (d / "system_prompt.md").write_text(cfg._SYSTEM_PROMPT_TEMPLATE)
+    monkeypatch.setattr(cfg.Path, "home", staticmethod(lambda: tmp_path))
+    assert cfg.load_user_system_prompt({}) == ""