grok-studio 0.1.1 → 0.1.2

package/README.md

@@ -1,117 +1,50 @@
 # Grok Studio
 
-Self-hosted Grok generation workspace for local/LAN use. The app keeps xAI credentials on the server, lets the browser upload or paste an image, optionally prepares a video-ready first frame, then generates and stores video outputs on disk.
+Self-hosted Grok image-to-video studio. Your xAI credentials stay on the server; turn an image into video from a web UI or the CLI, with outputs stored on disk. Built for local / LAN use.
 
-## Product Model
-
-The UI is organized around generated outputs, active work, and source-scoped lineage.
-
-- **Left rail**: `+` creates a new source image. Active Jobs appears above the output gallery when queued or running work exists; it is global and not tied to the currently selected source. Outputs are typed as `Frame` or `Video`; status text is only for exceptional or in-progress states.
-- **Result Graph**: the center canvas shows lineage for the current source. Nodes are concrete artifacts/runs:
-  - `Source` is the root image.
-  - each Prep run creates a separate `Frame` node.
-  - each Video run creates a separate `Video` node.
-- **Inspector**: the right panel is the only place for details and actions. Select a node to inspect it, download video output, rerun, prepare another frame, or animate the selected frame.
-
-Lineage is data-driven:
-
-- Source-linked video jobs attach only when `inputFrame.source === "source"` and the job's `clientSourceId` matches the current source.
-- Frame-linked video jobs attach only when `inputFrame.source === "prep"` and `preparedImageId` matches a frame in the current graph.
-- UI cache must not decide graph edges. If lineage fields are missing, do not guess by recent history.
-
-## Run
+## Install & run
 
 ```bash
-vp install
-cp .env.example .env
-vpr build
-vpr start
+npx grok-studio
 ```
 
-For normal local use:
-
-```bash
-vpr launch
-```
-
-`launch` builds the app, checks xAI auth, opens the browser login flow when no token exists, then starts the web app. Open <http://127.0.0.1:8787>.
-
-## LAN Access
-
-For local-network access, set:
-
-```dotenv
-HOST=0.0.0.0
-ACCESS_TOKEN=
-```
-
-Then restart the service and open `http://<mac-lan-ip>:8787` or `http://<mac-local-hostname>.local:8787` from another device on the same LAN.
-
-`ACCESS_TOKEN` can be left empty for trusted local/LAN use. Set it before exposing the app outside a trusted network.
+That's it. First run opens the xAI browser login if needed, then serves on <http://127.0.0.1:8787>. (`npm i -g grok-studio` also works.)
 
-## Configuration
-
-- `HOST` / `PORT` control where the server binds.
-- `ACCESS_TOKEN` optionally protects browser/API access outside loopback.
-- `WORKSPACE_DIR` stores `images/`, `videos/`, `jobs/`, and `prepared-images/`.
-- `XAI_AUTH_MODE=oauth` reads `XAI_OAUTH_TOKEN_FILE`, refreshes it when needed, and `vpr launch` can bootstrap it interactively.
-- `XAI_AUTH_MODE=api_key` uses `XAI_API_KEY`.
-- `XAI_VIDEO_MODEL` controls image-to-video generation.
-- `XAI_IMAGE_MODEL` controls first-frame image editing.
-- `DEFAULT_DURATION_SECONDS` supports up to 15 seconds.
-- `MAX_VARIATIONS` limits sequential variations per video job.
-
-The app binds to `127.0.0.1` by default. Use `HOST=0.0.0.0` only for LAN/tunnel exposure.
-
-## Grok Login Test
-
-To test the xAI/Grok browser login without touching the token file used by the running service:
-
-```bash
-vpr login
-```
-
-The command opens the xAI authorization page, waits for the local callback, saves the token state to a test path, and verifies it with the API. If xAI shows a fallback code instead of redirecting, paste that code into the terminal prompt.
-
-Useful variants:
+## CLI
 
 ```bash
-vpr login --check
-vpr login --print-url-only
-vpr login --live --force
+grok-studio serve [--open]   # start the web app (default command)
+grok-studio gen --image a.png --prompt "slow head turn" \
+  [--prep --duration 6 --resolution 720p --aspect 9:16 --count 2 --out clip.mp4]
+grok-studio login            # xAI OAuth login (browser)
+grok-studio status           # config + xAI auth + server health
 ```
 
-`vpr login` is Vite+'s shorthand for `vp run login`. Vite+ built-in top-level commands such as `vp build` and `vp test` cannot be extended by this project, so custom project commands use `vp run <task>` / `vpr <task>`.
+`gen` is headless: image →(optional `--prep` first frame)→ video, no UI; result paths print to stdout.
 
-By default, login writes to `~/.grok-video-web/login-test/xai-oauth.json` so repeated login-flow tests do not disturb the live service token. Use `--live --force` only when intentionally repairing `XAI_OAUTH_TOKEN_FILE`. `--print-url-only` is only for smoke-checking that the OAuth authorization URL can be built; it exits immediately, so do not use that URL to complete a real login.
+## Web UI
 
