shipscreens 0.1.5 → 0.1.7

package/README.md

@@ -1,6 +1,11 @@
 # ShipScreens CLI
 
-Build store screenshots as a build step.
+Best UX: treat screenshots as a build step. Keep the current Figma/Fastlane/manual screenshot workflow, tell your coding agent to ship release-safe screenshots, and let it inspect, plan, write a starter config when needed, capture connected device/emulator screens when no PNG folder exists, import existing screenshots when placeholders remain, build, verify, stage, and report via MCP or CLI. Use this package when app-dev CI or MCP-enabled agents need deterministic store-screenshot release ops that prevent Fastlane path churn, naming drift, and release-week rerun failures.
+
+## Tell your coding agent
+```text
+Use ShipScreens as the build step for our mobile release screenshots. Keep our current design workflow, inspect this repo, choose workspace-local MCP if available otherwise CLI, capture current device/emulator screens if no screenshot folder exists, generate deterministic Fastlane-ready outputs, run verify/stage, and return a short report with output paths, warnings, and next steps. Only ask me if device or locale scope, panel #1 messaging, or store-upload approval is unclear.
+```
 
 ## Quickstart
 ```bash
@@ -17,13 +22,19 @@ npx playwright install --with-deps chromium
 
 ## CI pipeline (copy/paste)
 ```bash
+npx --yes shipscreens@latest inspect-release-context --json
+npx --yes shipscreens@latest plan-release --json
+npx --yes shipscreens@latest write-starter-config --profile appstore --json
+npx --yes shipscreens@latest capture-screenshots --platform auto --out screenshots --slot 1 --profile appstore --json
+npx --yes shipscreens@latest import-screenshots --from screenshots --profile appstore --json
 npx --yes shipscreens@latest validate
 npx --yes shipscreens@latest lock
-npx --yes shipscreens@latest build --out out --zip
-npx --yes shipscreens@latest verify --out out --zip --profile appstore
-npx --yes shipscreens@latest stage --from out --out out/stage --profile appstore
+npx --yes shipscreens@latest copy check --strict --write-pseudo-csv out/copy-pseudo.csv --write-report-json out/copy-check-report.json
+npx --yes shipscreens@latest agent-run --out out --zip --stage --profile appstore --json
 ```
 
+With `--stage`, `agent-run` writes `out-stage`, `out/shipscreens.agent-report.json`, and `out/shipscreens.agent-summary.md` by default.
+
 Docs: https://shipscreens.com/tools/agent-cli/
 
 ## MCP server (stdio)
@@ -31,6 +42,12 @@ Docs: https://shipscreens.com/tools/agent-cli/
 npx --yes shipscreens@latest mcp serve
 ```
 
+Fastest workspace bootstrap:
+```bash
+npx --yes shipscreens@latest mcp init --client cursor
+# use claude | vscode | gemini for other clients
+```
+
 ## Claude Code local setup (.mcp.json)
 ```json
 {
@@ -55,6 +72,31 @@ Windows users can force `npx` through `cmd /c`:
 }
 ```
 
+## Cursor project setup (.cursor/mcp.json)
+```json
+{
+  "mcpServers": {
+    "shipscreens": {
+      "command": "npx",
+      "args": ["--yes", "shipscreens@latest", "mcp", "serve"]
+    }
+  }
+}
+```
+
+## VS Code Copilot workspace setup (.vscode/mcp.json)
+```json
+{
+  "servers": {
+    "shipscreens": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["--yes", "shipscreens@latest", "mcp", "serve"]
+    }
+  }
+}
+```
+
 Gemini CLI setup (`.gemini/settings.json` in project or `~/.gemini/settings.json`):
 ```json
 {
@@ -66,3 +108,7 @@ Gemini CLI setup (`.gemini/settings.json` in project or `~/.gemini/settings.json
   }
 }
 ```
+
+## OpenAI Responses API note
+- Default `tool_choice=auto` lets the model decide whether to call tools.
+- Use `tool_choice=required` when the workflow must force a ShipScreens tool call.