Skip to content

Commit 8e0037a

Browse files
feat: update README for project rebranding and enhanced clarity
1 parent 6943ff7 commit 8e0037a

1 file changed

Lines changed: 84 additions & 68 deletions

File tree

README.md

Lines changed: 84 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,52 @@
11
<table style="width:100%" align="center" border="0">
22
<tr>
33
<td width="40%" align="center"><img src=".github/assets/fairy.png" alt="Winx" width="300"></td>
4-
<td><h1>✨ Winx Code Agent ✨</h1></td>
4+
<td><h1>✨ Winx ✨</h1></td>
55
</tr>
66
</table>
77

88
<p align="center">
9-
<strong> A high-performance code agent written in Rust, combining the best features of WCGW with reinforcement learning capabilities. 🦀</strong>
9+
<strong>🦀 A high-performance Rust implementation of WCGW for code agents 🦀</strong>
1010
</p>
1111

1212
<p align="center">
1313
<img src="https://img.shields.io/badge/language-Rust-orange?style=flat&logo=rust" alt="Language" />
1414
<img src="https://img.shields.io/badge/license-MIT-blue?style=flat&logo=appveyor" alt="License" />
15-
<img src="https://img.shields.io/github/languages/count/gabrielmaialva33/winx-code-agent?style=flat&logo=appveyor" alt="GitHub language count" >
16-
<img src="https://img.shields.io/github/repo-size/gabrielmaialva33/winx-code-agent?style=flat&logo=appveyor" alt="Repository size" >
17-
<a href="https://github.com/gabrielmaialva33/winx-code-agent/commits/master">
18-
<img src="https://img.shields.io/github/last-commit/gabrielmaialva33/winx-code-agent?style=flat&logo=appveyor" alt="Last Commit" >
15+
<img src="https://img.shields.io/github/languages/count/gabrielmaialva33/winx?style=flat&logo=appveyor" alt="GitHub language count" >
16+
<img src="https://img.shields.io/github/repo-size/gabrielmaialva33/winx?style=flat&logo=appveyor" alt="Repository size" >
17+
<a href="https://github.com/gabrielmaialva33/winx/commits/master">
18+
<img src="https://img.shields.io/github/last-commit/gabrielmaialva33/winx?style=flat&logo=appveyor" alt="Last Commit" >
1919
</a>
2020
<img src="https://img.shields.io/badge/made%20by-Maia-15c3d6?style=flat&logo=appveyor" alt="Made by Maia" >
2121
</p>
2222

2323
---
2424

