executor 1.1.7 → 1.1.9

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 CHANGED
@@ -4,6 +4,10 @@
4
4
 
5
5
  It gives an agent a TypeScript runtime, a discoverable tool catalog, and a single local place to connect external systems such as MCP servers, OpenAPI APIs, and GraphQL APIs. Instead of pasting large MCP manifests into every chat or giving an agent broad shell access, you run code inside `executor` and let it call typed `tools.*` functions.
6
6
 
7
+ ## Community
8
+
9
+ Join the Discord community: https://discord.gg/eF29HBHwM6
10
+
7
11
  At runtime, `executor` behaves like one local product:
8
12
 
9
13
  - a CLI for starting the runtime and executing code
@@ -11,7 +15,12 @@ At runtime, `executor` behaves like one local product:
11
15
  - a local web UI for connecting sources, inspecting tools, and managing secrets
12
16
  - an MCP endpoint for hosts that want to drive `executor` through MCP
13
17
 
14
- The current codebase is the v3 rewrite. Older experiments live in `legacy/` and `legacy2/`, but the active architecture is the one in `apps/` and `packages/`.
18
+ The current codebase lives in `apps/` and `packages/`. Older experiments stay in `legacy/` and `legacy2/`.
19
+
20
+ ## Attribution
21
+
22
+ - [Crystian](https://www.linkedin.com/in/crystian/) provided the npm package name `executor`.
23
+ - The `codemode` concept in this project is inspired by Cloudflare's [Code Mode announcement](https://blog.cloudflare.com/code-mode/).
15
24
 
16
25
  ## Why this exists
17
26
 
@@ -105,12 +114,22 @@ For each source you can:
105
114
 
106
115
  ## Quick start
107
116
 
108
- If you are working from this repository, the easiest path is:
117
+ If you want to use this a package distribution, install it via npm:
118
+
119
+ ```bash
120
+ npm install -g executor
121
+ executor up
122
+ ```
123
+
124
+ Then either tell your agent to use the CLI or to open the web UI and copy the MCP CLI install command.
125
+
126
+ Then you can run the CLI as `executor`.
127
+
128
+ If you are working from this repository locally, the easiest path is:
109
129
 
110
130
  ```bash
111
131
  bun install
112
- bun run executor doctor --json
113
- bun run executor up
132
+ bun dev
114
133
  ```
115
134
 
116
135
  That starts the local runtime. The default base URL is:
@@ -194,7 +213,8 @@ return await tools.executor.sources.add({
194
213
  return await tools.executor.sources.add({
195
214
  kind: "openapi",
196
215
  endpoint: "https://api.github.com",
197
- specUrl: "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json",
216
+ specUrl:
217
+ "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json",
198
218
  name: "GitHub",
199
219
  namespace: "github",
200
220
  });
@@ -208,7 +228,7 @@ At a high level, every execution follows the same loop:
208
228
 
209
229
  1. `executor` resolves the current local installation and workspace.
210
230
  2. It builds a tool catalog from built-in tools plus all connected workspace sources.
211
- 3. It runs your TypeScript inside the in-process execution runtime.
231
+ 3. It runs your TypeScript inside the SES sandbox runtime.
212
232
  4. Tool calls are dispatched through `executor` rather than directly from your code.
213
233
  5. If a tool needs interaction, the run pauses and records a pending interaction.
214
234
  6. Once the interaction is resolved, the execution continues and eventually completes or fails.
@@ -299,7 +319,7 @@ If you are exploring the repo, these are the directories that matter most:
299
319
  - `apps/web`: local React web UI
300
320
  - `packages/server`: local HTTP server that serves API, MCP, and UI
301
321
  - `packages/control-plane`: source management, secrets, persistence, execution, and inspection
302
- - `packages/runtime-local-inproc`: in-process TypeScript execution runtime
322
+ - `packages/runtime-ses`: SES sandbox runtime for TypeScript execution
303
323
  - `packages/executor-mcp`: MCP bridge for `execute` and `resume`
304
324
  - `packages/codemode-*`: core tool abstractions plus MCP and OpenAPI adapters
305
325