Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rusiaaman authored Dec 1, 2024
1 parent 1047b21 commit b311a4d
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Shell and Coding agent on Claude desktop app
# Shell and Coding agent for Claude and Chatgpt

- An MCP server on claude desktop for autonomous shell, coding and desktop control agent.
- 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.

[![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)
[![Mypy strict](https://github.com/rusiaaman/wcgw/actions/workflows/python-types.yml/badge.svg?branch=main)](https://github.com/rusiaaman/wcgw/actions/workflows/python-types.yml)
[![Build](https://github.com/rusiaaman/wcgw/actions/workflows/python-publish.yml/badge.svg)](https://github.com/rusiaaman/wcgw/actions/workflows/python-publish.yml)

## Updates

- [01 Dec 2024] Deprecated chatgpt app support
- [01 Dec 2024] Removed author hosted relay server for chatgpt.

- [26 Nov 2024] Introduced claude desktop support through mcp

Expand All @@ -20,7 +21,7 @@
-**Interactive Command Handling**: Supports interactive commands using arrow keys, interrupt, and ansi escape sequences.
-**REPL support**: [beta] Supports python/node and other REPL execution.

## Setup
## Claude Setup

Update `claude_desktop_config.json` (~/Library/Application Support/Claude/claude_desktop_config.json)

Expand All @@ -45,7 +46,7 @@ Update `claude_desktop_config.json` (~/Library/Application Support/Claude/claude

Then restart claude app.

## [Optional] Computer use support using desktop on docker
### [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.

Expand Down Expand Up @@ -94,7 +95,12 @@ Then ask claude to execute shell commands, read files, edit files, run your code

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.

## Example

## Chatgpt Setup

Read here: https://github.com/rusiaaman/wcgw/blob/main/openai.md

## Examples

### Computer use example

Expand All @@ -104,6 +110,7 @@ If you've run the docker for LLM to access, you can ask it to control the "docke

![example](https://github.com/rusiaaman/wcgw/blob/main/static/example.jpg?raw=true)


## [Optional] Local shell access with openai API key or anthropic API key

### Openai
Expand Down

0 comments on commit b311a4d

Please sign in to comment.