wcgw 0.2.0__tar.gz → 1.0.1__tar.gz

{wcgw-0.2.0 → wcgw-1.0.1}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.3
 Name: wcgw
-Version: 0.2.0
+Version: 1.0.1
 Summary: What could go wrong giving full shell access to chatgpt?
 Project-URL: Homepage, https://github.com/rusiaaman/wcgw
 Author-email: Aman Rusia <gapypi@arcfu.com>
 Requires-Python: <3.13,>=3.10
 Requires-Dist: fastapi>=0.115.0
 Requires-Dist: mypy>=1.11.2
+Requires-Dist: nltk>=3.9.1
 Requires-Dist: openai>=1.46.0
 Requires-Dist: petname>=2.6
 Requires-Dist: pexpect>=4.9.0
@@ -14,6 +15,7 @@ Requires-Dist: pydantic>=2.9.2
 Requires-Dist: pyte>=0.8.2
 Requires-Dist: python-dotenv>=1.0.1
 Requires-Dist: rich>=13.8.1
+Requires-Dist: semantic-version>=2.10.0
 Requires-Dist: shell>=1.0.1
 Requires-Dist: tiktoken==0.7.0
 Requires-Dist: toml>=0.10.2
@@ -32,7 +34,8 @@ A custom gpt on chatgpt web app to interact with your local shell.
 ### 🚀 Highlights
 - ⚡ **Full Shell Access**: No restrictions, complete control.
 - ⚡ **Create, Execute, Iterate**: Ask the gpt to keep running compiler checks till all errors are fixed, or ask it to keep checking for the status of a long running command till it's done.