25+
## 📖 Overview
26+
27+
Winx is a Rust reimplementation of [WCGW](https://github.com/rusiaaman/wcgw), providing shell execution and file management capabilities for LLM code agents. Designed for high performance and reliability, Winx integrates with Claude and other LLMs via the Model Context Protocol (MCP).
28+
2529
## 🌟 Features
2630

2731
-**High Performance**: Implemented in Rust for maximum efficiency
28-
- 🔄 **Reinforcement Learning**: Adaptive tool selection based on context and success patterns
2932
- 📁 **Advanced File Operations**:
30-
- 📖 Read files with line range support and chunking for large files
33+
- 📖 Read files with line range support
3134
- ✏️ Write new files with syntax validation
3235
- 🔍 Edit existing files with intelligent search/replace
33-
- ✅ Syntax checking to prevent code errors
3436
- 🖥️ **Command Execution**:
3537
- 🚀 Run shell commands with status tracking
36-
- 📺 Full GNU Screen integration for interactive sessions
37-
- 🔄 Automatic screen session management and orphan cleanup
38-
- 🖥️ Attach/detach from active sessions like wcgw
39-
- ⌨️ Interactive terminal commands with real-time feedback
40-
- 🏃‍♂️ Background process execution in detached screens
38+
- 📺 GNU Screen integration for interactive sessions
39+
- ⌨️ Send input to running commands
40+
- 🏃‍♂️ Background process execution
4141
- 🔀 **Operational Modes**:
4242
- 🔓 `wcgw`: Complete access to all features
4343
- 🔎 `architect`: Read-only mode for planning and analysis
4444
- 🔒 `code_writer`: Restricted access for controlled modifications
4545
- 📊 **Project Management**:
4646
- 📝 Repository structure analysis
4747
- 💾 Context saving and task resumption
48-
- 🧠 Task memory system
4948
- 🖼️ **Media Support**: Read images and encode as base64
50-
- 🧩 **RMCP Protocol**: Seamless integration with Claude and other LLMs
49+
- 🧩 **MCP Protocol**: Seamless integration with Claude and other LLMs
5150

5251
---
5352

@@ -57,12 +56,11 @@
5756

5857
- Rust 1.70 or higher
5958
- Tokio runtime
60-
- RMCP SDK
6159

6260
### 1. Clone the Repository
6361

6462
```bash
65-
git clone https://github.com/gabrielmaialva33/winx-code-agent.git && cd winx-code-agent
63+
git clone https://github.com/gabrielmaialva33/winx.git && cd winx
6664
```
6765

6866
### 2. Build the Project
@@ -82,22 +80,22 @@ cargo build --release
8280
cargo run
8381

8482
# Or directly
85-
./target/release/winx-code-agent
83+
./target/release/winx
8684
```
8785

8886
---
8987

9088
## 🔧 Integration with Claude
9189

92-
Winx Code Agent is designed to work seamlessly with Claude via the MCP interface:
90+
Winx is designed to work seamlessly with Claude via the MCP interface:
9391

9492
1. **Edit Claude's Configuration**
9593
```json
9694
// In claude_desktop_config.json (Mac: ~/Library/Application Support/Claude/claude_desktop_config.json)
9795
{
9896
"mcpServers": {
9997
"winx": {
100-
"command": "/path/to/winx-code-agent",
98+
"command": "/path/to/winx",
10199
"args": [],
102100
"env": {
103101
"RUST_LOG": "info"
@@ -115,107 +113,125 @@ Winx Code Agent is designed to work seamlessly with Claude via the MCP interface
115113

116114
## 🛠️ Available Tools
117115

118-
### 🚀 Initialize
116+
### 🚀 initialize
119117

120118
Always call this first to set up your workspace environment.
121119

122-
### 🖥️ BashCommand
120+
```
121+
initialize(
122+
type="first_call",
123+
any_workspace_path="/path/to/project",
124+
mode_name="wcgw"
125+
)
126+
```
127+
128+
### 🖥️ bash_command
123129

124130
Execute shell commands with intelligent error handling and status tracking.
125131

126-
### 📁 File Operations
132+
```
133+
bash_command(
134+
action_json={"command": "ls -la"},
135+
chat_id="i1234"
136+
)
137+
```
127138

128-
- **ReadFiles**: Read file content with line range support
129-
- **WriteIfEmpty**: Create new files safely
130-
- **FileEdit**: Edit existing files using intelligent search/replace
131-
- **ReadImage**: Process image files as base64
139+
### 📁 File Operations
132140

133-
### 💾 ContextSave
141+
- **read_files**: Read file content with line range support
142+
```
143+
read_files(
144+
file_paths=["/path/to/file.rs"],
145+
show_line_numbers_reason=null
146+
)
147+
```
148+
149+
- **file_write_or_edit**: Write or edit files
150+
```
151+
file_write_or_edit(
152+
file_path="/path/to/file.rs",
153+
percentage_to_change=100,
154+
file_content_or_search_replace_blocks="content...",
155+
chat_id="i1234"
156+
)
157+
```
158+
159+
- **read_image**: Process image files as base64
160+
```
161+
read_image(
162+
file_path="/path/to/image.png"
163+
)
164+
```
165+
166+
### 💾 context_save
134167

135168
Save task context for later resumption.
136169

170+
```
171+
context_save(
172+
id="task_name",
173+
project_root_path="/path/to/project",
174+
description="Task description",
175+
relevant_file_globs=["**/*.rs"]
176+
)
177+
```
178+
137179
---
138180

139181
## 👨‍💻 Usage Workflow
140182

141183
1. **Initialize the workspace**
142184
```
143-
initialize(path="/path/to/your/project")
185+
initialize(type="first_call", any_workspace_path="/path/to/your/project")
144186
```
145187

146188
2. **Explore the codebase**
147189
```
148-
bash_command(command="find . -type f -name '*.rs' | sort")
190+
bash_command(action_json={"command": "find . -type f -name '*.rs' | sort"}, chat_id="i1234")
149191
```
150192

151193
3. **Read key files**
152194
```
153-
read_files(files=["/path/to/important_file.rs"])
195+
read_files(file_paths=["/path/to/important_file.rs"])
154196
```
155197

156198
4. **Make changes**
157199
```
158-
file_edit(file="/path/to/file.rs", edit_blocks="...")
200+
file_write_or_edit(file_path="/path/to/file.rs", percentage_to_change=30,
201+
file_content_or_search_replace_blocks="<<<<<<< SEARCH\nold code\n=======\nnew code\n>>>>>>> REPLACE",
202+
chat_id="i1234")
159203
```
160204

161205
5. **Run tests**
162206
```
163-
bash_command(command="cargo test")
207+
bash_command(action_json={"command": "cargo test"}, chat_id="i1234")
164208
```
165209

166210
6. **Save context for later**
167211
```
168-
context_save(id="my_task", description="Implementation of feature X")
212+
context_save(id="my_task", project_root_path="/path/to/project",
213+
description="Implementation of feature X", relevant_file_globs=["src/**/*.rs"])
169214
```
170215

171216
---
172217

173-
## 📺 Screen Integration
174-
175-
Winx Code Agent now includes comprehensive GNU Screen integration, similar to wcgw:
176-
177-
- **Automatic session management**: Commands run in screen sessions when available
178-
- **Interactive terminal access**: Use `screen -x` to attach to running sessions
179-
- **Background process support**: Run long processes with `&` in detached screens
180-
- **Orphan cleanup**: Automatically detects and cleans abandoned sessions
181-
- **Screen commands**: List, attach, detach, and get content via tool actions
182-
183-
See [SCREEN_INTEGRATION.md](docs/SCREEN_INTEGRATION.md) for detailed documentation.
184-
185-
---
186-
187218
## 🏷 Need Support or Assistance?
188219

189-
If you need help or have any questions about Winx Code Agent, feel free to reach out via the following channels:
220+
If you need help or have any questions about Winx, feel free to reach out via the following channels:
190221

191-
- [GitHub Issues](https://github.com/gabrielmaialva33/winx-code-agent/issues/new?assignees=&labels=question&title=support%3A+):
222+
- [GitHub Issues](https://github.com/gabrielmaialva33/winx/issues/new?assignees=&labels=question&title=support%3A+):
192223
Open a support issue on GitHub.
193224
- Email: gabrielmaialva33@gmail.com
194225

195226
---
196227

197-
## ❣️ Support the Project
198-
199-
If you enjoy **Winx Code Agent** and want to support its development, consider:
200-
201-
-[Starring the repository](https://github.com/gabrielmaialva33/winx-code-agent) on GitHub.
202-
- 🍴 [Forking the repository](https://github.com/gabrielmaialva33/winx-code-agent) and contributing improvements.
203-
- 📝 Sharing your experience with tutorials or articles on [Dev.to](https://dev.to/), [Medium](https://medium.com/), or
204-
your personal blog.
205-
206-
Together, we can make **Winx Code Agent** even better!
207-
208-
---
209-
210228
## 🙏 Special Thanks
211229

212230
A huge thank you to [rusiaaman](https://github.com/rusiaaman) for the inspiring work
213-
on [WCGW](https://github.com/rusiaaman/wcgw), which served as a primary inspiration for this project. Winx Code Agent
214-
reimplements many of WCGW's best features in Rust for enhanced performance while adding reinforcement learning
215-
capabilities.
231+
on [WCGW](https://github.com/rusiaaman/wcgw), which served as the primary inspiration for this project. Winx reimplements WCGW's features in Rust for enhanced performance and reliability.
216232

217233
---
218234

219235
## 📜 License
220236

221-
MIT
237+
MIT

0 commit comments

Comments
 (0)