@khalidsaidi/skillrunner 0.1.2 → 0.1.3

package/dist/registry/skills/openai-sora/upstream/LICENSE.txt

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf of
+   any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don\'t include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/dist/registry/skills/openai-sora/upstream/SKILL.md

@@ -0,0 +1,153 @@
+---
+name: "sora"
+description: "Use when the user asks to generate, remix, poll, list, download, or delete Sora videos via OpenAI\u2019s video API using the bundled CLI (`scripts/sora.py`), including requests like \u201cgenerate AI video,\u201d \u201cSora,\u201d \u201cvideo remix,\u201d \u201cdownload video/thumbnail/spritesheet,\u201d and batch video generation; requires `OPENAI_API_KEY` and Sora API access."
+---
+
+
+# Sora Video Generation Skill
+
+Creates or manages short video clips for the current project (product demos, marketing spots, cinematic shots, UI mocks). Defaults to `sora-2` and a structured prompt augmentation workflow, and prefers the bundled CLI for deterministic runs. Note: `$sora` is a skill tag in prompts, not a shell command.
+
+## When to use
+- Generate a new video clip from a prompt
+- Remix an existing video by ID
+- Poll status, list jobs, or download assets (video/thumbnail/spritesheet)
+- Batch runs (many prompts or variants)
+
+## Decision tree (create vs remix vs status/download vs batch)
+- If the user has a **video id** and wants a change → **remix**
+- If the user has a **video id** and wants status or assets → **status/poll/download**
+- If the user needs many prompts/assets → **create-batch**
+- If the user asks for two versions with a small change (same shot, different subject/detail) → **create** the base, then **remix** for the variation
+- Otherwise → **create** (or **create-and-poll** if they need a ready asset in one step)
+
+## Workflow
+1. Decide intent: create vs remix vs status/download vs batch.
+2. Collect inputs: prompt, model, size, seconds, and any input reference image.
+3. If batch: write a temporary JSONL under tmp/ (one job per line), run once, then delete the JSONL.
+4. Prefer CLI augmentation flags (`--use-case`, `--scene`, `--camera`, etc.) instead of pre-writing a structured prompt. If you already produced a structured prompt file, pass `--no-augment` to avoid double-wrapping.
+5. Run the bundled CLI (`scripts/sora.py`) with sensible defaults (see references/cli.md). For long prompts, prefer `--prompt-file` to avoid shell-escaping issues; pair with `--no-augment` if the prompt is already structured.
+6. For async jobs, poll until complete (or use create-and-poll).
+7. Download assets (video/thumbnail/spritesheet) and save locally.
+8. Remove intermediate files created during invocation (for example `prompt.txt`, `remix_job.json`, temp JSONL). If the sandbox blocks `rm`, skip cleanup or truncate the files without surfacing an error.
+9. Iterate with a single targeted change per prompt.
+
+## Authentication
+- `OPENAI_API_KEY` must be set for live API calls.
+
+If the key is missing, give the user these steps:
+1. Create an API key in the OpenAI platform UI: https://platform.openai.com/api-keys
+2. Set `OPENAI_API_KEY` as an environment variable in their system.
+3. Offer to guide them through setting the environment variable for their OS/shell if needed.
+- Never ask the user to paste the full key in chat. Ask them to set it locally and confirm when ready.
+
+## Defaults & rules
+- Default model: `sora-2` (use `sora-2-pro` for higher fidelity).
+- Default size: `1280x720`.
+- Default seconds: `4` (allowed: "4", "8", "12" as strings).
+- Always set size and seconds via API params; prose will not change them.
+- Use the OpenAI Python SDK (`openai` package); do not use raw HTTP.
+- Require `OPENAI_API_KEY` before any live API call.
+- If uv cache permissions fail, set `UV_CACHE_DIR=/tmp/uv-cache`.
+- Input reference images must be jpg/png/webp and should match target size.
+- Download URLs expire after about 1 hour; copy assets to your own storage.
+- Prefer the bundled CLI and **never modify** `scripts/sora.py` unless the user asks.
+- Sora can generate audio; if a user requests voiceover/audio, specify it explicitly in the `Audio:` and `Dialogue:` lines and keep it short.
+
+## API limitations
+- Models are limited to `sora-2` and `sora-2-pro`.
+- API access to Sora models requires an organization-verified account.
+- Duration is limited to 4/8/12 seconds and must be set via the `seconds` parameter.
+- The API expects `seconds` as a string enum ("4", "8", "12").
+- Output sizes are limited by model (see `references/video-api.md` for the supported sizes).
+- Video creation is async; you must poll for completion before downloading.
+- Rate limits apply by usage tier (do not list specific limits).
+- Content restrictions are enforced by the API (see Guardrails below).
+
+## Guardrails (must enforce)
+- Only content suitable for audiences under 18.
+- No copyrighted characters or copyrighted music.
+- No real people (including public figures).
+- Input images with human faces are rejected.
+
+## Prompt augmentation
+Reformat prompts into a structured, production-oriented spec. Only make implicit details explicit; do not invent new creative requirements.
+
+Template (include only relevant lines):
+```
+Use case: <where the clip will be used>
+Primary request: <user's main prompt>
+Scene/background: <location, time of day, atmosphere>
+Subject: <main subject>
+Action: <single clear action>
+Camera: <shot type, angle, motion>
+Lighting/mood: <lighting + mood>
+Color palette: <3-5 color anchors>
+Style/format: <film/animation/format cues>
+Timing/beats: <counts or beats>
+Audio: <ambient cue / music / voiceover if requested>
+Text (verbatim): "<exact text>"
+Dialogue:
+<dialogue>
+- Speaker: "Short line."
+</dialogue>
+Constraints: <must keep/must avoid>
+Avoid: <negative constraints>
+```
+
+Augmentation rules:
+- Keep it short; add only details the user already implied or provided elsewhere.
+- For remixes, explicitly list invariants ("same shot, change only X").
+- If any critical detail is missing and blocks success, ask a question; otherwise proceed.
+- If you pass a structured prompt file to the CLI, add `--no-augment` to avoid the tool re-wrapping it.
+
+## Examples
+
+### Generation example (single shot)
+```
+Use case: product teaser
+Primary request: a close-up of a matte black camera on a pedestal
+Action: slow 30-degree orbit over 4 seconds
+Camera: 85mm, shallow depth of field, gentle handheld drift
+Lighting/mood: soft key light, subtle rim, premium studio feel
+Constraints: no logos, no text
+```
+
+### Remix example (invariants)
+```
+Primary request: same shot and framing, switch palette to teal/sand/rust with warmer backlight
+Constraints: keep the subject and camera move unchanged
+```
+
+## Prompting best practices (short list)
+- One main action + one camera move per shot.
+- Use counts or beats for timing ("two steps, pause, turn").
+- Keep text short and the camera locked-off for UI or on-screen text.
+- Add a brief avoid line when artifacts appear (flicker, jitter, fast motion).
+- Shorter prompts are more creative; longer prompts are more controlled.
+- Put dialogue in a dedicated block; keep lines short for 4-8s clips.
+- State invariants explicitly for remixes (same shot, same camera move).
+- Iterate with single-change follow-ups to preserve continuity.
+
+## Guidance by asset type
+Use these modules when the request is for a specific artifact. They provide targeted templates and defaults.
+- Cinematic shots: `references/cinematic-shots.md`
+- Social ads: `references/social-ads.md`
+
+## CLI + environment notes
+- CLI commands + examples: `references/cli.md`
+- API parameter quick reference: `references/video-api.md`
+- Prompting guidance: `references/prompting.md`
+- Sample prompts: `references/sample-prompts.md`
+- Troubleshooting: `references/troubleshooting.md`
+- Network/sandbox tips: `references/codex-network.md`
+
+## Reference map
+- **`references/cli.md`**: how to run create/poll/remix/download/batch via `scripts/sora.py`.
+- **`references/video-api.md`**: API-level knobs (models, sizes, duration, variants, status).
+- **`references/prompting.md`**: prompt structure and iteration guidance.
+- **`references/sample-prompts.md`**: copy/paste prompt recipes (examples only; no extra theory).
+- **`references/cinematic-shots.md`**: templates for filmic shots.
+- **`references/social-ads.md`**: templates for short social ad beats.
+- **`references/troubleshooting.md`**: common errors and fixes.
+- **`references/codex-network.md`**: network/approval troubleshooting.

