wcgw 0.0.10__tar.gz → 0.1.1__tar.gz

wcgw-0.1.1/.github/workflows/python-tests.yml

@@ -0,0 +1,30 @@
+name: Python Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: "${{ matrix.python-version }}"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+        pip install .[dev]  # Installs dependencies based on pyproject.toml
+    - name: Run tests
+      run: |
+        python -m unittest discover -s tests

wcgw-0.1.1/.python-version

@@ -0,0 +1 @@
+3.12

{wcgw-0.0.10 → wcgw-0.1.1}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: wcgw
-Version: 0.0.10
+Version: 0.1.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.8
+Requires-Python: <3.13,>=3.10
 Requires-Dist: fastapi>=0.115.0
 Requires-Dist: mypy>=1.11.2
 Requires-Dist: openai>=1.46.0
@@ -26,6 +26,9 @@ Description-Content-Type: text/markdown
 # Enable shell access on chatgpt.com
 A custom gpt on chatgpt web app to interact with your local shell.
 
+[![Tests](https://github.com/rusiaaman/wcgw/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/rusiaaman/wcgw/actions/workflows/python-tests.yml)
+[![Build](https://github.com/rusiaaman/wcgw/actions/workflows/python-publish.yml/badge.svg)](https://github.com/rusiaaman/wcgw/actions/workflows/python-publish.yml)
+
 ### 🚀 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.
@@ -36,21 +39,24 @@ A custom gpt on chatgpt web app to interact with your local shell.
 2. Share the generated id with this GPT: `https://chatgpt.com/g/g-Us0AAXkRh-wcgw-giving-shell-access`
 3. The custom GPT can now run any command on your cli
 
+
 ## Client
+You need to keep running this client for GPT to access your shell. Run it in a version controlled project's root.
 
-### Option 1: using pip
-Supports python >=3.8 and <3.13
+### Option 1: using uv [Recommended]
 ```sh
-$ pip3 install wcgw
-$ wcgw
+$ curl -LsSf https://astral.sh/uv/install.sh | sh
+$ uv tool run --python 3.12 wcgw@latest
 ```
 
-### Option 2: using uv
+### Option 2: using pip
+Supports python >=3.10 and <3.13
 ```sh
-$ curl -LsSf https://astral.sh/uv/install.sh | sh
-$ uv tool run --python 3.12 wcgw
+$ pip3 install wcgw
+$ wcgw
 ```
 
+
 This will print a UUID that you need to share with the gpt.
 
 
@@ -67,20 +73,37 @@ NOTE: you can resume a broken connection
 # How it works
 Your commands are relayed through a server I've hosted at https://wcgw.arcfu.com. The code for that is at `src/relay/serve.py`. 
 
-Chat gpt sends a request to the relay server using the user id that you share with it. The relay server holds a websocket with the terminal cilent against the user id and acts as a proxy to pass the request.
+Chat gpt sends a request to the relay server using the user id that you share with it. The relay server holds a websocket with the terminal client against the user id and acts as a proxy to pass the request.
 
 It's secure in both the directions. Either a malicious actor or a malicious Chatgpt has to correctly guess your UUID for any security breach. 
 
-NOTE: the relay server doesn't store any data. If you don't trust it then you may host the server on your own and create a custom gpt. Create an issue and I'll be happy to share the full instructions and schema I've given in the custom GPT configuration. 
-
 # Showcase
 
+## Unit tests and github actions
+[The first version of unit tests and github workflow to test on multiple python versions were written by the custom chatgpt](https://chatgpt.com/share/6717f922-8998-8005-b825-45d4b348b4dd)
+
 ## Create a todo app using react + typescript + vite
-https://chatgpt.com/share/6717d94d-756c-8005-98a6-d021c7b586aa
+![Screenshot](https://github.com/rusiaaman/wcgw/blob/main/static/ss1.png?raw=true)
+
+
+# Privacy
+The relay server doesn't store any data. I can't access any information passing through it and only secure channels are used to communicate.
+
+You may host the server on your own and create a custom gpt using the following section.
+
+# Creating your own custom gpt and the relay server.
+I've used the following instructions and action json schema to create the custom GPT. (Replace wcgw.arcfu.com with the address to your server)
+
+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`
 
-## Write unit tests for all files in my current repo
-[Todo]
+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`
 
 # [Optional] Local shell access with openai API key
 

{wcgw-0.0.10 → wcgw-0.1.1}/README.md

@@ -1,6 +1,9 @@
 # Enable shell access on chatgpt.com
 A custom gpt on chatgpt web app to interact with your local shell.
 
+[![Tests](https://github.com/rusiaaman/wcgw/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/rusiaaman/wcgw/actions/workflows/python-tests.yml)
+[![Build](https://github.com/rusiaaman/wcgw/actions/workflows/python-publish.yml/badge.svg)](https://github.com/rusiaaman/wcgw/actions/workflows/python-publish.yml)
+
 ### 🚀 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.
@@ -11,21 +14,24 @@ A custom gpt on chatgpt web app to interact with your local shell.
 2. Share the generated id with this GPT: `https://chatgpt.com/g/g-Us0AAXkRh-wcgw-giving-shell-access`
 3. The custom GPT can now run any command on your cli
 
+
 ## Client
+You need to keep running this client for GPT to access your shell. Run it in a version controlled project's root.
 
-### Option 1: using pip
-Supports python >=3.8 and <3.13
+### Option 1: using uv [Recommended]
 ```sh
-$ pip3 install wcgw
-$ wcgw
+$ curl -LsSf https://astral.sh/uv/install.sh | sh
+$ uv tool run --python 3.12 wcgw@latest
 ```
 
-### Option 2: using uv
+### Option 2: using pip
+Supports python >=3.10 and <3.13
 ```sh
-$ curl -LsSf https://astral.sh/uv/install.sh | sh
-$ uv tool run --python 3.12 wcgw
+$ pip3 install wcgw
+$ wcgw
 ```
 
+
 This will print a UUID that you need to share with the gpt.
 
 
@@ -42,20 +48,37 @@ NOTE: you can resume a broken connection
 # How it works
 Your commands are relayed through a server I've hosted at https://wcgw.arcfu.com. The code for that is at `src/relay/serve.py`. 
 
-Chat gpt sends a request to the relay server using the user id that you share with it. The relay server holds a websocket with the terminal cilent against the user id and acts as a proxy to pass the request.
+Chat gpt sends a request to the relay server using the user id that you share with it. The relay server holds a websocket with the terminal client against the user id and acts as a proxy to pass the request.
 
 It's secure in both the directions. Either a malicious actor or a malicious Chatgpt has to correctly guess your UUID for any security breach. 
 
-NOTE: the relay server doesn't store any data. If you don't trust it then you may host the server on your own and create a custom gpt. Create an issue and I'll be happy to share the full instructions and schema I've given in the custom GPT configuration. 
-
 # Showcase
 
+## Unit tests and github actions
+[The first version of unit tests and github workflow to test on multiple python versions were written by the custom chatgpt](https://chatgpt.com/share/6717f922-8998-8005-b825-45d4b348b4dd)
+
 ## Create a todo app using react + typescript + vite
-https://chatgpt.com/share/6717d94d-756c-8005-98a6-d021c7b586aa
+![Screenshot](https://github.com/rusiaaman/wcgw/blob/main/static/ss1.png?raw=true)
+
+
+# Privacy
+The relay server doesn't store any data. I can't access any information passing through it and only secure channels are used to communicate.
+
+You may host the server on your own and create a custom gpt using the following section.
+
+# Creating your own custom gpt and the relay server.
+I've used the following instructions and action json schema to create the custom GPT. (Replace wcgw.arcfu.com with the address to your server)
+
+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`
 
-## Write unit tests for all files in my current repo
-[Todo]
+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`
 
 # [Optional] Local shell access with openai API key
 

wcgw-0.1.1/gpt_action_json_schema.json

@@ -0,0 +1,231 @@
+
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "FastAPI",
+    "version": "0.1.0"
+  },
+  "servers": [
+    {"url": "https://wcgw.arcfu.com"}
+  ],
+  "paths": {
+    "/write_file": {
+      "post": {
+        "x-openai-isConsequential": false,
+        "summary": "Write File",
+        "operationId": "write_file_write_file__uuid__post",
+        "parameters": [
+          {
+            "name": "user_id",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "title": "User Id"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Writefile"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "title": "Response Write File Write File  Uuid  Post"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/execute_bash": {
+      "post": {
+        "x-openai-isConsequential": false,
+        "summary": "Execute Bash",
+        "operationId": "execute_bash_execute_bash__uuid__post",
+        "parameters": [
+          {
+            "name": "user_id",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "title": "User Id"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ExecuteBash"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "title": "Response Execute Bash Execute Bash  Uuid  Post"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "ExecuteBash": {
+        "properties": {
+          "execute_command": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Execute Command"
+          },
+          "send_ascii": {
+            "anyOf": [
+              {
+                "items": {
+                  "anyOf": [
+                    {
+                      "type": "integer"
+                    },
+                    {
+                      "type": "string",
+                      "enum": [
+                        "Key-up",
+                        "Key-down",
+                        "Key-left",
+                        "Key-right",
+                        "Enter",
+                        "Ctrl-c"
+                      ]
+                    }
+                  ]
+                },
+                "type": "array"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Send Ascii"
+          }
+        },
+        "type": "object",
+        "title": "ExecuteBash"
+      },
+      "HTTPValidationError": {
+        "properties": {
+          "detail": {
+            "items": {
+              "$ref": "#/components/schemas/ValidationError"
+            },
+            "type": "array",
+            "title": "Detail"
+          }
+        },
+        "type": "object",
+        "title": "HTTPValidationError"
+      },
+      "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"
+      },
+      "Writefile": {
+        "properties": {
+          "file_path": {
+            "type": "string",
+            "title": "File Path"
+          },
+          "file_content": {
+            "type": "string",
+            "title": "File Content"
+          }
+        },
+        "type": "object",
+        "required": [
+          "file_path",
+          "file_content"
+        ],
+        "title": "Writefile"
+      }
+    }
+  }
+}

wcgw-0.1.1/gpt_instructions.txt

@@ -0,0 +1,31 @@
+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 `wcgw.arcfu.com`
+
+Instructions for `Execute Bash`:
+- Execute a bash script. This is stateful (beware with subsequent calls).
+- Execute commands using `execute_command` attribute.
+- 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.
+- 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 ExecuteBash for writing files.
+
+---
+
+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.0.10 → wcgw-0.1.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 authors = [{ name = "Aman Rusia", email = "gapypi@arcfu.com" }]
 name = "wcgw"
-version = "0.0.10"
+version = "0.1.1"
 description = "What could go wrong giving full shell access to chatgpt?"
 readme = "README.md"
-requires-python = ">=3.8, <3.13"
+requires-python = ">=3.10, <3.13"
 dependencies = [
     "openai>=1.46.0",
     "mypy>=1.11.2",
@@ -27,7 +27,6 @@ dependencies = [
 [project.urls]
 Homepage = "https://github.com/rusiaaman/wcgw"
 
-
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"

{wcgw-0.0.10 → wcgw-0.1.1}/src/wcgw/basic.py

@@ -158,14 +158,16 @@ def loop(
         openai.pydantic_function_tool(
             ExecuteBash,
             description="""
-Execute a bash script. Stateful (beware with subsequent calls).
-Execute commands using `execute_command` attribute.
-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 user inputs. You can then send input using `send_ascii` attributes. You get status by sending `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.
-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.""",
+- Execute a bash script. This is stateful (beware with subsequent calls).
+- Execute commands using `execute_command` attribute.
+- 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.
+- 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.
+""",
         ),
         openai.pydantic_function_tool(
             Writefile,