openowl 0.3.19 → 0.3.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +49 -22
- package/bin/owl +1 -1
- package/install.js +1 -1
- package/package.json +7 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenOwl
|
|
2
2
|
|
|
3
|
-
AI desktop automation MCP server — give your AI eyes and hands.
|
|
3
|
+
AI desktop automation MCP server — give your AI assistant eyes and hands on your screen.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -8,50 +8,77 @@ AI desktop automation MCP server — give your AI eyes and hands.
|
|
|
8
8
|
npm install -g openowl
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
Or use directly with npx:
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
npx openowl
|
|
15
|
-
```
|
|
16
|
-
|
|
17
11
|
## Setup
|
|
18
12
|
|
|
19
|
-
1. Sign up at [openowl.dev/quick-setup](https://openowl.dev/quick-setup)
|
|
13
|
+
1. Sign up at [openowl.dev/quick-setup](https://openowl.dev/quick-setup) to get your API key
|
|
20
14
|
2. Save your API key:
|
|
21
15
|
|
|
22
|
-
**macOS / Linux:**
|
|
23
16
|
```bash
|
|
24
17
|
mkdir -p ~/.openowl
|
|
25
18
|
echo "owl-xxxx-xxxx-xxxx" > ~/.openowl/api.key
|
|
26
19
|
```
|
|
27
20
|
|
|
28
|
-
|
|
29
|
-
```powershell
|
|
30
|
-
New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.openowl"
|
|
31
|
-
"owl-xxxx-xxxx-xxxx" | Out-File "$env:USERPROFILE\.openowl\api.key" -Encoding utf8
|
|
32
|
-
```
|
|
21
|
+
3. Register with your AI assistant:
|
|
33
22
|
|
|
34
|
-
|
|
23
|
+
**Claude Code:**
|
|
35
24
|
```bash
|
|
36
25
|
claude mcp add owl --transport stdio -s user -- owl
|
|
37
26
|
```
|
|
38
27
|
|
|
28
|
+
**Codex CLI:** Add to `~/.codex/config.toml`:
|
|
29
|
+
```toml
|
|
30
|
+
[mcp_servers.owl]
|
|
31
|
+
command = "owl"
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
4. Verify:
|
|
35
|
+
```bash
|
|
36
|
+
owl --version
|
|
37
|
+
```
|
|
38
|
+
|
|
39
39
|
## What it does
|
|
40
40
|
|
|
41
|
-
OpenOwl
|
|
41
|
+
OpenOwl lets AI assistants operate your entire desktop — any app, any button, any workflow. Describe what you need in plain English, OpenOwl handles the clicking, typing, scrolling, and navigation.
|
|
42
|
+
|
|
43
|
+
Works with Claude Code, Codex CLI, Cursor, and any MCP-compatible AI.
|
|
42
44
|
|
|
43
45
|
## Supported platforms
|
|
44
46
|
|
|
45
|
-
- macOS
|
|
46
|
-
- Windows 10/11 (x64)
|
|
47
|
+
- macOS 11+ (Apple Silicon and Intel)
|
|
47
48
|
|
|
48
49
|
## Requirements
|
|
49
50
|
|
|
50
|
-
|
|
51
|
+
- Node.js 16+
|
|
52
|
+
- macOS: Grant Accessibility and Screen Recording permissions when prompted (System Settings > Privacy & Security)
|
|
53
|
+
|
|
54
|
+
## Free tier
|
|
55
|
+
|
|
56
|
+
50 tool calls/day, no credit card required. Upgrade at [openowl.dev/pricing](https://openowl.dev/pricing).
|
|
57
|
+
|
|
58
|
+
## How it works
|
|
59
|
+
|
|
60
|
+
OpenOwl is a compiled Python MCP server distributed as a native binary. The npm `postinstall` script downloads the prebuilt binary for your platform from [GitHub Releases](https://github.com/mihir-kanzariya/openowl-releases/releases) (public repo). The source code is at [github.com/mihir-kanzariya/OpenOwl](https://github.com/mihir-kanzariya/OpenOwl).
|
|
61
|
+
|
|
62
|
+
**What the binary does:**
|
|
63
|
+
- Captures screenshots via macOS native APIs (mss, Quartz)
|
|
64
|
+
- Sends keyboard/mouse input via PyAutoGUI
|
|
65
|
+
- Reads UI elements via the macOS Accessibility API
|
|
66
|
+
- Runs OCR via macOS Vision framework
|
|
67
|
+
- All processing happens locally on your machine
|
|
68
|
+
|
|
69
|
+
**Data collected (for usage metering only):**
|
|
70
|
+
- A hashed machine ID (SHA-256 of MAC address + hostname) to enforce per-device license limits
|
|
71
|
+
- Tool call counts sent to `openowl.dev/api/v1/usage/check` to enforce free-tier daily limits (50 calls/day)
|
|
72
|
+
- No screenshots, screen content, keystrokes, or personal data are ever sent to our servers
|
|
51
73
|
|
|
52
|
-
**
|
|
74
|
+
**Permissions required on macOS:**
|
|
75
|
+
- Accessibility (System Settings > Privacy & Security) — for keyboard/mouse control
|
|
76
|
+
- Screen Recording (System Settings > Privacy & Security) — for screenshots
|
|
53
77
|
|
|
54
78
|
## Links
|
|
55
79
|
|
|
56
|
-
- [Quick Setup](https://openowl.dev/quick-setup)
|
|
57
|
-
- [
|
|
80
|
+
- [Quick Setup Guide](https://openowl.dev/quick-setup)
|
|
81
|
+
- [Pricing](https://openowl.dev/pricing)
|
|
82
|
+
- [Dashboard](https://openowl.dev/dashboard)
|
|
83
|
+
- [Source Code](https://github.com/mihir-kanzariya/OpenOwl)
|
|
84
|
+
- [Binary Releases](https://github.com/mihir-kanzariya/openowl-releases/releases)
|
package/bin/owl
CHANGED
|
@@ -18,7 +18,7 @@ const crypto = require("crypto");
|
|
|
18
18
|
const { spawn } = require("child_process");
|
|
19
19
|
|
|
20
20
|
// ── Version check ──────────────────────────────────────────────
|
|
21
|
-
const VERSION = "0.3.
|
|
21
|
+
const VERSION = "0.3.20";
|
|
22
22
|
if (process.argv[2] === "--version" || process.argv[2] === "-v") {
|
|
23
23
|
console.log(`OpenOwl v${VERSION}`);
|
|
24
24
|
process.exit(0);
|
package/install.js
CHANGED
|
@@ -9,7 +9,7 @@ const http = require("http");
|
|
|
9
9
|
const { execSync } = require("child_process");
|
|
10
10
|
const zlib = require("zlib");
|
|
11
11
|
|
|
12
|
-
const VERSION = "0.3.
|
|
12
|
+
const VERSION = "0.3.20";
|
|
13
13
|
const BASE_URL =
|
|
14
14
|
`https://github.com/mihir-kanzariya/openowl-releases/releases/download/v${VERSION}`;
|
|
15
15
|
|
package/package.json
CHANGED
|
@@ -1,13 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "openowl",
|
|
3
|
-
"version": "0.3.
|
|
4
|
-
"description": "AI desktop automation MCP server — give your AI eyes and hands",
|
|
3
|
+
"version": "0.3.21",
|
|
4
|
+
"description": "AI desktop automation MCP server — give your AI eyes and hands. Screen capture, clicking, typing, OCR, window management via MCP protocol.",
|
|
5
5
|
"homepage": "https://openowl.dev",
|
|
6
|
+
"author": "Mihir Kanzariya <kanzariyamihir@gmail.com> (https://openowl.dev)",
|
|
6
7
|
"repository": {
|
|
7
8
|
"type": "git",
|
|
8
9
|
"url": "https://github.com/mihir-kanzariya/OpenOwl"
|
|
9
10
|
},
|
|
10
|
-
"
|
|
11
|
+
"bugs": {
|
|
12
|
+
"url": "https://github.com/mihir-kanzariya/OpenOwl/issues"
|
|
13
|
+
},
|
|
14
|
+
"license": "BUSL-1.1",
|
|
11
15
|
"bin": {
|
|
12
16
|
"owl": "bin/owl"
|
|
13
17
|
},
|