package/dist/registry/skills/openai-sora/upstream/agents/openai.yaml

@@ -0,0 +1,6 @@
+interface:
+  display_name: "Sora Video Generation Skill"
+  short_description: "Generate and manage Sora videos"
+  icon_small: "./assets/sora-small.svg"
+  icon_large: "./assets/sora.png"
+  default_prompt: "Plan and generate a Sora video for this request, then iterate with concrete prompt edits."

package/dist/registry/skills/openai-sora/upstream/assets/sora-small.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" fill="currentColor" viewBox="0 0 14 14">
+  <path fill="currentColor" fill-rule="evenodd" d="M4.668 4.896c.552-.148 1.113.252 1.288.905l.192.718c.175.654-.11 1.281-.662 1.429-.551.147-1.112-.252-1.287-.906l-.193-.719c-.175-.654.111-1.28.662-1.427Zm.16.403a.057.057 0 0 0-.096.026l-.088.362a.058.058 0 0 1-.016.027l-.27.258a.057.057 0 0 0 .027.096l.361.088c.01.002.02.008.028.016l.257.269c.031.032.086.018.096-.025l.088-.362a.06.06 0 0 1 .016-.028l.27-.257a.057.057 0 0 0-.026-.096l-.362-.089a.058.058 0 0 1-.028-.015l-.257-.27Zm2.685-1.166c.551-.148 1.112.252 1.287.905l.192.719c.175.654-.11 1.28-.662 1.428-.551.147-1.111-.253-1.286-.907L6.85 5.56c-.175-.654.11-1.28.662-1.427Zm.159.403a.057.057 0 0 0-.096.026l-.088.361a.057.057 0 0 1-.016.028l-.27.257a.057.057 0 0 0 .026.096l.362.089c.01.002.02.007.028.015l.257.27a.057.057 0 0 0 .096-.026l.088-.362a.058.058 0 0 1 .016-.027l.27-.258a.057.057 0 0 0-.027-.096l-.36-.088a.058.058 0 0 1-.029-.016l-.257-.27Z" clip-rule="evenodd"/>
+  <path fill="currentColor" fill-rule="evenodd" d="M6.001 1.167c.743 0 1.423.27 1.948.715a3.015 3.015 0 0 1 3.502 3.502c.446.525.716 1.206.716 1.948 0 1.308-.834 2.42-1.997 2.838a3.015 3.015 0 0 1-4.786 1.281A3.015 3.015 0 0 1 1.882 7.95a3.004 3.004 0 0 1-.71-1.793l-.005-.155c0-1.308.833-2.42 1.996-2.839A3.016 3.016 0 0 1 6 1.167Zm0 .885c-.985 0-1.815.67-2.058 1.578a.444.444 0 0 1-.313.313 2.13 2.13 0 0 0-.954 3.564.443.443 0 0 1 .115.427 2.13 2.13 0 0 0 2.609 2.61l.057-.012a.443.443 0 0 1 .37.126 2.131 2.131 0 0 0 3.564-.955l.018-.056a.443.443 0 0 1 .294-.257 2.131 2.131 0 0 0 .955-3.564.443.443 0 0 1-.115-.427 2.13 2.13 0 0 0-2.61-2.61.443.443 0 0 1-.426-.113 2.123 2.123 0 0 0-1.396-.622l-.11-.002Z" clip-rule="evenodd"/>
+</svg>

