@osmo.inc/cli 0.1.18 → 0.1.19

package/DEPLOY.md

@@ -1,8 +1,9 @@
 # Share videos for review
 
-[Back to the CLI overview](README.md)
+[Back to the CLI overview](https://unpkg.com/@osmo.inc/cli/README.md)
 
-Share a rendered video from any tool, including drafts and work in progress. Requires an Osmo login and ffprobe, with no project setup or Git repository.
+Share a rendered video from any tool, including drafts and work in progress.
+Requires an Osmo login and ffprobe, with no project setup or Git repository.
 
 ```sh
 osmo login
@@ -10,31 +11,48 @@ osmo share ./film.mp4 --name "Launch film"
 osmo share ./film-v2.mp4 --to SHARE
 ```
 
-Without `--to`, each upload creates a new share. With `--to`, the upload adds a version to that share. SHARE accepts a review link, a version link, or a share ID. `osmo shares` lists yours. The command does not initialize or write anything in the working folder.
+Without `--to`, each upload creates a new share. With `--to`, the upload adds a
+version to that share. SHARE is the share's link (`/share/project/<id>`), one of
+its version links, or its ID, and `osmo shares` lists yours, the one with the
+newest version first. The command does not initialize or write anything in the
+working folder.
 
-Add `--json` for machine-readable output containing `share`, `version`, `link`, and `versionLink`. A failed upload reports the new share's ID for retrying; only completed uploads appear in review history.
+Add `--json` for machine-readable output containing `share`, `version`, `link`,
+and `versionLink`. When the command made a new share, a failed upload reports its
+ID for retrying; only completed uploads appear in review history.
 
 ## Supported videos
 
-Upload MP4 with H.264 8-bit 4:2:0 video and optional AAC audio, up to 2 GiB. Files are uploaded as supplied; export a compatible MP4 from your video tool before sharing. Uploads stream from disk without buffering the full file.
+Upload MP4 with H.264 8-bit 4:2:0 video and optional AAC audio, up to 2 GiB.
+Files are uploaded as supplied; export a compatible MP4 from your video tool
+before sharing. Uploads stream from disk without buffering the full file.
 
-Fractional frame rates are preserved. Variable-frame-rate videos retain playback duration and seconds-based comments; timeline frame positions use the average frame rate.
+Fractional frame rates are preserved. Variable-frame-rate videos retain playback
+duration and seconds-based comments; timeline frame positions use the average
+frame rate.
 
 ## Review links and comments
 
-`link` is the stable review URL. Refresh it after a successful upload to see the newest completed version. An already open review stays on its version while you comment. Failed uploads leave the previous video available.
+`link` is the stable review URL. Refresh it after a successful upload to see the
+newest completed version. An already open review stays on its version while you
+comment. Failed uploads leave the previous video available.
 
-`versionLink` points to one specific video version. Comments stay attached to that version, and existing version links continue to work while sharing is enabled. Anyone with a review link can access the review.
+`versionLink` points to one specific video version. Comments stay attached to that
+version, and existing version links continue to work while sharing is enabled.
+Anyone with a review link can access the review.
 
 ```sh
 osmo comments list SHARE --open --json
 osmo comments add SHARE "The logo lands late." --at 3.5
-osmo comments reply COMMENT_ID "Updated in the latest version."
-osmo comments resolve COMMENT_ID
-osmo comments reopen COMMENT_ID
+osmo comments reply COMMENT "Updated in the latest version."
+osmo comments resolve COMMENT
+osmo comments reopen COMMENT
 ```
 
-Reviews support time ranges, canvas annotations, replies, and resolving comments. Local review comments are not automatically uploaded by `osmo share`; the command uploads the video only.
+`comments list` covers every version of a share, newest first, and says which
+version each comment is on. A comment is addressed by its ID alone; a reply's ID
+stands for its thread. Reviews support time ranges, canvas annotations, replies,
+and resolving comments.
 
 ## Disable review links
 
@@ -42,10 +60,38 @@ Reviews support time ranges, canvas annotations, replies, and resolving comments
 osmo unshare SHARE
 ```
 
-Requires login and owner or editor access. Works from any folder without local project files, Git, or FFmpeg. Add `--json` for `{ "status": "unshared", "share": "SHARE_ID", "next": "..." }`. Repeating the command is safe.
+Requires login and owner or editor access to the share. Works from any folder
+without local project files, Git, or FFmpeg. Add `--json` for
+`{ "status": "unshared", "share": "SHARE_ID", "restore": "..." }`, where `restore`
+is the command that would turn the links back on. Repeating `unshare` is safe.
 
-Videos, comments, and history remain stored. The main review link, all version links, public comment reads/writes, and new public download links stop working. Authorized members retain access to read and answer comments through the CLI.
+Videos, comments, and history remain stored. The main review link, all version
+links, public comment reads/writes, and new public download links stop working.
+The people on the share can still read its comments with `osmo comments list SHARE`,
+and its owners and editors can still answer them with `osmo comments reply`.
 
-Previously obtained direct media URLs and downloaded copies are not revoked; already issued signed downloads can remain valid until expiry.
+Previously obtained direct media URLs and downloaded copies are not revoked;
+already issued signed downloads can remain valid until expiry.
 
-A successful new `osmo share FILE.mp4 --to SHARE` restores the review links for the share and its existing versions. Uploads begun before links were disabled, failed uploads, and retries of old completion requests do not restore them. Start a new upload to restore sharing.
+A successful new `osmo share FILE.mp4 --to SHARE` restores the review links for
+the share and its existing versions. Uploads begun before links were disabled,
+failed uploads, and retries of old completion requests do not restore them.
+Start a new upload to restore sharing.
+
+## Delete a share
+
+```sh
+osmo shares delete SHARE
+osmo shares delete SHARE --yes
+```
+
+Deletes a share for good: its videos, comments and history are removed, and this
+can't be undone. Only the share's owner can delete it. SHARE is the share's link
+or ID; a version's link is refused, since every version goes.
+
+Without `--yes` nothing is deleted. The command exits 1 and says what would go:
+with `--json`, `{ "status": "error", "error": "confirmation_required", "message": "...",
+"share": "SHARE_ID", "name": "NAME", "versions": N }` on stderr. With `--yes` it
+deletes, and `--json` prints `{ "status": "deleted", "share": "SHARE_ID", "versions": N }`.
+While a video is still uploading to the share the command is refused; run it again
+once the upload has finished.

package/README.md

@@ -1,33 +1,49 @@
 # Osmo CLI
 
-Share videos. Collect feedback.
-
-Upload a video from any tool and get a review link with timestamped comments and version history.
+Share videos, collect feedback, and run AI models on Osmo.
 
 ```sh
-npm install -g @osmo.inc/cli@latest
-osmo login
+npm install -g @osmo.inc/cli
+osmo login                # prints a link: open it and approve
+osmo login                # again, to finish signing in
 osmo share ./video.mp4
 ```
 
-Add a version, read feedback, or disable the link:
+Runs on any OS with Node 22 or later. Sharing a video also needs ffprobe, which
+comes with FFmpeg: `brew install ffmpeg` on macOS, `sudo apt install ffmpeg` on
+Debian or Ubuntu, `winget install ffmpeg` on Windows.
+
+## Share a video and collect feedback
+
+Upload a video from any tool and get a review link with timestamped comments and
+version history. No project setup or Git repository is needed.
 
 ```sh
-osmo shares
 osmo share ./video-v2.mp4 --to SHARE
+osmo shares
 osmo comments list SHARE --open --json
-osmo comments add SHARE "The logo lands late." --at 3.5
-osmo comments reply COMMENT_ID "Updated in the latest version."
-osmo comments resolve COMMENT_ID
+osmo comments reply COMMENT "Fixed in the latest version."
 osmo unshare SHARE
 ```
 
-SHARE accepts a review link, version link, or share ID. Comments are addressed by their ID. Videos, comments, and history are retained when links are disabled; authorized members can still read and answer feedback. Sharing a new version restores the review links.
+SHARE is a share's link or its ID; `osmo shares` lists yours. A comment is
+addressed by its ID alone. `osmo unshare` turns a share's links off and keeps
+everything; `osmo shares delete SHARE --yes` removes it for good. Accepts H.264 MP4 with optional AAC audio, up to 2 GiB.
+
+## Resources and AI models
 
-Requires **Apple Silicon macOS, Node 22, and ffprobe**. Accepts H.264 MP4 with optional AAC audio, up to 2 GiB. No project setup or Git required.
+```sh
+osmo resources list
+osmo resources show osmo/z-image-turbo
+osmo run osmo/z-image-turbo --input prompt="a red bicycle on a quiet street" --out bike.jpg
+osmo jobs
+```
 
-Discover resources and AI models with `osmo resources list --json`; inspect inputs with `osmo resources show ID --json`. `osmo run --help` explains model execution. Model runs use your account's energy allowance; `osmo login --no-spend` requests project access without model spending permission.
+`osmo resources` lists the AI models that run on Osmo, charged to your plan.
+`osmo resources show ID` lists a model's inputs. The catalog also holds packages
+for Osmo scenes, such as shaders and 3D models, which `osmo resources get`
+downloads.
 
-The default service is https://studio.osmo.inc. For preview testing, set `OSMO_BASE_URL=https://preview.osmo.inc`; each service has a separate login.
+Every command takes `--json` and `--help`.
 
-See the [setup guide](SETUP.md) and [sharing guide](DEPLOY.md). Run `osmo --help` for all commands.
+[Sharing guide](https://unpkg.com/@osmo.inc/cli/DEPLOY.md) · [AI agent setup](https://unpkg.com/@osmo.inc/cli/SETUP.md)

package/SETUP.md

@@ -1,9 +1,14 @@
 # Osmo CLI setup
 
-Requires an Apple Silicon Mac, arm64 Node 22, and ffprobe (included with FFmpeg). The default service is https://studio.osmo.inc.
+Runs on any OS with Node 22 or later. Sharing a video also needs ffprobe, which
+comes with FFmpeg: `brew install ffmpeg` on macOS, `sudo apt install ffmpeg` on
+Debian or Ubuntu, `winget install ffmpeg` on Windows. The default service is
+**https://studio.osmo.inc**.
+
+## Install
 
 ```sh
-npm install -g @osmo.inc/cli@latest
+npm install -g @osmo.inc/cli
 osmo login
 osmo share ./video.mp4
 ```
@@ -11,7 +16,7 @@ osmo share ./video.mp4
 ## Setup prompt for an AI agent
 
 ```text
-Install @osmo.inc/cli@latest from npm. Check for arm64 Node 22 and ffprobe.
+Install @osmo.inc/cli from npm. Check for Node 22 or later and ffprobe.
 Run osmo login --json and show me the approval link and code. After I approve,
 poll login status with the returned sessionId, respecting retryAfter.
 Run osmo whoami --json, then osmo share /path/to/video.mp4 --json.
@@ -19,10 +24,17 @@ No project setup or Git repository is needed. Return the review link and share I
 Never read or print stored credentials.
 ```
 
-Use H.264 MP4, 8-bit 4:2:0 video, optionally with AAC audio, up to 2 GiB. Files are uploaded as supplied.
+Use H.264 MP4, 8-bit 4:2:0 video, optionally with AAC audio, up to 2 GiB. Files
+are uploaded as supplied.
 
-For later versions, use `osmo share FILE.mp4 --to SHARE`, where SHARE is a link or ID. `osmo shares` lists your shares. Read feedback with `osmo comments list SHARE --open --json`, and answer it with `osmo comments reply COMMENT_ID "message"`. Disable review links with `osmo unshare SHARE`, preserving the data.
+For later versions, use `osmo share FILE.mp4 --to SHARE`, where SHARE is the share's
+link or ID; `osmo shares` lists yours. Read feedback with
+`osmo comments list SHARE --open --json` and answer it with
+`osmo comments reply COMMENT "message"`. Disable review links with
+`osmo unshare SHARE`, preserving the data.
 
-For project access without model spending permission, use `osmo login --no-spend`. A `scope_required` response names the login command needed to grant missing permissions.
+AI models run on Osmo and are charged to your plan. Find them with
+`osmo resources list --type model --json`; `osmo resources show ID --json` lists a
+model's inputs, and `osmo run ID --input KEY=VALUE` runs one.
 
-See the [sharing guide](DEPLOY.md) for version history, comments, and link access.
+See the [sharing guide](https://unpkg.com/@osmo.inc/cli/DEPLOY.md) for version history, comments, and link access.

package/THIRD_PARTY_NOTICES.md

@@ -1,18 +1,7 @@
 # Third-party notices
 
-Osmo contains third-party software and fonts under their respective licenses.
-Full copyright and license texts accompany this file in third-party/.
-The machine-readable inventory records exact dependency versions and notice paths.
-It conservatively includes Cargo build dependencies as well as runtime dependencies.
-
-Inter UI and embedded Inter Display fonts: SIL OFL 1.1; see third-party/packages/.
-The CLI renderer excludes the standalone desktop UI and its fonts.
-Mediabunny: MPL-2.0; its matching, unmodified source is included under
-third-party/npm/mediabunny@*/source/. MPL terms apply to those files.
-Rust standard-library notices are in third-party/rust-standard-library/.
-The esbuild binary entry also retains Go runtime and golang.org/x/sys notices.
-FFmpeg is an external prerequisite and is not included in this archive.
-
-Dual-licensed dependencies may be used under their permissive license option;
-this distribution does not select a GPL option where an Apache-2.0 option exists.
-Other vendored source notices are in third-party/repository-notices.md.
+This package bundles third-party software under its own license.
+Full copyright and license texts accompany this file in third-party/,
+with a machine-readable inventory of exact versions and notice paths.
+Studio, the renderer and their dependencies ship in the platform packages
+(@osmo.inc/cli-PLATFORM), each with its own notices.

package/bin/osmo.mjs

@@ -4,6 +4,18 @@
 // first whenever a source is newer, as `osmo studio open` rebuilds Studio.
 import { existsSync } from "node:fs";
 
+// Checked here, in a file every Node can load: the bundle imports things
+// older Nodes don't have, and fails to load before it could say so.
+if (Number(process.versions.node.split(".")[0]) < 22) {
+	const message = `Osmo needs Node 22 or later; this is Node ${process.versions.node}.`;
+	console.error(
+		process.argv.includes("--json")
+			? JSON.stringify({ status: "error", error: "cli_error", message })
+			: `Osmo: ${message}`,
+	);
+	process.exit(1);
+}
+
 const builder = new URL("../tools/build.mjs", import.meta.url);
 if (existsSync(builder)) {
 	const { buildCli, isStale } = await import(builder.href);