@netlify/agent-runner-cli 1.108.0 → 1.110.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/README.md +5 -66
- package/dist/bin-local.js +68 -67
- package/dist/bin.js +69 -68
- package/dist/index.js +66 -65
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,69 +1,8 @@
|
|
|
1
|
-
# Agent Runner
|
|
1
|
+
# Netlify Agent Runner CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Everyone is a developer. `@netlify/agent-runner-cli` powers Netlify users to turn their prompts into their dream project.
|
|
4
|
+
[Learn more about Agent Runners on Netlify](https://docs.netlify.com/build/build-with-ai/agent-runners/overview/).
|
|
4
5
|
|
|
5
|
-
##
|
|
6
|
+
## Contributing
|
|
6
7
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
1. **Init** -- Sets up the runner, AI gateway, git state, and installs agent skills into `~/.claude/skills/`.
|
|
10
|
-
2. **Create** (optional, `mode=create` only) -- Picks a starter template via an AI call, scaffolds it with `ts-cli`, and generates a file tree for context. The user's original prompt is passed through untouched.
|
|
11
|
-
3. **Inference** -- Composes a full prompt (user request + project rules + skills + metadata) and hands it to Claude Code (or Gemini/Codex). The agent reads, writes, and edits files to fulfill the request.
|
|
12
|
-
4. **Deploy** -- Builds and deploys the site with the Netlify CLI. Retries on failure.
|
|
13
|
-
5. **Cleanup** -- Reports results, sends usage data, resets the repo.
|
|
14
|
-
|
|
15
|
-
Runners live in `src/runners/` (claude, gemini, codex). Stages live in `src/stages/`. Prompt composition is in `src/context.js` and `src/prompt.js`.
|
|
16
|
-
|
|
17
|
-
## Local testing
|
|
18
|
-
|
|
19
|
-
### Prerequisites
|
|
20
|
-
|
|
21
|
-
- Node 22+
|
|
22
|
-
- Latest Netlify CLI (`npm install -g netlify-cli`)
|
|
23
|
-
- A Netlify PAT token (create one in your Netlify user settings)
|
|
24
|
-
- A test site directory linked to Netlify (`netlify link`)
|
|
25
|
-
|
|
26
|
-
### Setup
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
npm install
|
|
30
|
-
npm run build # one-time build
|
|
31
|
-
# or
|
|
32
|
-
npm run dev # watch mode
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
### Run locally
|
|
36
|
-
|
|
37
|
-
From the orchestrator directory:
|
|
38
|
-
|
|
39
|
-
```bash
|
|
40
|
-
./dist/bin-local.js \
|
|
41
|
-
--cwd /path/to/your/test/site \
|
|
42
|
-
--prompt "Your task here" \
|
|
43
|
-
--netlify-api-token "nfp_..." \
|
|
44
|
-
--verbose
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
Use `--help` to see all options (`--mode`, `--model`, `--runner`, `--staging`, etc).
|
|
48
|
-
|
|
49
|
-
### Run tests
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
npm run test # tests + linters
|
|
53
|
-
npm run test:dev:vitest # unit tests only
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
### Run integration tests
|
|
57
|
-
|
|
58
|
-
Integration tests hit real AI APIs and require `SITE_ID` and `NETLIFY_API_TOKEN` env vars:
|
|
59
|
-
|
|
60
|
-
```bash
|
|
61
|
-
export SITE_ID="your-test-site-id"
|
|
62
|
-
export NETLIFY_API_TOKEN="nfp_..."
|
|
63
|
-
|
|
64
|
-
npm run test:integration # all
|
|
65
|
-
npm run test:integration:create-stage # create stage only
|
|
66
|
-
npm run test:integration:claude # claude runner only
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
See [CONTRIBUTING.md](CONTRIBUTING.md) for release process and other guidelines.
|
|
8
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for dev setup, testing, and release process.
|