Clarify one-shot deployment runbook

This commit is contained in:
hwhung
2026-04-27 12:29:45 +08:00
parent 554ab93df2
commit 9a19c87251
+23 -28
View File
@@ -1,29 +1,28 @@
# Agent Runbook # Agent Runbook
Run this repository as a standalone app. Do not add it to a parent workspace. Do not move it into `artifacts/`. Do not edit source files for setup. This app is already prepared for one-shot deployment. Follow these commands exactly unless one fails.
## Setup Do not add this repo to a parent workspace. Do not move it into `artifacts/`. Do not edit source files. Do not edit `package.json`. Do not create `config.json` or a `/tmp` config file for deployment. Do not inspect or free unrelated ports.
## Install
Run from this repository root: Run from this repository root:
```bash ```bash
pnpm install --ignore-workspace pnpm install --ignore-workspace
```
Use the available `pnpm`. This repo intentionally has no `packageManager` pin.
## Start
Without provider endpoints:
```bash
pnpm dev pnpm dev
``` ```
If plain `pnpm` is unavailable, use `corepack pnpm` for the same commands. Do not edit `package.json`. With internal provider endpoints:
Default startup uses:
- host: `0.0.0.0`
- port: `24731`
- bearer token: `dev-proxy-key`
## Provider Wiring
Prefer CLI flags. Do not create `config.json` for deployment.
If internal provider endpoints/tokens are available, start with:
```bash ```bash
pnpm dev -- \ pnpm dev -- \
@@ -36,23 +35,17 @@ pnpm dev -- \
--anthropic-api-key "<internal-anthropic-api-key>" --anthropic-api-key "<internal-anthropic-api-key>"
``` ```
The provider flags above are implemented. Do not verify them by reading source first.
Use internal endpoints only. Never use public official provider endpoints. Do not print provider tokens. Use internal endpoints only. Never use public official provider endpoints. Do not print provider tokens.
Supported setup flags: If the process does not stay alive after the shell exits, create the smallest background workflow that runs the same `pnpm dev ...` command from this repository root.
- `--host` ## Defaults
- `--port`
- `--proxy-api-key`
- `--openai-base-url`
- `--openai-api-key`
- `--anthropic-base-url`
- `--anthropic-api-key`
- `--log-level`
- `--pretty-logs`
- `--no-pretty-logs`
- `--config`
CLI flags override `config.json`. `config.json` is only for local/manual use. - host: `0.0.0.0`
- port: `24731`
- bearer token: `dev-proxy-key`
## Verify ## Verify
@@ -63,3 +56,5 @@ curl -s -H "Authorization: Bearer dev-proxy-key" http://localhost:24731/v1/model
``` ```
Expected without provider flags: dashboard, health, and model list work; chat completions return `503`. Expected without provider flags: dashboard, health, and model list work; chat completions return `503`.
Report only the local URL and verification results.