History

fix quickstart instructions

Rhys Sullivan committed 8 months ago

Commit 94e4e131 parent 939e5a11 file · +15 −6Browse files

Unified · Split

README.md+15−6
@@ -8,7 +8,6 @@ It gives an agent a TypeScript runtime, a discoverable tool catalog, and a singl · 7 unmodified lines
88
99 Join the Discord community: https://discord.gg/eF29HBHwM6
1010
11−
1211 At runtime, `executor` behaves like one local product:
1312
1413 - 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
2322 - The npm package name `executor` is used with attribution to [Crystian](https://www.linkedin.com/in/crystian/).
2423 - The `codemode` concept in this project is inspired by Cloudflare's [Code Mode announcement](https://blog.cloudflare.com/code-mode/).
2524
26−
2725 ## Why this exists
2826
2927 `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
116114
117115 ## Quick start
118116
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:
120129
121130 ```bash
122131 bun install
123−bun run executor doctor --json
124−bun run executor up
132+bun dev
125133 ```
126134
127135 That starts the local runtime. The default base URL is:
@@ -205,7 +213,8 @@ return await tools.executor.sources.add({ · 77 unmodified lines
205213 return await tools.executor.sources.add({
206214 kind: "openapi",
207215 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",
209218 name: "GitHub",
210219 namespace: "github",
211220 });