wcgw 2.7.2__tar.gz → 2.8.0__tar.gz

{wcgw-2.7.2 → wcgw-2.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wcgw
-Version: 2.7.2
+Version: 2.8.0
 Summary: Shell and coding agent on claude and chatgpt
 Project-URL: Homepage, https://github.com/rusiaaman/wcgw
 Author-email: Aman Rusia <gapypi@arcfu.com>

{wcgw-2.7.2 → wcgw-2.8.0}/gpt_action_json_schema.json

@@ -408,6 +408,47 @@
         ],
         "title": "BashInteractionWithUUID"
       },
+      "CodeWriterMode": {
+        "properties": {
+          "allowed_globs": {
+            "anyOf": [
+              {
+                "type": "string",
+                "const": "all"
+              },
+              {
+                "items": {
+                  "type": "string"
+                },
+                "type": "array"
+              }
+            ],
+            "title": "Allowed Globs"
+          },
+          "allowed_commands": {
+            "anyOf": [
+              {
+                "type": "string",
+                "const": "all"
+              },
+              {
+                "items": {
+                  "type": "string"
+                },
+                "type": "array"
+              }
+            ],
+            "title": "Allowed Commands"
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "allowed_globs",
+          "allowed_commands"
+        ],
+        "title": "CodeWriterMode"
+      },
       "CommandWithUUID": {
         "properties": {
           "command": {
@@ -520,6 +561,25 @@
             "type": "string",
             "title": "Task Id To Resume"
           },
+          "mode_name": {
+            "type": "string",
+            "enum": [
+              "wcgw",
+              "architect",
+              "code_writer"
+            ],
+            "title": "Mode Name"
+          },
+          "code_writer_config": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/CodeWriterMode"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "user_id": {
             "type": "string",
             "format": "uuid",
@@ -532,6 +592,7 @@
           "any_workspace_path",
           "initial_files_to_read",
           "task_id_to_resume",
+          "mode_name",
           "user_id"
         ],
         "title": "InitializeWithUUID"

{wcgw-2.7.2 → wcgw-2.8.0}/gpt_instructions.txt

@@ -15,6 +15,10 @@ Instructions for `Initialize`:
     - If the user has mentioned a folder or file with unclear project root, use the file or folder as `any_workspace_path`.
     - If user has mentioned any files use `initial_files_to_read` to read, use absolute paths only.
     - If `any_workspace_path` is provided, a tree structure of the workspace will be shown.
+    - Leave `any_workspace_path` as empty if no file or folder is mentioned.
+    - By default use mode `wcgw`
+    - In code-writer mode, set the commands and globs which user asked to set, otherwise use 'all'.
+    - In order to change the mode later, call this tool again but be sure to not provide any other argument like task_id_to_resume unnecessarily.
 
 Instructions for `BashCommand`:
 - Execute a bash command. This is stateful (beware with subsequent calls).

{wcgw-2.7.2 → wcgw-2.8.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 authors = [{ name = "Aman Rusia", email = "gapypi@arcfu.com" }]
 name = "wcgw"
-version = "2.7.2"
+version = "2.8.0"
 description = "Shell and coding agent on claude and chatgpt"
 readme = "README.md"
 requires-python = ">=3.11, <3.13"

{wcgw-2.7.2 → wcgw-2.8.0}/src/wcgw/client/anthropic_client.py

@@ -130,7 +130,7 @@ def loop(
     memory = None
     if resume:
         try:
-            _, memory = load_memory(
+            _, memory, _ = load_memory(
                 resume,
                 8000,
                 lambda x: default_enc.encode(x).ids,
@@ -166,6 +166,7 @@ def loop(
 - The control will return to you in 5 seconds regardless of the status. For heavy commands, keep checking status using BashInteraction till they are finished.
 - Run long running commands in background using screen instead of "&".
 - Use longer wait_for_seconds if the command is expected to run for a long time.
+- Do not use 'cat' to read files, use ReadFiles tool instead.
 """,
         ),
         ToolParam(
@@ -281,22 +282,13 @@ Saves provided description and file contents of all the relevant file paths or g
             ),
         ]
 
-    initial_info = initialize(
-        os.getcwd(), [], resume if (memory and resume) else "", 8000
+    system = initialize(
+        os.getcwd(),
+        [],
+        resume if (memory and resume) else "",
+        max_tokens=8000,
+        mode="wcgw",
     )
-    system = f"""
-You're an expert software engineer with shell and code knowledge.
-
-Instructions:
-
-    - You should use the provided bash execution, reading and writing file tools to complete objective.
-    - First understand about the project by getting the folder structure (ignoring .git, node_modules, venv, etc.)
-    - Always read relevant files before editing.
-    - Do not provide code snippets unless asked by the user, instead directly add/edit the code.
-    - Do not install new tools/packages before ensuring no such tools/package or an alternative already exists.
-
-{initial_info}
-"""
 
     with open(os.path.join(os.path.dirname(__file__), "diff-instructions.txt")) as f:
         system += f.read()

{wcgw-2.7.2 → wcgw-2.8.0}/src/wcgw/client/mcp_server/server.py

@@ -28,6 +28,7 @@ from ...types_ import (
 )
 from .. import tools
 from ..computer_use import SLEEP_TIME_MAX_S
+from ..modes import get_kt_prompt
 from ..tools import DoneFlag, default_enc, get_tool_output, which_tool_name
 
 COMPUTER_USE_ON_DOCKER_ENABLED = False
@@ -45,48 +46,35 @@ async def handle_read_resource(uri: AnyUrl) -> str:
     raise ValueError("No resources available")
 
 
-@server.list_prompts()  # type: ignore
-async def handle_list_prompts() -> list[types.Prompt]:
-    return [
+PROMPTS = {
+    "KnowledgeTransfer": (
         types.Prompt(
             name="KnowledgeTransfer",
             description="Prompt for invoking ContextSave tool in order to do a comprehensive knowledge transfer of a coding task. Prompts to save detailed error log and instructions.",
-        )
-    ]
+        ),
+        get_kt_prompt,
+    )
+}
+
+
+@server.list_prompts()  # type: ignore
+async def handle_list_prompts() -> list[types.Prompt]:
+    return [x[0] for x in PROMPTS.values()]
 
 
 @server.get_prompt()  # type: ignore
 async def handle_get_prompt(
     name: str, arguments: dict[str, str] | None
 ) -> types.GetPromptResult:
-    messages = []
-    if name == "KnowledgeTransfer":
-        messages = [
-            types.PromptMessage(
-                role="user",
-                content=types.TextContent(
-                    type="text",
-                    text="""Use `ContextSave` tool to do a knowledge transfer of the task in hand.
-Write detailed description in order to do a KT.
-Save all information necessary for a person to understand the task and the problems.
-
-Format the `description` field using Markdown with the following sections.
-- "# Objective" section containing project and task objective.
-- "# All user instructions" section should be provided containing all instructions user shared in the conversation.
-- "# Current status of the task" should be provided containing only what is already achieved, not what's remaining.
-- "# All issues with snippets" section containing snippets of error, traceback, file snippets, commands, etc. But no comments or solutions.
-- Be very verbose in the all issues with snippets section providing as much error context as possible.
-- "# Build and development instructions" section containing instructions to build or run project or run tests, or envrionment related information. Only include what's known. Leave empty if unknown.
-- After the tool completes succesfully, tell me the task id and the file path the tool generated (important!)
-- This tool marks end of your conversation, do not run any further tools after calling this.
-
-Provide all relevant file paths in order to understand and solve the the task. Err towards providing more file paths than fewer.
-
-(Note to self: this conversation can then be resumed later asking "Resume `<generated id>`" which should call Initialize tool)
-""",
-                ),
-            )
-        ]
+    messages = [
+        types.PromptMessage(
+            role="user",
+            content=types.TextContent(
+                type="text",
+                text=PROMPTS[name][1](),
+            ),
+        )
+    ]
     return types.GetPromptResult(messages=messages)
 
 
@@ -117,6 +105,9 @@ async def handle_list_tools() -> list[types.Tool]:
 - If user has mentioned any files use `initial_files_to_read` to read, use absolute paths only.
 - If `any_workspace_path` is provided, a tree structure of the workspace will be shown.
 - Leave `any_workspace_path` as empty if no file or folder is mentioned.
+- By default use mode "wcgw"
+- In "code-writer" mode, set the commands and globs which user asked to set, otherwise use 'all'.
+- In order to change the mode later, call this tool again but be sure to not provide any other argument like task_id_to_resume unnecessarily.
 """,
         ),
         ToolParam(
@@ -263,6 +254,8 @@ async def handle_call_tool(
     except ValidationError:
 
         def try_json(x: str) -> Any:
+            if not isinstance(x, str):
+                return x
             try:
                 return json.loads(x)
             except json.JSONDecodeError:
@@ -284,24 +277,9 @@ async def handle_call_tool(
         if isinstance(output_or_done, str):
             if issubclass(tool_type, Initialize):
                 output_or_done += """
----
-You're an expert software engineer with shell and code knowledge.
-
-Instructions:
-
-    - You should use the provided bash execution, reading and writing file tools to complete objective.
-    - First understand about the project by getting the folder structure (ignoring .git, node_modules, venv, etc.)
-    - Always read relevant files before editing.
-    - Do not provide code snippets unless asked by the user, instead directly add/edit the code.
-    - Do not install new tools/packages before ensuring no such tools/package or an alternative already exists.
-    - Do not use artifacts if you have access to the repository and not asked by the user to provide artifacts/snippets. Directly create/update using shell tools.
-    - Do not use Ctrl-c or Ctrl-z or interrupt commands without asking the user, because often the program don't show any update but they still are running.
-    - Do not use echo to write multi-line files, always use FileEdit tool to update a code.
-    
-Additional instructions:
-    Always run `pwd` if you get any file or directory not found error to make sure you're not lost, or to get absolute cwd.
-
-    Always write production ready, syntactically correct code.
+- Additional important note: as soon as you encounter "The user has chosen to disallow the tool call.", immediately stop doing everything and ask user for the reason.
+
+Initialize call done.
     """
 
             content.append(types.TextContent(type="text", text=output_or_done))

{wcgw-2.7.2 → wcgw-2.8.0}/src/wcgw/client/memory.py

@@ -1,7 +1,8 @@
+import json
 import os
 import re
 import shlex
-from typing import Callable, Optional
+from typing import Any, Callable, Optional
 
 from ..types_ import ContextSave
 
@@ -30,7 +31,11 @@ def format_memory(task_memory: ContextSave, relevant_files: str) -> str:
     return memory_data
 
 
-def save_memory(task_memory: ContextSave, relevant_files: str) -> str:
+def save_memory(
+    task_memory: ContextSave,
+    relevant_files: str,
+    bash_state_dict: Optional[dict[str, Any]] = None,
+) -> str:
     app_dir = get_app_dir_xdg()
     memory_dir = os.path.join(app_dir, "memory")
     os.makedirs(memory_dir, exist_ok=True)
@@ -45,6 +50,12 @@ def save_memory(task_memory: ContextSave, relevant_files: str) -> str:
     with open(memory_file_full, "w") as f:
         f.write(memory_data)
 
+    # Save bash state if provided
+    if bash_state_dict is not None:
+        state_file = os.path.join(memory_dir, f"{task_id}_bash_state.json")
+        with open(state_file, "w") as f:
+            json.dump(bash_state_dict, f, indent=2)
+
     return memory_file_full
 
 
@@ -53,7 +64,7 @@ def load_memory[T](
     max_tokens: Optional[int],
     encoder: Callable[[str], list[T]],
     decoder: Callable[[list[T]], str],
-) -> tuple[str, str]:
+) -> tuple[str, str, Optional[dict[str, Any]]]:
     app_dir = get_app_dir_xdg()
     memory_dir = os.path.join(app_dir, "memory")
     memory_file = os.path.join(memory_dir, f"{task_id}.txt")
@@ -75,4 +86,12 @@ def load_memory[T](
         parsed_ = shlex.split(matched_path)
         if parsed_ and len(parsed_) == 1:
             project_root_path = parsed_[0]
-    return project_root_path, data
+
+    # Try to load bash state if exists
+    state_file = os.path.join(memory_dir, f"{task_id}_bash_state.json")
+    bash_state: Optional[dict[str, Any]] = None
+    if os.path.exists(state_file):
+        with open(state_file) as f:
+            bash_state = json.load(f)
+
+    return project_root_path, data, bash_state

wcgw-2.8.0/src/wcgw/client/modes.py

@@ -0,0 +1,242 @@
+from dataclasses import dataclass
+from typing import Any, Literal, NamedTuple
+
+from ..types_ import Modes, ModesConfig
+
+
+class BashCommandMode(NamedTuple):
+    bash_mode: Literal["normal_mode", "restricted_mode"]
+    allowed_commands: Literal["all", "none"]
+
+    def serialize(self) -> dict[str, Any]:
+        return {"bash_mode": self.bash_mode, "allowed_commands": self.allowed_commands}
+
+    @classmethod
+    def deserialize(cls, data: dict[str, Any]) -> "BashCommandMode":
+        return cls(data["bash_mode"], data["allowed_commands"])
+
+
+class FileEditMode(NamedTuple):
+    allowed_globs: Literal["all"] | list[str]
+
+    def serialize(self) -> dict[str, Any]:
+        return {"allowed_globs": self.allowed_globs}
+
+    @classmethod
+    def deserialize(cls, data: dict[str, Any]) -> "FileEditMode":
+        return cls(data["allowed_globs"])
+
+
+class WriteIfEmptyMode(NamedTuple):
+    allowed_globs: Literal["all"] | list[str]
+
+    def serialize(self) -> dict[str, Any]:
+        return {"allowed_globs": self.allowed_globs}
+
+    @classmethod
+    def deserialize(cls, data: dict[str, Any]) -> "WriteIfEmptyMode":
+        return cls(data["allowed_globs"])
+
+
+@dataclass
+class ModeImpl:
+    bash_command_mode: BashCommandMode
+    file_edit_mode: FileEditMode
+    write_if_empty_mode: WriteIfEmptyMode
+
+
+def code_writer_prompt(
+    allowed_file_edit_globs: Literal["all"] | list[str],
+    all_write_new_globs: Literal["all"] | list[str],
+    allowed_commands: Literal["all"] | list[str],
+) -> str:
+    base = """
+You have to run in "code_writer" mode.
+"""
+
+    path_prompt = """
+    - You are allowed to run FileEdit in the provided repository only.
+    """
+
+    if allowed_file_edit_globs != "all":
+        if allowed_file_edit_globs:
+            path_prompt = f"""
+    - You are allowed to run FileEdit for files matching only the following globs: {', '.join(allowed_file_edit_globs)}
+"""
+        else:
+            path_prompt = """
+    - You are not allowed to run FileEdit.
+"""
+    base += path_prompt
+
+    path_prompt = """
+    - You are allowed to run WriteIfEmpty in the provided repository only.
+    """
+
+    if all_write_new_globs != "all":
+        if all_write_new_globs:
+            path_prompt = f"""
+    - You are allowed to run WriteIfEmpty files matching only the following globs: {', '.join(allowed_file_edit_globs)}
+"""
+        else:
+            path_prompt = """
+    - You are not allowed to run WriteIfEmpty.
+"""
+    base += path_prompt
+
+    run_command_common = """
+    - Do not use Ctrl-c or Ctrl-z or interrupt commands without asking the user, because often the programs don't show any update but they still are running.
+    - Do not use echo to write multi-line files, always use FileEdit tool to update a code.
+    - Do not provide code snippets unless asked by the user, instead directly add/edit the code.
+    - You should use the provided bash execution, reading and writing file tools to complete objective.
+    - First understand about the project by getting the folder structure (ignoring .git, node_modules, venv, etc.)
+    - Do not use artifacts if you have access to the repository and not asked by the user to provide artifacts/snippets. Directly create/update using wcgw tools.
+"""
+
+    command_prompt = f"""
+    - You are only allowed to run commands for project setup, code writing, editing, updating, testing, running and debugging related to the project.
+    - Do not run anything that adds or removes packages, changes system configuration or environment.
+{run_command_common}
+"""
+    if allowed_commands != "all":
+        if allowed_commands:
+            command_prompt = f"""
+    - You are only allowed to run the following commands: {', '.join(allowed_commands)}
+{run_command_common}
+"""
+        else:
+            command_prompt = """
+    - You are not allowed to run any commands.
+"""
+
+    base += command_prompt
+    return base
+
+
+WCGW_PROMPT = """
+---
+You're an expert software engineer with shell and code knowledge.
+
+Instructions:
+
+    - You should use the provided bash execution, reading and writing file tools to complete objective.
+    - First understand about the project by getting the folder structure (ignoring .git, node_modules, venv, etc.)
+    - Do not provide code snippets unless asked by the user, instead directly add/edit the code.
+    - Do not install new tools/packages before ensuring no such tools/package or an alternative already exists.
+    - Do not use artifacts if you have access to the repository and not asked by the user to provide artifacts/snippets. Directly create/update using wcgw tools
+    - Do not use Ctrl-c or Ctrl-z or interrupt commands without asking the user, because often the programs don't show any update but they still are running.
+    - Do not use echo to write multi-line files, always use FileEdit tool to update a code.
+    
+Additional instructions:
+    Always run `pwd` if you get any file or directory not found error to make sure you're not lost, or to get absolute cwd.
+
+    Always write production ready, syntactically correct code.
+
+
+"""
+ARCHITECT_PROMPT = """You have to run in "architect" mode. This means
+- You are not allowed to edit or update any file. You are not allowed to create any file. 
+- You are not allowed to run any commands that may change disk, system configuration, packages or environment. Only read-only commands are allowed.
+- Only run commands that allows you to explore the repository, understand the system or read anything of relevance. 
+- Do not use Ctrl-c or Ctrl-z or interrupt commands without asking the user, because often the programs don't show any update but they still are running.
+- You are not allowed to change directory (bash will run in -r mode)
+
+Your response should be in self-critique and brainstorm style.
+- Read as many relevant files as possible. 
+- Be comprehensive in your understanding and search of relevant files.
+- First understand about the project by getting the folder structure (ignoring .git, node_modules, venv, etc.)
+"""
+
+
+DEFAULT_MODES: dict[Modes, ModeImpl] = {
+    Modes.wcgw: ModeImpl(
+        bash_command_mode=BashCommandMode("normal_mode", "all"),
+        write_if_empty_mode=WriteIfEmptyMode("all"),
+        file_edit_mode=FileEditMode("all"),
+    ),
+    Modes.architect: ModeImpl(
+        bash_command_mode=BashCommandMode("restricted_mode", "all"),
+        write_if_empty_mode=WriteIfEmptyMode([]),
+        file_edit_mode=FileEditMode([]),
+    ),
+    Modes.code_writer: ModeImpl(
+        bash_command_mode=BashCommandMode("normal_mode", "all"),
+        write_if_empty_mode=WriteIfEmptyMode("all"),
+        file_edit_mode=FileEditMode("all"),
+    ),
+}
+
+
+def modes_to_state(
+    mode: ModesConfig,
+) -> tuple[BashCommandMode, FileEditMode, WriteIfEmptyMode, Modes]:
+    # First get default mode config
+    if isinstance(mode, str):
+        mode_impl = DEFAULT_MODES[Modes[mode]]  # converts str to Modes enum
+        mode_name = Modes[mode]
+    else:
+        # For CodeWriterMode, use code_writer as base and override
+        mode_impl = DEFAULT_MODES[Modes.code_writer]
+        # Override with custom settings from CodeWriterMode
+        mode_impl = ModeImpl(
+            bash_command_mode=BashCommandMode(
+                mode_impl.bash_command_mode.bash_mode,
+                "all" if mode.allowed_commands else "none",
+            ),
+            file_edit_mode=FileEditMode(mode.allowed_globs),
+            write_if_empty_mode=WriteIfEmptyMode(mode.allowed_globs),
+        )
+        mode_name = Modes.code_writer
+    return (
+        mode_impl.bash_command_mode,
+        mode_impl.file_edit_mode,
+        mode_impl.write_if_empty_mode,
+        mode_name,
+    )
+
+
+WCGW_KT = """Use `ContextSave` tool to do a knowledge transfer of the task in hand.
+Write detailed description in order to do a KT.
+Save all information necessary for a person to understand the task and the problems.
+
+Format the `description` field using Markdown with the following sections.
+- "# Objective" section containing project and task objective.
+- "# All user instructions" section should be provided containing all instructions user shared in the conversation.
+- "# Current status of the task" should be provided containing only what is already achieved, not what's remaining.
+- "# All issues with snippets" section containing snippets of error, traceback, file snippets, commands, etc. But no comments or solutions.
+- Be very verbose in the all issues with snippets section providing as much error context as possible.
+- "# Build and development instructions" section containing instructions to build or run project or run tests, or envrionment related information. Only include what's known. Leave empty if unknown.
+- Any other relevant sections following the above.
+- After the tool completes succesfully, tell me the task id and the file path the tool generated (important!)
+- This tool marks end of your conversation, do not run any further tools after calling this.
+
+Provide all relevant file paths in order to understand and solve the the task. Err towards providing more file paths than fewer.
+
+(Note to self: this conversation can then be resumed later asking "Resume wcgw task `<generated id>`" which should call Initialize tool)
+"""
+
+
+ARCHITECT_KT = """Use `ContextSave` tool to do a knowledge transfer of the task in hand.
+Write detailed description in order to do a KT.
+Save all information necessary for a person to understand the task and the problems.
+
+Format the `description` field using Markdown with the following sections.
+- "# Objective" section containing project and task objective.
+- "# All user instructions" section should be provided containing all instructions user shared in the conversation.
+- "# Designed plan" should be provided containing the designed plan as discussed.
+- Any other relevant sections following the above.
+- After the tool completes succesfully, tell me the task id and the file path the tool generated (important!)
+- This tool marks end of your conversation, do not run any further tools after calling this.
+
+Provide all relevant file paths in order to understand and solve the the task. Err towards providing more file paths than fewer.
+
+(Note to self: this conversation can then be resumed later asking "Resume wcgw task `<generated id>`" which should call Initialize tool)
+"""
+
+KTS = {Modes.wcgw: WCGW_KT, Modes.architect: ARCHITECT_KT, Modes.code_writer: WCGW_KT}
+
+
+def get_kt_prompt() -> str:
+    from .tools import BASH_STATE
+
+    return KTS[BASH_STATE.mode]

{wcgw-2.7.2 → wcgw-2.8.0}/src/wcgw/client/openai_client.py

@@ -125,7 +125,7 @@ def loop(
     memory = None
     if resume:
         try:
-            _, memory = load_memory(
+            _, memory, _ = load_memory(
                 resume,
                 8000,
                 lambda x: default_enc.encode(x).ids,
@@ -176,6 +176,7 @@ def loop(
 - Always run `pwd` if you get any file or directory not found error to make sure you're not lost.
 - The control will return to you in 5 seconds regardless of the status. For heavy commands, keep checking status using BashInteraction till they are finished.
 - Run long running commands in background using screen instead of "&".
+- Do not use 'cat' to read files, use ReadFiles tool instead.
 """,
         ),
         openai.pydantic_function_tool(
@@ -226,23 +227,13 @@ Saves provided description and file contents of all the relevant file paths or g
         ),
     ]
 
-    initial_info = initialize(
-        os.getcwd(), [], resume if (memory and resume) else "", 8000
+    system = initialize(
+        os.getcwd(),
+        [],
+        resume if (memory and resume) else "",
+        max_tokens=8000,
+        mode="wcgw",
     )
-    system = f"""
-You're an expert software engineer with shell and code knowledge.
-
-Instructions:
-
-    - You should use the provided bash execution, reading and writing file tools to complete objective.
-    - First understand about the project by getting the folder structure (ignoring .git, node_modules, venv, etc.)
-    - Always read relevant files before editing.
-    - Do not provide code snippets unless asked by the user, instead directly add/edit the code.
-    - Do not install new tools/packages before ensuring no such tools/package or an alternative already exists.
-
-{initial_info}
-
-"""
 
     with open(os.path.join(os.path.dirname(__file__), "diff-instructions.txt")) as f:
         system += f.read()