package/dist/registry/skills/openai-sora/upstream/references/cinematic-shots.md

@@ -0,0 +1,53 @@
+# Cinematic shot templates
+
+Use these for filmic, mood-forward clips. Keep one subject, one action, one camera move.
+
+## Shot grammar (pick one)
+- Static wide: locked-off, slow atmosphere changes
+- Dolly-in: slow push toward subject
+- Dolly-out: reveal more context
+- Orbit: 15-45 degree arc around subject
+- Lateral move: smooth left-right slide
+- Crane: subtle vertical rise
+- Handheld drift: gentle, controlled sway
+
+## Default template
+```
+Use case: cinematic shot
+Primary request: <subject + setting>
+Scene/background: <location, time of day, atmosphere>
+Subject: <main subject>
+Action: <one clear action>
+Camera: <shot type, lens, motion>
+Lighting/mood: <key light + mood>
+Color palette: <3-5 anchors>
+Style/format: filmic, natural grain
+Constraints: no logos, no text, no people
+Avoid: jitter; flicker; oversharpening
+```
+
+## Example: moody exterior
+```
+Use case: cinematic shot
+Primary request: a lone cabin on a cliff above the sea
+Scene/background: foggy coastline at dawn, drifting mist
+Subject: small wooden cabin with warm window glow
+Action: light fog rolls past the cabin
+Camera: slow dolly-in, 35mm, steady
+Lighting/mood: moody, soft dawn light, subtle contrast
+Color palette: deep blue, slate, warm amber
+Constraints: no logos, no text, no people
+```
+
+## Example: intimate detail
+```
+Use case: cinematic detail
+Primary request: close-up of a vinyl record spinning
+Scene/background: dim room, soft lamp glow
+Subject: record grooves and stylus
+Action: slow rotation, subtle dust motes
+Camera: macro, locked-off
+Lighting/mood: warm, low-key, soft highlights
+Color palette: warm amber, deep brown, charcoal
+Constraints: no logos, no text
+```

package/dist/registry/skills/openai-sora/upstream/references/cli.md