-- ⚡ **Interactive Command Handling**: [beta] Supports interactive commands using arrow keys, interrupt, and ansi escape sequences. 
+- ⚡ **Interactive Command Handling**: Supports interactive commands using arrow keys, interrupt, and ansi escape sequences. 
+- ⚡ **REPL support**: [beta] Supports python/node and other REPL execution.
 
 ###  🪜 Steps: 
 1. Run the [cli client](https://github.com/rusiaaman/wcgw?tab=readme-ov-file#client) in any directory of choice.
@@ -98,12 +101,12 @@ https://github.com/rusiaaman/wcgw/blob/main/gpt_instructions.txt
 https://github.com/rusiaaman/wcgw/blob/main/gpt_action_json_schema.json
 
 Run the server 
-`gunicorn --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:443 src.relay.serve:app  --certfile fullchain.pem  --keyfile  privkey.pem`
+`gunicorn --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:443 src.wcgw.relay.serve:app  --certfile fullchain.pem  --keyfile  privkey.pem`
 
 If you don't have public ip and domain name, you can use `ngrok` or similar services to get a https address to the api.
 
 The specify the server url in the `wcgw` command like so
-`wcgw --server-url https://your-url/register`
+`wcgw --server-url https://your-url/v1/register`
 
 # [Optional] Local shell access with openai API key
 

{wcgw-0.2.0 → wcgw-1.0.1}/README.md

@@ -7,7 +7,8 @@ A custom gpt on chatgpt web app to interact with your local shell.
 ### 🚀 Highlights
 - ⚡ **Full Shell Access**: No restrictions, complete control.
 - ⚡ **Create, Execute, Iterate**: Ask the gpt to keep running compiler checks till all errors are fixed, or ask it to keep checking for the status of a long running command till it's done.
-- ⚡ **Interactive Command Handling**: [beta] Supports interactive commands using arrow keys, interrupt, and ansi escape sequences. 
+- ⚡ **Interactive Command Handling**: Supports interactive commands using arrow keys, interrupt, and ansi escape sequences. 
+- ⚡ **REPL support**: [beta] Supports python/node and other REPL execution.
 
 ###  🪜 Steps: 
 1. Run the [cli client](https://github.com/rusiaaman/wcgw?tab=readme-ov-file#client) in any directory of choice.
@@ -73,12 +74,12 @@ https://github.com/rusiaaman/wcgw/blob/main/gpt_instructions.txt
 https://github.com/rusiaaman/wcgw/blob/main/gpt_action_json_schema.json
 
 Run the server 
-`gunicorn --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:443 src.relay.serve:app  --certfile fullchain.pem  --keyfile  privkey.pem`
+`gunicorn --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:443 src.wcgw.relay.serve:app  --certfile fullchain.pem  --keyfile  privkey.pem`
 
 If you don't have public ip and domain name, you can use `ngrok` or similar services to get a https address to the api.
 
 The specify the server url in the `wcgw` command like so
-`wcgw --server-url https://your-url/register`
+`wcgw --server-url https://your-url/v1/register`
 
 # [Optional] Local shell access with openai API key
 

wcgw-1.0.1/gpt_action_json_schema.json

@@ -0,0 +1,353 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "FastAPI",
+    "version": "0.1.0"
+  },
+  "servers": [
+    {
+      "url": "https://bf94-103-212-152-58.ngrok-free.app"
+    }
+  ],
+  "paths": {
+    "/v1/write_file": {
+      "post": {
+        "x-openai-isConsequential": false,
+        "summary": "Write File",
+        "operationId": "write_file_v1_write_file_post",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/WritefileWithUUID"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "title": "Response Write File V1 Write File Post"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/reset_shell": {
+      "post": {
+        "x-openai-isConsequential": false,
+        "summary": "Reset Shell",
+        "operationId": "reset_shell_v1_reset_shell_post",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ResetShellWithUUID"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "title": "Response Reset Shell V1 Reset Shell Post"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/bash_command": {
+      "post": {
+        "x-openai-isConsequential": false,
+        "summary": "Bash Command",
+        "operationId": "bash_command_v1_bash_command_post",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CommandWithUUID"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "title": "Response Bash Command V1 Bash Command Post"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/bash_interaction": {
+      "post": {
+        "x-openai-isConsequential": false,
+        "summary": "Bash Interaction",
+        "operationId": "bash_interaction_v1_bash_interaction_post",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/BashInteractionWithUUID"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "title": "Response Bash Interaction V1 Bash Interaction Post"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "BashInteractionWithUUID": {
+        "properties": {
+          "send_text": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Send Text"
+          },
+          "send_specials": {
+            "anyOf": [
+              {
+                "items": {
+                  "type": "string",
+                  "enum": [
+                    "Key-up",
+                    "Key-down",
+                    "Key-left",
+                    "Key-right",
+                    "Enter",
+                    "Ctrl-c",
+                    "Ctrl-d",
+                    "Ctrl-z"
+                  ]
+                },
+                "type": "array"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Send Specials"
+          },
+          "send_ascii": {
+            "anyOf": [
+              {
+                "items": {
+                  "type": "integer"
+                },
+                "type": "array"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Send Ascii"
+          },
+          "user_id": {
+            "type": "string",
+            "format": "uuid",
+            "title": "User Id"
+          }
+        },
+        "type": "object",
+        "required": [
+          "user_id"
+        ],
+        "title": "BashInteractionWithUUID"
+      },
+      "CommandWithUUID": {
+        "properties": {
+          "command": {
+            "type": "string",
+            "title": "Command"
+          },
+          "user_id": {
+            "type": "string",
+            "format": "uuid",
+            "title": "User Id"
+          }
+        },
+        "type": "object",
+        "required": [
+          "command",
+          "user_id"
+        ],
+        "title": "CommandWithUUID"
+      },
+      "HTTPValidationError": {
+        "properties": {
+          "detail": {
+            "items": {
+              "$ref": "#/components/schemas/ValidationError"
+            },
+            "type": "array",
+            "title": "Detail"
+          }
+        },
+        "type": "object",
+        "title": "HTTPValidationError"
+      },
+      "ResetShellWithUUID": {
+        "properties": {
+          "should_reset": {
+            "type": "boolean",
+            "enum": [
+              true
+            ],
+            "const": true,
+            "title": "Should Reset",
+            "default": true
+          },
+          "user_id": {
+            "type": "string",
+            "format": "uuid",
+            "title": "User Id"
+          }
+        },
+        "type": "object",
+        "required": [
+          "user_id"
+        ],
+        "title": "ResetShellWithUUID"
+      },
+      "ValidationError": {
+        "properties": {
+          "loc": {
+            "items": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "integer"
+                }
+              ]
+            },
+            "type": "array",
+            "title": "Location"
+          },
+          "msg": {
+            "type": "string",
+            "title": "Message"
+          },
+          "type": {
+            "type": "string",
+            "title": "Error Type"
+          }
+        },
+        "type": "object",
+        "required": [
+          "loc",
+          "msg",
+          "type"
+        ],
+        "title": "ValidationError"
+      },
+      "WritefileWithUUID": {
+        "properties": {
+          "file_path": {
+            "type": "string",
+            "title": "File Path"
+          },
+          "file_content": {
+            "type": "string",
+            "title": "File Content"
+          },
+          "user_id": {
+            "type": "string",
+            "format": "uuid",
+            "title": "User Id"
+          }
+        },
+        "type": "object",
+        "required": [
+          "file_path",
+          "file_content",
+          "user_id"
+        ],
+        "title": "WritefileWithUUID"
+      }
+    }
+  }
+}

wcgw-1.0.1/gpt_instructions.txt

@@ -0,0 +1,38 @@
+You're a cli assistant.
+
+Instructions:
+
+    - You should use the provided bash execution tool to run script to complete objective. 
+    - Do not use sudo. Do not use interactive commands. 
+    - Ask user for confirmation before running anything major
+
+
+To execute bash commands OR write files use the provided api.
+
+Instructions for `BashCommand`:
+- Execute a bash command. This is stateful (beware with subsequent calls).
+- Do not use interactive commands like nano. Prefer writing simpler commands.
+- Status of the command and the current working directory will always be returned at the end.
+- Optionally `exit shell has restarted` is the output, in which case environment resets, you can run fresh commands.
+- The first line might be `(...truncated)` if the output is too long.
+- Always run `pwd` if you get any file or directory not found error to make sure you're not lost.
+
+Instructions for `Write File`
+- Write content to a file. Provide file path and content. Use this instead of BashCommand for writing files.
+- This doesn't create any directories, please create directories using `mkdir -p` BashCommand.
+- Important: all relative paths are relative to last CWD.
+
+Instructions for `BashInteraction`
+- Interact with running program using this tool
+- Special keys like arrows, interrupts, enter, etc.
+- Send text input to the running program.
+
+Instructions for `ResetShell`
+- Resets the shell. Use only if all interrupts and prompt reset attempts have failed repeatedly.
+
+---
+
+Always critically think and debate with yourself to solve the problem. Understand the context and the code by reading as much resources as possible before writing a single piece of code.
+
+---
+Ask the user for the user_id `UUID` if they haven't provided in the first message.

{wcgw-0.2.0 → wcgw-1.0.1}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 authors = [{ name = "Aman Rusia", email = "gapypi@arcfu.com" }]
 name = "wcgw"
-version = "0.2.0"
+version = "1.0.1"
 description = "What could go wrong giving full shell access to chatgpt?"
 readme = "README.md"
 requires-python = ">=3.10, <3.13"
@@ -22,6 +22,8 @@ dependencies = [
     "uvicorn>=0.31.0",
     "websockets>=13.1",
     "pydantic>=2.9.2",
+    "semantic-version>=2.10.0",
+    "nltk>=3.9.1",
 ]
 
 [project.urls]
@@ -34,6 +36,7 @@ build-backend = "hatchling.build"
 [project.scripts]
 wcgw_local = "wcgw:app"
 wcgw = "wcgw:listen"
+wcgw_relay = "wcgw.relay.serve:run"
 
 [tool.uv]
 dev-dependencies = [
@@ -41,4 +44,5 @@ dev-dependencies = [
     "types-toml>=0.10.8.20240310",
     "autoflake",
     "ipython>=8.12.3",
+    "gunicorn>=23.0.0",
 ]

wcgw-1.0.1/src/wcgw/__init__.py

@@ -0,0 +1,2 @@
+from .client.basic import app, loop
+from .client.tools import run as listen

wcgw-1.0.1/src/wcgw/client/__main__.py

@@ -0,0 +1,3 @@
+from .tools import run
+
+run()

{wcgw-0.2.0/src/wcgw → wcgw-1.0.1/src/wcgw/client}/basic.py

@@ -20,16 +20,15 @@ import petname  # type: ignore[import-untyped]
 from typer import Typer
 import uuid
 
+from ..types_ import BashCommand, BashInteraction, ReadImage, Writefile, ResetShell
+
 from .common import Models, discard_input
 from .common import CostData, History
 from .openai_utils import get_input_cost, get_output_cost
-from .tools import ExecuteBash, ReadImage, ImageData
+from .tools import ImageData
 
 from .tools import (
-    BASH_CLF_OUTPUT,
-    Confirmation,
     DoneFlag,
-    Writefile,
     get_tool_output,
     SHELL,
     start_shell,
@@ -156,27 +155,32 @@ def loop(
 
     tools = [
         openai.pydantic_function_tool(
-            ExecuteBash,
+            BashCommand,
             description="""
-- Execute a bash script. This is stateful (beware with subsequent calls).
-- Execute commands using `execute_command` attribute. You can run python/node/other REPL code lines using `execute_command` too.
+- Execute a bash command. This is stateful (beware with subsequent calls).
 - Do not use interactive commands like nano. Prefer writing simpler commands.
-- Last line will always be `(exit <int code>)` except if
-- The last line is `(pending)` if the program is still running or waiting for your input. You can then send input using `send_ascii` attributes. You get status by sending new line `send_ascii: ["Enter"]` or `send_ascii: [10]`.
-- Optionally the last line is `(won't exit)` in which case you need to kill the process if you want to run a new command.
+- Status of the command and the current working directory will always be returned at the end.
 - Optionally `exit shell has restarted` is the output, in which case environment resets, you can run fresh commands.
 - The first line might be `(...truncated)` if the output is too long.
 - Always run `pwd` if you get any file or directory not found error to make sure you're not lost.
-- You can run python/node/other REPL code lines using `execute_command` too. NOTE: `execute_command` doesn't create a new shell, it uses the same shell.
 """,
+        ),
+        openai.pydantic_function_tool(
+            BashInteraction,
+            description="""
+- Interact with running program using this tool.""",
         ),
         openai.pydantic_function_tool(
             Writefile,
-            description="Write content to a file. Provide file path and content. Use this instead of ExecuteBash for writing files.",
+            description="Write content to a file. Provide file path and content. Use this instead of BashCommand for writing files.",
         ),
         openai.pydantic_function_tool(
             ReadImage, description="Read an image from the shell."
         ),
+        openai.pydantic_function_tool(
+            ResetShell,
+            description="Resets the shell. Use only if all interrupts and prompt reset attempts have failed repeatedly.",
+        ),
     ]
     uname_sysname = os.uname().sysname
     uname_machine = os.uname().machine