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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drydock-cli
-Version: 3.1.9
+Version: 3.1.11
 Summary: Drydock — a local, provider-agnostic terminal coding agent for local LLMs
 Author: Frank Bobe III
 License-Expression: Apache-2.0
@@ -450,15 +450,24 @@ 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 a
+`system_prompt.md` file. Drydock creates a commented template for you, 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, ignored).
+
+Two scopes, most-specific wins:
+
+- **Per-project** — `<project>/.drydock/system_prompt.md`. Auto-created inside
+  any **git repo** (so different projects get different standing orders, and
+  drydock never litters `.drydock/` folders in non-project directories).
+- **Global** — `~/.drydock/system_prompt.md`. Auto-created on first run; applies
+  to every project. A per-project file **overrides** it.
+- **Or the config key** — `system_prompt = "..."` in `~/.drydock/config.toml`
+  (lowest precedence).
+
+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. Restart
+drydock after editing.
 
 ## Safety
 

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

@@ -426,15 +426,24 @@ 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 a
+`system_prompt.md` file. Drydock creates a commented template for you, 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, ignored).
+
+Two scopes, most-specific wins:
+
+- **Per-project** — `<project>/.drydock/system_prompt.md`. Auto-created inside
+  any **git repo** (so different projects get different standing orders, and
+  drydock never litters `.drydock/` folders in non-project directories).
+- **Global** — `~/.drydock/system_prompt.md`. Auto-created on first run; applies
+  to every project. A per-project file **overrides** it.
+- **Or the config key** — `system_prompt = "..."` in `~/.drydock/config.toml`
+  (lowest precedence).
+
+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. Restart
+drydock after editing.
 
 ## Safety
 

{drydock_cli-3.1.9 → drydock_cli-3.1.11}/drydock/cli.py

@@ -13,7 +13,7 @@ import sys
 from pathlib import Path
 
 from drydock import __version__
-from drydock.config import load_user_system_prompt
+from drydock.config import load_user_system_prompt, ensure_project_system_prompt
 from drydock.agent import AgentState, run, TextChunk, ToolStart, ToolEnd, TurnDone
 
 
@@ -436,8 +436,11 @@ def main():
     # greeting into a runaway build. The TUI reads this from config; CLI modes
     # call load_project_instructions directly (see run_interactive/run_oneshot).
     config["project_instructions"] = load_project_instructions()
-    # The user's custom system prompt (~/.drydock/system_prompt.md or the
-    # `system_prompt` config key) — standing instructions the TUI injects every turn.
+    # In a git project, drop a discoverable per-project prompt template at
+    # <project>/.drydock/system_prompt.md (inert until edited). Then load the
+    # effective custom prompt — project file OVERRIDES the global ~/.drydock one —
+    # as standing instructions the TUI/CLI inject every turn.
+    ensure_project_system_prompt()
     config["user_system_prompt"] = load_user_system_prompt(config)
 
     # Connect any configured MCP servers and register their tools so the model

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

@@ -13,6 +13,7 @@ All logic original to Drydock.
 """
 from __future__ import annotations
 
+import re
 import tomllib
 from pathlib import Path
 
@@ -119,27 +120,98 @@ def default_config_path() -> Path:
 
 
 def system_prompt_path() -> Path:
-    """User's global custom system-prompt file."""
+    """User's GLOBAL custom system-prompt file (applies to every project)."""
     return Path.home() / ".drydock" / "system_prompt.md"
 
 
-def load_user_system_prompt(config: dict | None = None) -> str:
-    """The user's custom system prompt, injected every turn as standing orders.
+def project_system_prompt_path(cwd: Path | None = None) -> Path:
+    """A PER-PROJECT custom system-prompt file: <project>/.drydock/system_prompt.md.
+    Overrides the global one when present — different projects, different orders."""
+    return (cwd or Path.cwd()) / ".drydock" / "system_prompt.md"
 
-    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.
-    """
-    text = ""
+
+# The template drydock drops 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.
+
+  SCOPE: this file is THIS PROJECT'S prompt if it lives at <project>/.drydock/
+  system_prompt.md; the copy at ~/.drydock/system_prompt.md applies to every
+  project. A project file OVERRIDES the global one.
+
+  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 _read_prompt_file(p: Path) -> str:
+    """Comment-stripped, whitespace-trimmed contents of a prompt file, or ''."""
     try:
-        p = system_prompt_path()
         if p.exists():
-            text = p.read_text()
+            return _strip_comments(p.read_text()).strip()
+    except OSError:
+        pass
+    return ""
+
+
+def _write_template(p: Path) -> None:
+    """Write the commented template to p if absent. Never overwrites; never raises."""
+    try:
+        if not p.exists():
+            p.parent.mkdir(parents=True, exist_ok=True)
+            p.write_text(_SYSTEM_PROMPT_TEMPLATE, encoding="utf-8")
     except OSError:
