Wcgw

🚀 Shell Usage Instructions

This document provides a comprehensive guide on installing, configuring, and using the Shell tool, including installation methods, configuration steps, usage examples, and optional features.

🚀 Quick Start

Running via Docker

1. Pull the official Docker image:

docker pull amanrusia/wcgw:latest

2. Start the container and mount the working directory (e.g., mount /Users/username/Desktop on the host to /workspace/Desktop inside the container):

docker run -it --rm --mount type=bind,src=/Users/username/Desktop,dst=/workspace/Desktop amanrusia/wcgw:latest

Local Installation and Running

1. Clone the repository:

git clone https://github.com/rusiaaman/wcgw.git

2. Navigate to the directory and start the application:

cd wcgw && python3 -m wcgw.main start

📦 Installation Guide

Configuring the MCP Server

Modifying the Configuration File

Edit the claude_desktop_config.json file and add the following content:

{
  "mcpServers": {
    "filesystem": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--mount",
        "type=bind,src=/Users/username/Desktop,dst=/workspace/Desktop",
        "amanrusia/wcgw:latest"
      ]
    }
  }
}

💻 Usage Examples

Example

Additional Features

Screen Terminal Access

1. List all screen sessions:

screen -ls

2. Connect to a specific wcgw session (e.g., 93358.wcgw.235521):

screen -x 93358.wcgw.235521

Using the VS Code Extension

Install and use the wcgw VS Code Extension to invoke Claude using shortcuts.

🔧 Optional Features

OpenAI Integration

Set the environment variables:

export OPENAI_API_KEY="your_api_key"
export OPENAI_ORG_ID="your_org_id"

Run the command:

uvx wcgw@latest wc