Skip to content

Commit a237167

Browse files
committed
Update readme desciption
1 parent c7c6c08 commit a237167

1 file changed

Lines changed: 69 additions & 1 deletion

File tree

README.md

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<div align="center">
44
<img src="assets/weco.svg" alt="Weco Logo" width="120" height="120" style="margin-bottom: 20px;">
5-
<h1>Weco: The Code Optimization Agent</h1>
5+
<h1>Weco: Production-Grade Autoresearch</h1>
66
</div>
77

88
[![Python](https://img.shields.io/badge/Python-3.8.0+-blue)](https://www.python.org)
@@ -14,6 +14,8 @@
1414

1515
`pip install weco`
1616

17+
[Docs](https://docs.weco.ai) &nbsp;&nbsp; [Examples](https://weco.ai/examples) &nbsp;&nbsp; [Dashboard](https://dashboard.weco.ai)
18+
1719
</div>
1820

1921
---
@@ -34,13 +36,79 @@ Example applications include:
3436

3537
The `weco` CLI leverages a tree search approach guided by LLMs to iteratively explore and refine your code. It automatically applies changes, runs your evaluation script, parses the results, and proposes further improvements based on the specified goal.
3638

39+
## Skills (Claude Code & Cursor)
40+
41+
Weco ships as a **skill** for AI coding assistants. A skill is a set of instructions that teaches your assistant how to use Weco end-to-end — from setting up optimizations to interpreting results. Once installed, just describe what you want to optimize in plain language and your assistant handles the rest.
42+
43+
```bash
44+
weco setup claude-code # installs skill into Claude Code
45+
weco setup cursor # installs skill into Cursor
46+
```
47+
48+
Then prompt naturally:
49+
50+
```text
51+
Use Weco to make this function faster.
52+
```
53+
54+
Your assistant will inspect your code, write the evaluation, configure `weco run`, monitor the iterations, and explain the results — no CLI flags needed.
55+
56+
See the full [Skills guide](https://docs.weco.ai/skills) for details.
57+
58+
## Observe (Track External Experiments)
59+
60+
Running your own optimization loop with an LLM agent, a custom script, or a manual workflow? `weco observe` lets you track those experiments in the Weco dashboard with tree visualization, code diffs, and metric tracking — without handing off control of the optimization itself.
61+
62+
```bash
63+
# Initialize a run
64+
WECO_RUN_ID=$(weco observe init --name "my-experiment" --metric val_bpb --goal min --source train.py)
65+
66+
# Log experiments
67+
weco observe log --run-id "$WECO_RUN_ID" --step 0 --description "baseline" \
68+
--metrics '{"val_bpb": 2.36}' --source train.py
69+
weco observe log --run-id "$WECO_RUN_ID" --step 1 --description "increase batch size" \
70+
--metrics '{"val_bpb": 2.26}' --source train.py
71+
```
72+
73+
All observe commands are fire-and-forget (always exit 0), so they never crash an agent loop. There is also a [Python SDK](https://docs.weco.ai/observe#python-sdk) for scripts with a Python loop.
74+
75+
See the full [Observe guide](https://docs.weco.ai/observe) for branching, lifecycle, and more.
76+
3777

3878
## Install the Package
3979

80+
**macOS / Linux** (recommended):
81+
82+
```bash
83+
curl -fsSL https://weco.ai/install.sh | sh
84+
```
85+
86+
**Windows CMD:**
87+
88+
```cmd
89+
powershell -ExecutionPolicy ByPass -c "irm https://weco.ai/install.ps1 | iex"
90+
```
91+
92+
**Windows PowerShell:**
93+
94+
```powershell
95+
irm https://weco.ai/install.ps1 | iex
96+
```
97+
98+
**pip:**
99+
40100
```bash
41101
pip install weco
42102
```
43103

104+
**From source:**
105+
106+
```bash
107+
git clone https://github.com/wecoai/weco-cli.git
108+
cd weco-cli
109+
pip install -e .
110+
```
111+
44112
## Getting Started
45113

46114
### Quickstart with an example project

0 commit comments

Comments
 (0)