Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rusiaaman/wcgw
https://github.com/rusiaaman/wcgw
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rusiaaman/wcgw
- Owner: rusiaaman
- Created: 2024-09-20T14:03:30.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T14:34:37.000Z (3 months ago)
- Last Synced: 2024-10-23T17:13:33.353Z (3 months ago)
- Language: Python
- Size: 288 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mcp-servers - Shell - Autonomous shell execution and computer control (Mac) (🤖 <a name="system-automation"></a>System Automation)
- awesome-mcp-servers - Shell - Autonomous shell execution and computer control (Mac) (🤖 <a name="system-automation"></a>System Automation)
README
# Shell and Coding agent for Claude and Chatgpt
- Claude - An MCP server on claude desktop for autonomous shell, coding and desktop control agent.
- Chatgpt - Allows custom gpt to talk to your shell via a relay server.
[](https://github.com/rusiaaman/wcgw/actions/workflows/python-tests.yml)
[](https://github.com/rusiaaman/wcgw/actions/workflows/python-types.yml)
[](https://github.com/rusiaaman/wcgw/actions/workflows/python-publish.yml)
## Updates
- [01 Dec 2024] Removed author hosted relay server for chatgpt.
- [26 Nov 2024] Introduced claude desktop support through mcp
## 🚀 Highlights
- âš¡ **Full Shell Access**: No restrictions, complete control.
- âš¡ **Desktop control on Claude**: Screen capture, mouse control, keyboard control on claude desktop (on mac with docker linux)
- âš¡ **Create, Execute, Iterate**: Ask claude 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.
- âš¡ **Large file edit**: Supports large file incremental edits to avoid token limit issues. Faster than full file write.
- âš¡ **Interactive Command Handling**: Supports interactive commands using arrow keys, interrupt, and ansi escape sequences.
- âš¡ **REPL support**: [beta] Supports python/node and other REPL execution.
## Claude Setup
Update `claude_desktop_config.json` (~/Library/Application Support/Claude/claude_desktop_config.json)
```json
{
"mcpServers": {
"wcgw": {
"command": "uv",
"args": [
"tool",
"run",
"--from",
"wcgw@latest",
"--python",
"3.12",
"wcgw_mcp"
]
}
}
}
```
Then restart claude app.
### [Optional] Computer use support using desktop on docker
Computer use is disabled by default. Add `--computer-use` to enable it. This will add necessary tools to Claude including ScreenShot, Mouse and Keyboard control.
```json
{
"mcpServers": {
"wcgw": {
"command": "uv",
"args": [
"tool",
"run",
"--from",
"wcgw@latest",
"--python",
"3.12",
"wcgw_mcp",
"--computer-use"
]
}
}
}
```
Claude will be able to connect to any docker container with linux environment. Native system control isn't supported outside docker.
You'll need to run a docker image with desktop and optional VNC connection. Here's a demo image:
```sh
docker run -p 6080:6080 ghcr.io/anthropics/anthropic-quickstarts:computer-use-demo-latest
```
Then ask claude desktop app to control the docker os. It'll connect to the docker container and control it.
Connect to `http://localhost:6080/vnc.html` for desktop view (VNC) of the system running in the docker.
## Usage
Wait for a few seconds. You should be able to see this icon if everything goes right.
over here
Then ask claude to execute shell commands, read files, edit files, run your code, etc.
If you've run the docker for LLM to access, you can ask it to control the "docker os". If you don't provide the docker container id to it, it'll try to search for available docker using `docker ps` command.
## Chatgpt Setup
Read here: https://github.com/rusiaaman/wcgw/blob/main/openai.md
## Examples
### Computer use example
### Shell example
## [Optional] Local shell access with openai API key or anthropic API key
### Openai
Add `OPENAI_API_KEY` and `OPENAI_ORG_ID` env variables.
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
Add `ANTHROPIC_API_KEY` env variable.
Then run
`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.