-## Quality Loop
+- **Left rail** — `+` adds a source image; **Active Jobs** lists running work globally; **Outputs** is a gallery of every `Frame` / `Video`.
+- **Result Graph** (center) — every node is one concrete run: `Source` → `Frame` (each prep) → `Video` (each run). Forks are sibling nodes. Lineage is derived purely from data (`inputFrame.preparedImageId` / `clientSourceId`), never guessed from history.
+- **Inspector** (right) — the only place to view a result, download, rerun, prep, or animate the selected node.
 
-Vite+ (`vp`/`vpr`) owns build, lint/format/type checks, and tests:
+## Configure (`.env`)
 
-```bash
-vpr fmt
-vpr fmt:check
-vpr lint
-vpr lint:fix
-vpr check
-vp test
-vpr build
-vpr smoke
+```dotenv
+HOST=127.0.0.1                 # 0.0.0.0 for LAN access
+PORT=8787
+ACCESS_TOKEN=                  # set to gate non-loopback access (empty = open on loopback/LAN)
+WORKSPACE_DIR=./workspace      # holds images/ videos/ jobs/ prepared-images/
+XAI_AUTH_MODE=oauth            # or: api_key (+ XAI_API_KEY)
+XAI_VIDEO_MODEL=grok-imagine-video
+XAI_IMAGE_MODEL=grok-imagine-image-quality
 ```
 
-Quality gates include:
-
-- React-specific lint rules for hooks, effect dependencies, JSX keys, nested components, unsafe JSX, and button types.
-- Type-aware linting and TypeScript checks.
-- Architecture guardrails in `tests/architecture.test.ts` to keep the main app shell thin, limit local React state in `App.tsx`, split stylesheet ownership, and keep server route files focused.
-- Browser smoke coverage in `scripts/smoke.mjs`, including paste input, image lightbox, video-card scroll behavior, and legacy history not restoring unrelated Prep outputs.
-
-## Local Service
-
-If installed as the local launchd service, restart it after building:
+## Develop
 
 ```bash
-launchctl kickstart -k gui/$(id -u)/com.pengx17.grok-video-web
-curl -fsS http://127.0.0.1:8787/health
+vp install
+vpr check && vp test && vpr build && vpr smoke
 ```
+
+Quality gates: React/a11y lint, type checks, an architecture-size test (`tests/architecture.test.ts`), and a Playwright smoke (`scripts/smoke.mjs`).

package/dist/server/cli.js

@@ -1683,14 +1683,15 @@ function cleanOptionalString(value) {
 //#endregion
 //#region src/server/serve.ts
 async function startServer(options = {}) {
+	clack.intro("Grok Studio");
 	const config = loadConfig();
 	await ensureAuthReady(config);
 	const { app } = createServer(config);
 	app.listen(config.port, config.host, () => {
-		const url = `http://${config.host}:${config.port}`;
-		console.log(`Grok Studio is running: ${url}`);
-		if (config.accessToken) console.log("ACCESS_TOKEN is configured; enter the value from .env in the browser gate.");
-		else console.log("ACCESS_TOKEN is not set; API access is open to whoever can reach this host.");
+		const url = `http://${config.host === "0.0.0.0" || config.host === "::" ? "127.0.0.1" : config.host}:${config.port}`;
+		const access = config.accessToken ? "Access: token required (set in .env)" : "Access: open — no ACCESS_TOKEN set";
+		clack.note(`${url}\n${access}`, "Running");
+		clack.outro("Press Ctrl+C to stop.");
 		if (options.open) openBrowser(url);
 	});
 }
@@ -1701,13 +1702,11 @@ async function ensureAuthReady(config) {
 	}
 	try {
 		await resolveXaiAuth(config);
-		console.log(`xAI OAuth ready: ${config.xai.oauthTokenFile}`);
+		clack.log.success(`xAI OAuth ready (${config.xai.oauthTokenFile})`);
 		return;
 	} catch (error) {
-		if (fs.existsSync(config.xai.oauthTokenFile)) {
-			console.warn(`xAI OAuth token check failed: ${error instanceof Error ? error.message : String(error)}`);
-			console.warn("Starting OAuth login to repair the token state.");
-		} else console.log(`No xAI OAuth token found at ${config.xai.oauthTokenFile}. Starting login.`);
+		if (fs.existsSync(config.xai.oauthTokenFile)) clack.log.warn(`xAI token check failed: ${error instanceof Error ? error.message : String(error)} — re-running login.`);
+		else clack.log.info("No xAI token found — starting login.");
 	}
 	await runXaiOauthLogin({ outputPath: config.xai.oauthTokenFile });
 	await resolveXaiAuth(config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grok-studio",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "private": false,
   "description": "Self-hosted Grok image-to-video studio (web app + CLI).",
   "bin": {