wcgw 1.3.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

{wcgw-1.3.0.dist-info → wcgw-1.5.0.dist-info}/METADATA

@@ -1,12 +1,13 @@
 Metadata-Version: 2.3
 Name: wcgw
-Version: 1.3.0
+Version: 1.5.0
 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-Python: <3.13,>=3.11
 Requires-Dist: anthropic>=0.39.0
 Requires-Dist: fastapi>=0.115.0
+Requires-Dist: mcp>=1.0.0
 Requires-Dist: mypy>=1.11.2
 Requires-Dist: nltk>=3.9.1
 Requires-Dist: openai>=1.46.0
@@ -26,82 +27,124 @@ Requires-Dist: uvicorn>=0.31.0
 Requires-Dist: websockets>=13.1
 Description-Content-Type: text/markdown
 
-# Enable shell access on chatgpt.com
-A custom gpt on chatgpt web app to interact with your local shell.
+# Shell and Coding agent on Chatgpt and Claude desktop apps
+
+A custom gpt on chatgpt web/desktop apps to interact with your local shell, edit files, run code, etc.
 
 [![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)
 
+[New feature] [26-Nov-2024] Claude desktop support for shell, computer-control, coding agent.
+[src/wcgw/client/mcp_server/Readme.md](src/wcgw/client/mcp_server/Readme.md)
+
 ### 🚀 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**: 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: 
+## Claude
+Full readme [src/wcgw/client/mcp_server/Readme.md](src/wcgw/client/mcp_server/Readme.md)
+### Setup
+
+Update `claude_desktop_config.json`
+
+```json
+{
+  "mcpServers": {
+    "wcgw": {
+      "command": "uvx",
+      "args": ["--from", "wcgw@latest", "wcgw_mcp"]
+    }
+  }
+}
+```
+
+Then restart claude app.
+You can then ask claude to execute shell commands, read files, edit files, run your code, etc.
+
+## ChatGPT
+
+### 🪜 Steps:
+
 1. Run the [cli client](https://github.com/rusiaaman/wcgw?tab=readme-ov-file#client) in any directory of choice.
 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
 
-## 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 uv [Recommended]
+#### Option 1: using uv [Recommended]
+
 ```sh
 $ curl -LsSf https://astral.sh/uv/install.sh | sh
-$ uv tool run --python 3.12 wcgw@latest
+$ uvx wcgw@latest
 ```
 
-### Option 2: using pip
+#### Option 2: using pip
+
 Supports python >=3.10 and <3.13
+
 ```sh
 $ pip3 install wcgw
 $ wcgw
 ```
 
-
 This will print a UUID that you need to share with the gpt.
 
+### Chat
 
-## Chat
 Open the following link or search the "wcgw" custom gpt using "Explore GPTs" on chatgpt.com
 
 https://chatgpt.com/g/g-Us0AAXkRh-wcgw-giving-shell-access
 
 Finally, let the chatgpt know your user id in any format. E.g., "user_id=<your uuid>" followed by rest of your instructions.
 
-NOTE: you can resume a broken connection 
+NOTE: you can resume a broken connection
 `wcgw --client-uuid $previous_uuid`
 
-# How it works
+### How it works on chatgpt app?
+
 Your commands are relayed through a server to the terminal client. [You could host the server on your own](https://github.com/rusiaaman/wcgw?tab=readme-ov-file#creating-your-own-custom-gpt-and-the-relay-server). For public convenience I've hosted one at https://wcgw.arcfu.com thanks to the gcloud free tier plan.
 
 Chatgpt 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. 
+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.
 
 # Showcase
 
-## Unit tests and github actions
+## Claude desktop
+
+### Resize image and move it to a new dir
+
+![example](https://github.com/rusiaaman/wcgw/blob/main/static/example.jpg?raw=true)
+
+## Chatgpt app
+
+### 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
-![Screenshot](https://github.com/rusiaaman/wcgw/blob/main/static/ss1.png?raw=true)
+### Create a todo app using react + typescript + vite
 
+![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 
+Run the server
 `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.
@@ -109,16 +152,24 @@ If you don't have public ip and domain name, you can use `ngrok` or similar serv
 The specify the server url in the `wcgw` command like so
 `wcgw --server-url https://your-url/v1/register`
 
-# [Optional] Local shell access with openai API key
+# [Optional] Local shell access with openai API key or anthropic API key
+
+## Openai
 
 Add `OPENAI_API_KEY` and `OPENAI_ORG_ID` env variables.
 
-Clone the repo and run to install `wcgw_local` command
+Then run
+
+`uvx --from wcgw@latest wcgw_local  --limit 0.1` # Cost limit $0.1
+
+You can now directly write messages or press enter key to open vim for multiline message and text pasting.
+
+## Anthropic
 
-`pip install .`
+Add `ANTHROPIC_API_KEY` env variable.
 
-Then run 
+Then run
 
-`wcgw_local  --limit 0.1` # Cost limit $0.1 
+`uvx --from wcgw@latest wcgw_local --claude`
 
 You can now directly write messages or press enter key to open vim for multiline message and text pasting.

wcgw-1.5.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+wcgw/__init__.py,sha256=9K2QW7QuSLhMTVbKbBYd9UUp-ZyrfBrxcjuD_xk458k,118
+wcgw/types_.py,sha256=STKGeVdQNK_k8mcmAXpKZJY9YUpU7-mbJcFpXfzBuys,1732
+wcgw/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+wcgw/client/__main__.py,sha256=wcCrL4PjG51r5wVKqJhcoJPTLfHW0wNbD31DrUN0MWI,28
+wcgw/client/anthropic_client.py,sha256=owR-nIxQVGgw_ned8JOQ-QmmCBQvZSqgD08kYpU_Rbg,17730
+wcgw/client/cli.py,sha256=Oja42CHkVO8puqOXflko9NeephYCMa85aBmQTEjBZtI,932
+wcgw/client/common.py,sha256=grH-yV_4tnTQZ29xExn4YicGLxEq98z-HkEZwH0ReSg,1410
+wcgw/client/computer_use.py,sha256=jZCw4p7qfHEmhv9eqc1zyPyLTUyb54Ipw5UnRqzRWqc,14399
+wcgw/client/diff-instructions.txt,sha256=s5AJKG23JsjwRYhFZFQVvwDpF67vElawrmdXwvukR1A,1683
+wcgw/client/openai_client.py,sha256=L61ajFVQW2QPS3C0n1YsjgF4vQKfMIZHmp6iFBHutX8,17748
+wcgw/client/openai_utils.py,sha256=YNwCsA-Wqq7jWrxP0rfQmBTb1dI0s7dWXzQqyTzOZT4,2629
+wcgw/client/sys_utils.py,sha256=7_7o1Au33OkZUsW5nKW55xW_YRYZlvUpY6tHVLIILm8,1254
+wcgw/client/tools.py,sha256=PbS1YBELqibShPrpKCGq3KeXLS4t6AhTTkB5pQMgX-g,32476
+wcgw/client/mcp_server/Readme.md,sha256=dK9NqFQ0_tblLOgPI6DjWrSYs2UWKEJkvgnLW3T-EZk,1944
+wcgw/client/mcp_server/__init__.py,sha256=cQ7PUrEmXUpio8x0SEoGWP5hCRPd7z2bAkNCbYbtTys,236
+wcgw/client/mcp_server/server.py,sha256=EzO4VNuSfcIMTue3sCsCqTTMku_AmsgJctBuPQfEQ8w,10160
+wcgw/relay/serve.py,sha256=RUcUeyL4Xt0EEo12Ul6VQjb4tRle4uIdsa85v7XXxEw,8771
+wcgw/relay/static/privacy.txt,sha256=s9qBdbx2SexCpC_z33sg16TptmAwDEehMCLz4L50JLc,529
+wcgw-1.5.0.dist-info/METADATA,sha256=_bTBKk1cMtbqt7dgM-wge3LuNCTe4s1CDzdSyR7P3WU,6292
+wcgw-1.5.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+wcgw-1.5.0.dist-info/entry_points.txt,sha256=eKo1omwbAggWlQ0l7GKoR7uV1-j16nk9tK0BhC2Oz_E,120
+wcgw-1.5.0.dist-info/RECORD,,

{wcgw-1.3.0.dist-info → wcgw-1.5.0.dist-info}/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
 wcgw = wcgw:listen
 wcgw_local = wcgw:app
+wcgw_mcp = wcgw:mcp_server
 wcgw_relay = wcgw.relay.serve:run

wcgw-1.3.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-wcgw/__init__.py,sha256=PNWvBvjUKA3aj4bHOtIqBKCAtOW88pr0hAXZ7RylVr8,68
-wcgw/types_.py,sha256=k6YhW9ePQ1oFbsPe7nQKndzJTzhulEdufvnFI3qg9vY,1124
-wcgw/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wcgw/client/__main__.py,sha256=ngI_vBcLAv7fJgmS4w4U7tuWtalGB8c7W5qebuT6Z6o,30
-wcgw/client/anthropic_client.py,sha256=yLBygok_z8Tpzedi28fpEP084wNth4qeiivZejFWRGY,15610
-wcgw/client/cli.py,sha256=Oja42CHkVO8puqOXflko9NeephYCMa85aBmQTEjBZtI,932
-wcgw/client/common.py,sha256=grH-yV_4tnTQZ29xExn4YicGLxEq98z-HkEZwH0ReSg,1410
-wcgw/client/diff-instructions.txt,sha256=s5AJKG23JsjwRYhFZFQVvwDpF67vElawrmdXwvukR1A,1683
-wcgw/client/openai_client.py,sha256=xuLsu9KHG9wssPOjTrQ6rFi3FtWufZ5RtK29Yb_j5O4,17718
-wcgw/client/openai_utils.py,sha256=YNwCsA-Wqq7jWrxP0rfQmBTb1dI0s7dWXzQqyTzOZT4,2629
-wcgw/client/tools.py,sha256=Q5qxpCjsz43aBzqpuMQ25cke_pUh3EKYeO8WC9pPpls,28225
-wcgw/relay/serve.py,sha256=ArDnLVUAtcSVxyKTzmFN-Rx09zJXRlszmNBXGrH9JtU,8863
-wcgw/relay/static/privacy.txt,sha256=s9qBdbx2SexCpC_z33sg16TptmAwDEehMCLz4L50JLc,529
-wcgw-1.3.0.dist-info/METADATA,sha256=c7_mF4ki8YX5-OBM606mcK7ZUo4YgAVF-FFeYCMIrhY,5255
-wcgw-1.3.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-wcgw-1.3.0.dist-info/entry_points.txt,sha256=WlIB825-Vm9ZtNzgENQsbHj4DRMkbpVR7uSkQyBlaPA,93
-wcgw-1.3.0.dist-info/RECORD,,