Skip to content

Commit d0f9f17

Browse files
committed
docs: Add CLAUDE.md project guide
1 parent 05a2f11 commit d0f9f17

File tree

1 file changed

+105
-0
lines changed

1 file changed

+105
-0
lines changed

CLAUDE.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Terminator - AI-Native GUI Automation
2+
3+
Open-source desktop automation framework (MIT). Gives AI hands to control any app on Windows/macOS/Linux.
4+
100x faster than generic AI agents, >95% success rate.
5+
6+
**Mediar AI** | [$2.8M seed](https://x.com/louis030195/status/1948745185178914929) | [mediar.ai](https://mediar.ai)
7+
8+
## Packages
9+
10+
```
11+
terminator/ # Core Rust (terminator-rs)
12+
packages/
13+
terminator-nodejs/ # @mediar-ai/terminator (npm)
14+
terminator-python/ # terminator (PyPI)
15+
workflow/ # @mediar-ai/workflow (npm)
16+
terminator-cli/ # CLI (version mgmt, workflows)
17+
terminator-mcp-agent/ # MCP server (npm)
18+
terminator-workflow-recorder/ # Record actions → YAML
19+
```
20+
21+
**Current version**: `0.20.6` across all packages
22+
23+
## Release Management
24+
25+
**CRITICAL**: Use `terminator` CLI only. It syncs versions across workspace.
26+
27+
```bash
28+
# Install once
29+
cargo install --path terminator-cli
30+
31+
# Release (most common)
32+
terminator release # Bump patch → tag → push (triggers CI/CD)
33+
34+
# Manual
35+
terminator status # Check versions
36+
terminator patch # Bump 0.20.6 → 0.20.7
37+
terminator sync # Sync all packages
38+
terminator tag # Tag + push
39+
```
40+
41+
**Never manually edit versions in package.json or Cargo.toml files.**
42+
43+
Git tag `v0.20.6` triggers:
44+
- `publish-npm.yml`@mediar-ai/terminator to npm
45+
- `publish-mcp.yml` → terminator-mcp-agent to npm
46+
- `ci-wheels.yml` → Python wheels (manual PyPI publish)
47+
48+
## Development
49+
50+
```bash
51+
# Setup
52+
git clone https://github.com/mediar-ai/terminator
53+
cd terminator
54+
cargo build
55+
56+
# Test
57+
cargo test
58+
cargo fmt && cargo clippy
59+
60+
# Speed up builds (optional)
61+
cargo install sccache
62+
export RUSTC_WRAPPER=sccache
63+
```
64+
65+
## Commit Style
66+
67+
```
68+
type(scope): description
69+
70+
feat(core): add locator strategy
71+
fix(mcp): resolve timeout issue
72+
refactor: rename terminator.js → @mediar-ai/terminator
73+
```
74+
75+
## Package Names
76+
77+
- npm: `@mediar-ai/terminator` (5 platform packages: `-darwin-arm64`, `-darwin-x64`, `-linux-x64-gnu`, `-win32-arm64-msvc`, `-win32-x64-msvc`)
78+
- PyPI: `terminator`
79+
- crates.io: `terminator-rs`
80+
81+
**Recently renamed**: `terminator.js``@mediar-ai/terminator` (check old refs if issues)
82+
83+
## MCP Debugging
84+
85+
Logs: `%LOCALAPPDATA%\claude-cli-nodejs\Cache\*\mcp-logs-terminator-mcp-agent\*.txt` (Windows)
86+
87+
```json
88+
{
89+
"mcpServers": {
90+
"terminator-mcp-agent": {
91+
"env": {
92+
"LOG_LEVEL": "debug",
93+
"RUST_BACKTRACE": "1"
94+
}
95+
}
96+
}
97+
}
98+
```
99+
100+
## Repo Rules
101+
102+
- ❌ NO dead code, redundant files, verbose docs
103+
- ✅ Ask before creating files
104+
- ✅ Clean up before commits
105+
- ✅ Keep it high signal

0 commit comments

Comments
 (0)