-        text = ""
+        pass
+
+
+def ensure_system_prompt_file(config_dir: Path | None = None) -> None:
+    """Create the GLOBAL <config_dir>/system_prompt.md template if absent (config_dir
+    defaults to ~/.drydock), so the feature is discoverable. Never overwrites."""
+    _write_template((config_dir / "system_prompt.md") if config_dir is not None else system_prompt_path())
+
+
+def ensure_project_system_prompt(cwd: Path | None = None) -> None:
+    """Create <project>/.drydock/system_prompt.md if absent — but ONLY inside a git
+    repo, so drydock never litters `.drydock/` folders in arbitrary directories
+    (e.g. $HOME, /tmp). A real project you `git init`'d gets a discoverable,
+    gitignorable per-project prompt; a throwaway cwd gets nothing. Never raises."""
+    cwd = cwd or Path.cwd()
+    try:
+        if (cwd / ".git").exists():   # file OR dir — covers worktrees too
+            _write_template(project_system_prompt_path(cwd))
+    except OSError:
+        pass
+
+
+def load_user_system_prompt(config: dict | None = None, cwd: Path | None = None) -> str:
+    """The user's custom system prompt, injected every turn as standing orders.
+
+    Precedence (first with real content wins): the PER-PROJECT file
+    <project>/.drydock/system_prompt.md, then the GLOBAL ~/.drydock/system_prompt.md,
+    then the inline `system_prompt` config key. Comment blocks are stripped (so the
+    shipped template is inert). Capped at 8000 chars. Returns '' when none has real
+    content. Never raises.
+    """
+    text = _read_prompt_file(project_system_prompt_path(cwd)) or _read_prompt_file(system_prompt_path())
     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 +361,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.11/drydock_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drydock-cli
-Version: 3.1.9
+Version: 3.1.11
 Summary: Drydock — a local, provider-agnostic terminal coding agent for local LLMs
 Author: Frank Bobe III
 License-Expression: Apache-2.0
@@ -450,15 +450,24 @@ 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 a
+`system_prompt.md` file. Drydock creates a commented template for you, 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, ignored).
+
+Two scopes, most-specific wins:
+
+- **Per-project** — `<project>/.drydock/system_prompt.md`. Auto-created inside
+  any **git repo** (so different projects get different standing orders, and
+  drydock never litters `.drydock/` folders in non-project directories).
+- **Global** — `~/.drydock/system_prompt.md`. Auto-created on first run; applies
+  to every project. A per-project file **overrides** it.
+- **Or the config key** — `system_prompt = "..."` in `~/.drydock/config.toml`
+  (lowest precedence).
+
+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. Restart
+drydock after editing.
 
 ## Safety
 

{drydock_cli-3.1.9 → drydock_cli-3.1.11}/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.11"
 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.11}/tests/test_config.py

@@ -125,3 +125,78 @@ 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({}) == ""
+
+
+# ── per-project system prompt (<project>/.drydock/system_prompt.md) ──
+
+def test_project_prompt_overrides_global(monkeypatch, tmp_path):
+    home = tmp_path / "home"; (home / ".drydock").mkdir(parents=True)
+    (home / ".drydock" / "system_prompt.md").write_text("GLOBAL RULES")
+    monkeypatch.setattr(cfg.Path, "home", staticmethod(lambda: home))
+    proj = tmp_path / "proj"; (proj / ".drydock").mkdir(parents=True)
+    (proj / ".drydock" / "system_prompt.md").write_text("PROJECT RULES")
+    out = cfg.load_user_system_prompt({}, cwd=proj)
+    assert "PROJECT RULES" in out
+    assert "GLOBAL RULES" not in out
+
+
+def test_global_used_when_no_project_file(monkeypatch, tmp_path):
+    home = tmp_path / "home"; (home / ".drydock").mkdir(parents=True)
+    (home / ".drydock" / "system_prompt.md").write_text("GLOBAL RULES")
+    monkeypatch.setattr(cfg.Path, "home", staticmethod(lambda: home))
+    proj = tmp_path / "proj"; proj.mkdir()  # no .drydock
+    out = cfg.load_user_system_prompt({}, cwd=proj)
+    assert "GLOBAL RULES" in out
+
+
+def test_ensure_project_prompt_only_in_git_repo(tmp_path):
+    # git repo → template created
+    repo = tmp_path / "repo"; (repo / ".git").mkdir(parents=True)
+    cfg.ensure_project_system_prompt(repo)
+    assert (repo / ".drydock" / "system_prompt.md").exists()
+    # non-git dir → nothing created (no litter)
+    plain = tmp_path / "plain"; plain.mkdir()
+    cfg.ensure_project_system_prompt(plain)
+    assert not (plain / ".drydock").exists()
+
+
+def test_ensure_project_prompt_never_overwrites(tmp_path):
+    repo = tmp_path / "repo"; (repo / ".git").mkdir(parents=True)
+    (repo / ".drydock").mkdir()
+    (repo / ".drydock" / "system_prompt.md").write_text("MINE")
+    cfg.ensure_project_system_prompt(repo)
+    assert (repo / ".drydock" / "system_prompt.md").read_text() == "MINE"