@steipete/peekaboo 3.0.0-beta1 → 3.0.0-beta3

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.
Files changed (3) hide show
  1. package/README.md +8 -8
  2. package/package.json +11 -7
  3. package/peekaboo +0 -0
package/README.md CHANGED
@@ -12,7 +12,7 @@
12
12
  [![Ask DeepWiki](https://img.shields.io/badge/Ask-DeepWiki-0088cc?style=flat-square)](https://deepwiki.com/steipete/peekaboo)
13
13
 
14
14
  Peekaboo brings high-fidelity screen capture, AI analysis, and complete GUI automation to macOS. Version 3 adds native agent flows and multi-screen automation across the CLI and MCP server.
15
- > Note: v3 is currently in beta (3.0.0-beta1) and has a few known issues; see the changelog for details.
15
+ > Note: v3 is currently in beta (3.0.0-beta3) and has a few known issues; see the changelog for details.
16
16
 
17
17
  ## What you get
18
18
  - Pixel-accurate captures (windows, screens, menu bar) with optional Retina 2x scaling.
@@ -39,8 +39,8 @@ Peekaboo brings high-fidelity screen capture, AI analysis, and complete GUI auto
39
39
  peekaboo image --mode screen --retina --path ~/Desktop/screen.png
40
40
 
41
41
  # Click a button by label (captures, resolves, and clicks in one go)
42
- peekaboo see --app Safari --json-output | jq -r '.data.session_id' | read SID
43
- peekaboo click --on "Reload this page" --session "$SID"
42
+ peekaboo see --app Safari --json-output | jq -r '.data.snapshot_id' | read SNAPSHOT
43
+ peekaboo click --on "Reload this page" --snapshot "$SNAPSHOT"
44
44
 
45
45
  # Run a natural-language automation
46
46
  peekaboo "Open Notes and create a TODO list with three items"
@@ -64,8 +64,8 @@ npx -y @steipete/peekaboo
64
64
 
65
65
  | Command | Key flags / subcommands | What it does |
66
66
  | --- | --- | --- |
67
- | [see](docs/commands/see.md) | `--app`, `--mode screen/window`, `--retina`, `--json-output` | Capture and annotate UI, return session + element IDs |
68
- | [click](docs/commands/click.md) | `--on <id/query>`, `--session`, `--wait`, coords | Click by element ID, label, or coordinates |
67
+ | [see](docs/commands/see.md) | `--app`, `--mode screen/window`, `--retina`, `--json-output` | Capture and annotate UI, return snapshot + element IDs |
68
+ | [click](docs/commands/click.md) | `--on <id/query>`, `--snapshot`, `--wait`, coords | Click by element ID, label, or coordinates |
69
69
  | [type](docs/commands/type.md) | `--text`, `--clear`, `--delay-ms` | Enter text with pacing options |
70
70
  | [press](docs/commands/press.md) | key names, `--repeat` | Special keys and sequences |
71
71
  | [hotkey](docs/commands/hotkey.md) | combos like `cmd,shift,t` | Modifier combos (cmd/ctrl/alt/shift) |
@@ -82,14 +82,14 @@ npx -y @steipete/peekaboo
82
82
  | [dialog](docs/commands/dialog.md) | `list`, `click`, `input`, `file`, `dismiss` | Drive system dialogs (open/save/etc.) |
83
83
  | [image](docs/commands/image.md) | `--mode screen/window/menu`, `--retina`, `--analyze` | Screenshot screen/window/menu bar (+analyze) |
84
84
  | [list](docs/commands/list.md) | `apps`, `windows`, `screens`, `menubar`, `permissions` | Enumerate apps, windows, screens, permissions |
85
- | [tools](docs/commands/tools.md) | `--source native\|mcp`, `--server <name>` | Inspect native + MCP tools |
85
+ | [tools](docs/commands/tools.md) | `--verbose`, `--json-output`, `--no-sort` | Inspect native Peekaboo tools |
86
86
  | [config](docs/commands/config.md) | `init`, `show`, `add`, `login`, `models` | Manage credentials/providers/settings |
87
87
  | [permissions](docs/commands/permissions.md) | `status`, `grant` | Check/grant required macOS permissions |
88
88
  | [run](docs/commands/run.md) | `.peekaboo.json`, `--output`, `--no-fail-fast` | Execute `.peekaboo.json` automation scripts |
89
89
  | [sleep](docs/commands/sleep.md) | `--duration` (ms) | Millisecond delays between steps |
90
- | [clean](docs/commands/clean.md) | `--all-sessions`, `--older-than`, `--session` | Prune sessions and caches |
90
+ | [clean](docs/commands/clean.md) | `--all-snapshots`, `--older-than`, `--snapshot` | Prune snapshots and caches |
91
91
  | [agent](docs/commands/agent.md) | `--model`, `--dry-run`, `--resume`, `--max-steps`, audio | Natural-language multi-step automation |
92
- | [mcp](docs/commands/mcp.md) | `serve`, `list`, `add`, `enable/disable`, `test` | Manage external MCP servers and serve Peekaboo |
92
+ | [mcp](docs/commands/mcp.md) | `serve` (default) | Run Peekaboo as an MCP server |
93
93
 
94
94
  ## Models and providers
95
95
  - OpenAI: GPT-5.1 (default) and GPT-4.1/4o vision
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@steipete/peekaboo",
3
- "version": "3.0.0-beta1",
3
+ "version": "3.0.0-beta3",
4
4
  "description": "macOS automation MCP server with screen capture, UI interaction, and AI analysis",
5
5
  "private": false,
6
6
  "type": "module",
@@ -21,11 +21,12 @@
21
21
  "build:swift": "./runner ./scripts/build-swift-arm.sh",
22
22
  "build:swift:all": "./runner ./scripts/build-swift-universal.sh",
23
23
  "build:polter": "./runner polter peekaboo --version",
24
+ "app:restart": "./runner ./scripts/restart-peekaboo.sh",
24
25
  "build": "pnpm run build:cli",
25
26
  "test:safe": "./runner swift test --package-path Apps/CLI -Xswiftc -DPEEKABOO_SKIP_AUTOMATION --no-parallel",
26
27
  "test:automation": "PEEKABOO_INCLUDE_AUTOMATION_TESTS=true ./runner swift test --package-path Apps/CLI --no-parallel",
27
28
  "test:automation:read": "RUN_AUTOMATION_READ=true PEEKABOO_INCLUDE_AUTOMATION_TESTS=true ./runner swift test --package-path Apps/CLI --no-parallel",
28
- "test:automation:local": "./runner bash -lc 'cd Apps/CLI && BIN_PATH=$(swift build --show-bin-path) && RUN_LOCAL_TESTS=true PEEKABOO_INCLUDE_AUTOMATION_TESTS=true PEEKABOO_CLI_PATH=\"$BIN_PATH/peekaboo\" swift test --no-parallel'",
29
+ "test:automation:local": "./runner bash -lc 'BIN_PATH=$(swift build --package-path Apps/CLI --show-bin-path) && RUN_LOCAL_TESTS=true PEEKABOO_INCLUDE_AUTOMATION_TESTS=true PEEKABOO_CLI_PATH=\"$BIN_PATH/peekaboo\" swift test --package-path Apps/CLI --no-parallel'",
29
30
  "test:all": "./runner bash -lc 'set -euo pipefail; cd Apps/CLI && swift test -Xswiftc -DPEEKABOO_SKIP_AUTOMATION --no-parallel && PEEKABOO_INCLUDE_AUTOMATION_TESTS=true swift test --no-parallel'",
30
31
  "test": "pnpm run test:safe",
31
32
  "tachikoma:test:integration": "./runner bash -lc 'cd Tachikoma && source ~/.profile && INTEGRATION_TESTS=1 swift test --parallel -Xswiftc -DLIVE_PROVIDER_TESTS'",
@@ -33,7 +34,7 @@
33
34
  "lint": "pnpm run lint:swift",
34
35
  "format:swift": "./runner swiftformat .",
35
36
  "format": "pnpm run format:swift",
36
- "prepare-release": "./runner node scripts/prepare-release.js",
37
+ "prepare-release": "node scripts/prepare-release.js",
37
38
  "docs:list": "./runner node scripts/docs-list.mjs",
38
39
  "lint:docs": "./runner node scripts/docs-lint.mjs",
39
40
  "polter": "FORCE_COLOR=1 CLICOLOR_FORCE=1 NODE_PATH=../poltergeist/node_modules script -q /dev/null ./runner node ../poltergeist/dist/polter.js",
@@ -70,10 +71,13 @@
70
71
  "engines": {
71
72
  "node": ">=22.0.0"
72
73
  },
73
- "os": ["darwin"],
74
- "cpu": ["x64", "arm64"],
75
- "dependencies": {},
74
+ "os": [
75
+ "darwin"
76
+ ],
77
+ "cpu": [
78
+ "arm64"
79
+ ],
76
80
  "devDependencies": {
77
- "chrome-devtools-mcp": "0.10.1"
81
+ "chrome-devtools-mcp": "0.12.1"
78
82
  }
79
83
  }
package/peekaboo CHANGED
Binary file