Unified · Split
| @@ -8,7 +8,6 @@ It gives an agent a TypeScript runtime, a discoverable tool catalog, and a singl · 7 unmodified lines | |||
| 8 | 8 | ||
| 9 | Join the Discord community: https://discord.gg/eF29HBHwM6 | 9 | Join the Discord community: https://discord.gg/eF29HBHwM6 |
| 10 | 10 | ||
| 11 | |||
| 12 | At runtime, `executor` behaves like one local product: | 11 | At runtime, `executor` behaves like one local product: |
| 13 | 12 | ||
| 14 | - a CLI for starting the runtime and executing code | 13 | - a CLI for starting the runtime and executing code |
| @@ -23,7 +22,6 @@ The current codebase lives in `apps/` and `packages/`. Older experiments stay in · 8 unmodified lines | |||
| 23 | - The npm package name `executor` is used with attribution to [Crystian](https://www.linkedin.com/in/crystian/). | 22 | - The npm package name `executor` is used with attribution to [Crystian](https://www.linkedin.com/in/crystian/). |
| 24 | - The `codemode` concept in this project is inspired by Cloudflare's [Code Mode announcement](https://blog.cloudflare.com/code-mode/). | 23 | - The `codemode` concept in this project is inspired by Cloudflare's [Code Mode announcement](https://blog.cloudflare.com/code-mode/). |
| 25 | 24 | ||
| 26 | |||
| 27 | ## Why this exists | 25 | ## Why this exists |
| 28 | 26 | ||
| 29 | `executor` is built around a simple idea: agents should work against a structured tool environment instead of guessing at raw HTTP calls, carrying huge MCP definitions in context, or running arbitrary local commands with broad permissions. | 27 | `executor` is built around a simple idea: agents should work against a structured tool environment instead of guessing at raw HTTP calls, carrying huge MCP definitions in context, or running arbitrary local commands with broad permissions. |
| @@ -116,12 +114,22 @@ For each source you can: · 86 unmodified lines | |||
| 116 | 114 | ||
| 117 | ## Quick start | 115 | ## Quick start |
| 118 | 116 | ||
| 119 | 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: | ||
| 120 | 129 | ||
| 121 | ```bash | 130 | ```bash |
| 122 | bun install | 131 | bun install |
| 123 | bun run executor doctor --json | 132 | bun dev |
| 124 | bun run executor up | ||
| 125 | ``` | 133 | ``` |
| 126 | 134 | ||
| 127 | That starts the local runtime. The default base URL is: | 135 | That starts the local runtime. The default base URL is: |
| @@ -205,7 +213,8 @@ return await tools.executor.sources.add({ · 77 unmodified lines | |||
| 205 | return await tools.executor.sources.add({ | 213 | return await tools.executor.sources.add({ |
| 206 | kind: "openapi", | 214 | kind: "openapi", |
| 207 | endpoint: "https://api.github.com", | 215 | endpoint: "https://api.github.com", |
| 208 | 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", | ||
| 209 | name: "GitHub", | 218 | name: "GitHub", |
| 210 | namespace: "github", | 219 | namespace: "github", |
| 211 | }); | 220 | }); |