diff --git a/packages/framework/README.md b/packages/framework/README.md index 2274912..1c65a28 100644 --- a/packages/framework/README.md +++ b/packages/framework/README.md @@ -71,16 +71,32 @@ await runFramework({ ``` framework [intent...] Build what you describe, from scratch. framework --fake Offline demo (no CLI, no model, deterministic). +framework doctor Check prerequisites (Claude Code installed, etc.). --cwd Workspace the agent builds in (default: cwd). --model Model to pass through to the wrapped agent. --scope How much app to build (default: full). + --max-passes Loop pass budget for a full build (default: 5). --compose-extensions Opt the built-in capability extensions in (Vike-only; see below). - --deploy Narrate a deploy decision (e.g. cloudflare, dokploy). + --permission-mode Claude Code permission mode: default | acceptEdits | + bypassPermissions | plan (default: bypassPermissions, so the + headless loop can run installs / builds / tests). + --dangerously-skip-permissions Bypass all agent permission checks (sandboxes only). + --serve Gate the loop on the app actually running (e.g. "npm run dev"), + then keep it serving with a preview link on the dashboard. + --serve-install Install command before serving (e.g. "npm install"). + --serve-build Build command before serving (e.g. "npm run build"). + --serve-port Port the app listens on (default: 3000). + --serve-path Path to health-check once it is up (default: /). + --deploy Deploy to this target (cloudflare, dokploy) or narrate any other. + --cf-project Cloudflare Pages project name (for a Pages deploy). + --dokploy-url Dokploy instance URL (required for --deploy dokploy). + --dokploy-app Dokploy application id (required for --deploy dokploy). --port Dashboard port (default: 4477). --no-dashboard Run headless. --resume Reopen the last run's dashboard from .framework/ (see below). --no-persist Do not write the orchestration state to .framework/. + --skip-preflight Skip the prerequisite checks before a live run. --session-link Link to the live agent session (shown on the dashboard). ```