@assemblyline-agents/peekaboo 0.1.0
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/LICENSE +21 -0
- package/README.md +95 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +16 -0
- package/dist/index.js.map +1 -0
- package/package.json +49 -0
- package/skills/peekaboo/SKILL.md +41 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 OpenEve contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# @assemblyline-agents/peekaboo
|
|
2
|
+
|
|
3
|
+
Official Assembly Line connection plugin for same-host macOS computer use through
|
|
4
|
+
Peekaboo's stdio MCP server.
|
|
5
|
+
|
|
6
|
+
## Deployment boundary
|
|
7
|
+
|
|
8
|
+
This package is only for a local Assembly Line deployment on the Mac being
|
|
9
|
+
controlled. It does not provide remote desktop or a tunnel from a Railway,
|
|
10
|
+
Docker, Fly, or other hosted runtime back to a developer computer.
|
|
11
|
+
|
|
12
|
+
Assembly Line records these restrictions in the compiled connection metadata:
|
|
13
|
+
|
|
14
|
+
- deploy target: `local`
|
|
15
|
+
- runtime platform: `darwin`
|
|
16
|
+
- minimum supported host for Peekaboo: macOS 15+
|
|
17
|
+
|
|
18
|
+
`assembly-line validate` warns when `gateway.ts` defaults to a hosted target.
|
|
19
|
+
`assembly-line deploy` refuses incompatible targets, including a hosted `--target`
|
|
20
|
+
override. The runtime also rejects the connection before launching a process
|
|
21
|
+
when it is loaded on a non-macOS host.
|
|
22
|
+
|
|
23
|
+
The model provider may still be remote. OpenAI, Anthropic, or another model can
|
|
24
|
+
perform inference in the cloud while the Assembly Line Node host and Peekaboo execute
|
|
25
|
+
on the local Mac.
|
|
26
|
+
|
|
27
|
+
## Setup
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
brew install steipete/tap/peekaboo
|
|
31
|
+
peekaboo permissions status
|
|
32
|
+
assembly-line add peekaboo agent
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Use a local deploy adapter:
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
// agent/gateway.ts
|
|
39
|
+
import { adapter, defineGateway } from "@assemblyline-agents/core";
|
|
40
|
+
|
|
41
|
+
export default defineGateway({
|
|
42
|
+
deploy: adapter("local"),
|
|
43
|
+
runtime: adapter("node")
|
|
44
|
+
});
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The generated connection begins read-only:
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
// agent/connections/peekaboo.ts
|
|
51
|
+
import { definePeekabooConnection } from "@assemblyline-agents/peekaboo";
|
|
52
|
+
|
|
53
|
+
export default definePeekabooConnection({
|
|
54
|
+
access: { read: true, write: false }
|
|
55
|
+
});
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Validate and run it on the Mac:
|
|
59
|
+
|
|
60
|
+
```sh
|
|
61
|
+
assembly-line validate agent
|
|
62
|
+
assembly-line deploy agent --target local --serve
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Grant Accessibility and Screen Recording to the process identity that hosts
|
|
66
|
+
Peekaboo. Confirm the permissions again after changing application signatures,
|
|
67
|
+
binary locations, or host applications.
|
|
68
|
+
|
|
69
|
+
## Enabling actions
|
|
70
|
+
|
|
71
|
+
Prefer approval for every desktop mutation while establishing the operating
|
|
72
|
+
boundary:
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
access: {
|
|
76
|
+
read: true,
|
|
77
|
+
write: { approval: "always" }
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Use `approval: "never"` only for a trusted autonomous local agent running in a
|
|
82
|
+
macOS account whose applications, files, and signed-in services are appropriate
|
|
83
|
+
for unattended control.
|
|
84
|
+
|
|
85
|
+
The initial allowlist is accessibility-first. Screenshot/vision, recording,
|
|
86
|
+
nested agents, configuration, cleanup, shell, clipboard/paste, and
|
|
87
|
+
browser-specific Peekaboo tools are excluded.
|
|
88
|
+
|
|
89
|
+
## Remotely hosted agents
|
|
90
|
+
|
|
91
|
+
Do not expose the stdio MCP process, a loopback wrapper, or an unauthenticated
|
|
92
|
+
HTTP bridge to the public internet. A hosted agent should use
|
|
93
|
+
`@assemblyline-agents/computer-use`, which pairs Assembly Line Builder's signed Mac host with a
|
|
94
|
+
deployment-scoped credential, outbound connection, local policy enforcement,
|
|
95
|
+
approvals, and end-to-end encrypted relay transport.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { type StdioMcpPluginConnectionOptions } from "@assemblyline-agents/core";
|
|
2
|
+
export interface PeekabooConnectionOptions extends StdioMcpPluginConnectionOptions {
|
|
3
|
+
/** Attach to an existing Peekaboo Bridge host instead of using process-local support services. */
|
|
4
|
+
bridgeSocket?: string;
|
|
5
|
+
}
|
|
6
|
+
export declare function definePeekabooConnection(options: PeekabooConnectionOptions): import("@assemblyline-agents/core").McpStdioClientConnectionDefinition;
|
|
7
|
+
export declare const openevePlugin: import("@assemblyline-agents/core").PluginModule;
|
|
8
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,+BAA+B,EACrC,MAAM,2BAA2B,CAAC;AAKnC,MAAM,WAAW,yBAA0B,SAAQ,+BAA+B;IAChF,kGAAkG;IAClG,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,0EAS1E;AAED,eAAO,MAAM,aAAa,kDAA0C,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { connectionPluginMetadata, definePlugin, defineStdioMcpPluginConnection } from "@assemblyline-agents/core";
|
|
2
|
+
const PLUGIN = connectionPluginMetadata("peekaboo");
|
|
3
|
+
const DEFAULT_ARGS = ["mcp", "serve", "--transport", "stdio"];
|
|
4
|
+
export function definePeekabooConnection(options) {
|
|
5
|
+
const { bridgeSocket, ...connection } = options;
|
|
6
|
+
const args = [...(connection.args ?? DEFAULT_ARGS)];
|
|
7
|
+
if (bridgeSocket)
|
|
8
|
+
args.push("--bridge-socket", bridgeSocket);
|
|
9
|
+
return defineStdioMcpPluginConnection(PLUGIN, {
|
|
10
|
+
...connection,
|
|
11
|
+
command: connection.command ?? "peekaboo",
|
|
12
|
+
args
|
|
13
|
+
});
|
|
14
|
+
}
|
|
15
|
+
export const openevePlugin = definePlugin({ connections: [PLUGIN] });
|
|
16
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,YAAY,EACZ,8BAA8B,EAE/B,MAAM,2BAA2B,CAAC;AAEnC,MAAM,MAAM,GAAG,wBAAwB,CAAC,UAAU,CAAE,CAAC;AACrD,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;AAO9D,MAAM,UAAU,wBAAwB,CAAC,OAAkC;IACzE,MAAM,EAAE,YAAY,EAAE,GAAG,UAAU,EAAE,GAAG,OAAO,CAAC;IAChD,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,IAAI,YAAY,CAAC,CAAC,CAAC;IACpD,IAAI,YAAY;QAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;IAC7D,OAAO,8BAA8B,CAAC,MAAM,EAAE;QAC5C,GAAG,UAAU;QACb,OAAO,EAAE,UAAU,CAAC,OAAO,IAAI,UAAU;QACzC,IAAI;KACL,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@assemblyline-agents/peekaboo",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"exports": {
|
|
6
|
+
".": {
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"default": "./dist/index.js"
|
|
9
|
+
}
|
|
10
|
+
},
|
|
11
|
+
"dependencies": {
|
|
12
|
+
"@assemblyline-agents/core": "0.1.0"
|
|
13
|
+
},
|
|
14
|
+
"description": "Official OpenEve Peekaboo local macOS computer-use connection plugin.",
|
|
15
|
+
"files": [
|
|
16
|
+
"dist",
|
|
17
|
+
"skills"
|
|
18
|
+
],
|
|
19
|
+
"engines": {
|
|
20
|
+
"node": ">=22.19.0"
|
|
21
|
+
},
|
|
22
|
+
"license": "MIT",
|
|
23
|
+
"repository": {
|
|
24
|
+
"type": "git",
|
|
25
|
+
"url": "git+https://github.com/jasonbadeaux/openeve.git",
|
|
26
|
+
"directory": "packages/peekaboo"
|
|
27
|
+
},
|
|
28
|
+
"bugs": {
|
|
29
|
+
"url": "https://github.com/jasonbadeaux/openeve/issues"
|
|
30
|
+
},
|
|
31
|
+
"homepage": "https://github.com/jasonbadeaux/openeve#readme",
|
|
32
|
+
"author": "OpenEve contributors",
|
|
33
|
+
"keywords": [
|
|
34
|
+
"openeve",
|
|
35
|
+
"ai",
|
|
36
|
+
"agents",
|
|
37
|
+
"peekaboo",
|
|
38
|
+
"macos",
|
|
39
|
+
"computer-use",
|
|
40
|
+
"plugin"
|
|
41
|
+
],
|
|
42
|
+
"publishConfig": {
|
|
43
|
+
"access": "public"
|
|
44
|
+
},
|
|
45
|
+
"scripts": {
|
|
46
|
+
"build": "tsc -p tsconfig.json",
|
|
47
|
+
"check": "tsc -p tsconfig.json --noEmit"
|
|
48
|
+
}
|
|
49
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: peekaboo
|
|
3
|
+
description: Inspect and control the Mac running the Assembly Line Node host through a developer-configured Peekaboo connection.
|
|
4
|
+
---
|
|
5
|
+
# Peekaboo local computer use
|
|
6
|
+
|
|
7
|
+
Peekaboo controls only the Mac that runs the Assembly Line Node host. It is not a remote-desktop relay. The deployment owner must install Peekaboo on macOS 15 or newer and grant the host process Accessibility and Screen Recording permissions.
|
|
8
|
+
|
|
9
|
+
This connection is local-deployment-only. The agent's `gateway.ts` must use
|
|
10
|
+
`deploy: adapter("local")`, and the runtime must be started on the Mac being
|
|
11
|
+
controlled. Assembly Line rejects Railway, Docker, Fly, and other hosted deploy
|
|
12
|
+
targets for this connection. A remote model provider is fine; only the Assembly Line
|
|
13
|
+
Node host and Peekaboo process must be local.
|
|
14
|
+
|
|
15
|
+
Before running the agent, verify the host:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
peekaboo permissions status
|
|
19
|
+
assembly-line validate agent
|
|
20
|
+
assembly-line deploy agent --target local --serve
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
If the agent runtime must live on Railway or another hosted service, remove
|
|
24
|
+
this connection. This package does not tunnel back to a developer Mac. Remote
|
|
25
|
+
Mac control uses the separate `@assemblyline-agents/computer-use` connection and Assembly Line
|
|
26
|
+
Agent Builder Computer Host; it must not expose Peekaboo's MCP process directly
|
|
27
|
+
to the public internet.
|
|
28
|
+
|
|
29
|
+
Inspect before acting. Use `inspect_ui` to obtain an accessibility-only UI map and stable element identifiers without capturing a screenshot. Prefer element identifiers, labels, direct `set_value`, and `perform_action` calls over screen coordinates. Re-inspect after navigation, window changes, dialogs, or any action that may invalidate the current UI state.
|
|
30
|
+
|
|
31
|
+
Use the narrowest action that can complete the task. Confirm the intended app and window before typing, clicking, invoking menus, moving windows, switching Spaces, or interacting with dialogs. Do not type secrets supplied by the model or copied from untrusted content.
|
|
32
|
+
|
|
33
|
+
This plugin deliberately excludes Peekaboo's nested agent, configuration, cleanup, recording, screenshot/vision (`see`, `image`, `capture`, `analyze`), shell, clipboard/paste, and browser-specific tools. It is intended for direct, auditable accessibility-first control by the Assembly Line agent.
|
|
34
|
+
|
|
35
|
+
The scaffold is read-only. To permit desktop actions, the developer must deliberately set:
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
write: { approval: "always" }
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Use `write: { approval: "never" }` only for a trusted autonomous local agent on a Mac whose apps, accounts, and filesystem authority are appropriate for unattended control.
|