@@ -0,0 +1,248 @@
+# CLI reference (`scripts/sora.py`)
+
+This file contains the command catalog for the bundled video generation CLI. Keep `SKILL.md` overview-first; put verbose CLI details here.
+
+## What this CLI does
+- `create`: create a new video job (async)
+- `create-and-poll`: create a job, poll until complete, optionally download
+- `poll`: wait for an existing job to finish
+- `status`: retrieve job status/details
+- `download`: download video/thumbnail/spritesheet
+- `list`: list recent jobs
+- `delete`: delete a job
+- `remix`: remix a completed video
+- `create-batch`: create multiple jobs from a JSONL file
+
+Real API calls require **network access** + `OPENAI_API_KEY`. `--dry-run` does not.
+
+## Quick start (works from any repo)
+Set a stable path to the skill CLI (default `CODEX_HOME` is `~/.codex`):
+
+```
+export CODEX_HOME="${CODEX_HOME:-$HOME/.codex}"
+export SORA_CLI="$CODEX_HOME/skills/sora/scripts/sora.py"
+```
+
+If you're in this repo, you can set the path directly:
+
+```
+# Use repo root (tests run from output/* so $PWD is not the root)
+export SORA_CLI="$(git rev-parse --show-toplevel)/<path-to-skill>/scripts/sora.py"
+```
+
+If `git` isn't available, set `SORA_CLI` to the absolute path to `<path-to-skill>/scripts/sora.py`.
+
+If uv cache fails with permission errors, set a writable cache:
+
+```
+export UV_CACHE_DIR="/tmp/uv-cache"
+```
+
+Dry-run (no API call; no network required; does not require the `openai` package):
+
+```
+python "$SORA_CLI" create --prompt "Test" --dry-run
+```
+
+Preflight a full prompt without running the API:
+
+```
+python "$SORA_CLI" create --prompt-file prompt.txt --dry-run --json-out out/request.json
+```
+
+Create a job (requires `OPENAI_API_KEY` + network):
+
+```
+uv run --with openai python "$SORA_CLI" create \
+  --model sora-2 \
+  --prompt "Wide tracking shot of a teal coupe on a desert highway" \
+  --size 1280x720 \
+  --seconds 8
+```
+
+Create from a prompt file (avoids shell-escaping issues for multi-line prompts):
+
+```
+cat > prompt.txt << 'EOF'
+Use case: landing page hero
+Primary request: a matte black camera on a pedestal
+Action: slow 30-degree orbit over 4 seconds
+Camera: 85mm, shallow depth of field
+Lighting/mood: soft key light, subtle rim
+Constraints: no logos, no text
+EOF
+
+uv run --with openai python "$SORA_CLI" create \
+  --prompt-file prompt.txt \
+  --size 1280x720 \
+  --seconds 4
+```
+
+If your prompt file is already structured (Use case/Scene/Camera/etc), disable tool augmentation:
+
+```
+uv run --with openai python "$SORA_CLI" create \
+  --prompt-file prompt.txt \
+  --no-augment \
+  --size 1280x720 \
+  --seconds 4
+```
+
+Create + poll + download:
+
+```
+uv run --with openai python "$SORA_CLI" create-and-poll \
+  --model sora-2-pro \
+  --prompt "Close-up of a steaming coffee cup on a wooden table" \
+  --size 1280x720 \
+  --seconds 8 \
+  --download \
+  --variant video \
+  --out coffee.mp4
+```
+
+Create + poll + write JSON bundle:
+
+```
+uv run --with openai python "$SORA_CLI" create-and-poll \
+  --prompt "Minimal product teaser of a matte black camera" \
+  --json-out out/coffee-job.json
+```
+
+Remix a completed video:
+
+```
+uv run --with openai python "$SORA_CLI" remix \
+  --id video_abc123 \
+  --prompt "Same shot, shift palette to teal/sand/rust with warm backlight."
+```
+
+Download a thumbnail or spritesheet:
+
+```
+uv run --with openai python "$SORA_CLI" download --id video_abc123 --variant thumbnail --out thumb.webp
+uv run --with openai python "$SORA_CLI" download --id video_abc123 --variant spritesheet --out sheet.jpg
+```
+
+## Guardrails (important)
+- Use `python "$SORA_CLI" ...` (or equivalent full path) for all video work.
+- For API calls, prefer `uv run --with openai ...` to avoid missing SDK errors.
+- Do **not** create one-off runners unless the user explicitly asks.
+- **Never modify** `scripts/sora.py` unless the user asks.
+
+## Defaults (unless overridden by flags)
+- Model: `sora-2`
+- Size: `1280x720`
+- Seconds: `4` (API expects a string enum: "4", "8", "12")
+- Variant: `video`
+- Poll interval: `10` seconds
+
+## JSON output (`--json-out`)
+- For `create`, `status`, `list`, `delete`, `poll`, and `remix`, `--json-out` writes the JSON response to a file.
+- For `create-and-poll`, `--json-out` writes a bundle: `{ "create": ..., "final": ... }`.
+- If the path has no extension, `.json` is added automatically.
+- In `--dry-run`, `--json-out` writes the request preview instead of a response.
+
+## Input reference images
+- Must be jpg/png/webp; they should match the target size.
+- Provide the path with `--input-reference`.
+
+## Optional deps
+Prefer `uv run --with ...` for an out-of-the-box run without changing the current project env; otherwise install into your active env:
+
+```
+uv pip install openai
+```
+
+## JSONL schema for `create-batch`
+Each line is a JSON object (or a raw prompt string). Required key: `prompt`.
+
+Top-level override keys:
+- `model`, `size`, `seconds`
+- `input_reference` (path)
+- `out` (optional output filename for the job JSON)
+
+Prompt augmentation keys (top-level or under `fields`):
+- `use_case`, `scene`, `subject`, `action`, `camera`, `style`, `lighting`, `palette`, `audio`, `dialogue`, `text`, `timing`, `constraints`, `negative`
+
+Notes:
+- `fields` merges into the prompt augmentation inputs.
+- Top-level keys override CLI defaults.
+- `seconds` must be one of: "4", "8", "12".
+
+## Common recipes
+
+Create with prompt augmentation fields:
+
+```
+uv run --with openai python "$SORA_CLI" create \
+  --prompt "A minimal product teaser shot of a matte black camera" \
+  --use-case "landing page hero" \
+  --camera "85mm, slow orbit" \
+  --lighting "soft key, subtle rim" \
+  --constraints "no logos, no text"
+```
+
+Two-variant workflow (base + remix):
+
+```
+# 1) Base clip
+uv run --with openai python "$SORA_CLI" create-and-poll \
+  --prompt "Ceramic mug on a sunlit wooden table in a cozy cafe" \
+  --size 1280x720 --seconds 4 --download --out output.mp4
+
+# 2) Remix with invariant (same shot, change only the drink)
+uv run --with openai python "$SORA_CLI" remix \
+  --id video_abc123 \
+  --prompt "Same shot and framing; replace the mug with an iced americano in a glass, visible ice and condensation."
+
+# 3) Poll and download the remix
+uv run --with openai python "$SORA_CLI" poll \
+  --id video_def456 --download --out remix.mp4
+```
+
+Poll and download after a job finishes:
+
+```
+uv run --with openai python "$SORA_CLI" poll --id video_abc123 --download --variant video --out out.mp4
+```
+
+Write JSON response to a file:
+
+```
+uv run --with openai python "$SORA_CLI" status --id video_abc123 --json-out out/status.json
+```
+
+Batch create (JSONL input):
+
+```
+mkdir -p tmp/sora
+cat > tmp/sora/prompts.jsonl << 'EOB'
+{"prompt":"A neon-lit rainy alley, slow dolly-in","seconds":"4"}
+{"prompt":"A warm sunrise over a misty lake, gentle pan","seconds":"8",
+ "fields":{"camera":"35mm, slow pan","lighting":"soft dawn light"}}
+EOB
+
+uv run --with openai python "$SORA_CLI" create-batch --input tmp/sora/prompts.jsonl --out-dir out --concurrency 3
+
+# Cleanup (recommended)
+rm -f tmp/sora/prompts.jsonl
+```
+
+Notes:
+- `create-batch` writes one JSON response per job under `--out-dir`.
+- Output names default to `NNN-<prompt-slug>.json`.
+- Use `--concurrency` to control parallelism (default `3`). Higher concurrency can hit rate limits.
+- Treat the JSONL file as temporary: write it under `tmp/` and delete it after the run (do not commit it). If `rm` is blocked in your sandbox, skip cleanup or truncate the file.
+
+## CLI notes
+- Supported sizes depend on model (see `references/video-api.md`).
+- Seconds are limited to 4, 8, or 12.
+- Download URLs expire after about 1 hour; copy assets to your own storage.
+- In CI/sandboxes where long-running commands time out, prefer `create` + `poll` (or add `--timeout`).
+
+## See also
+- API parameter quick reference: `references/video-api.md`
+- Prompt structure and examples: `references/prompting.md`
+- Sample prompts: `references/sample-prompts.md`
+- Troubleshooting: `references/troubleshooting.md`