@osmo.inc/cli 0.1.17 → 0.1.18-preview.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/DEPLOY.md CHANGED
@@ -6,13 +6,13 @@ Share a rendered video from any tool, including drafts and work in progress. Req
6
6
 
7
7
  ```sh
8
8
  osmo login
9
- osmo share --video ./film.mp4 --name "Launch film"
10
- osmo share --video ./film-v2.mp4 --project PROJECT_ID
9
+ osmo share ./film.mp4 --name "Launch film"
10
+ osmo share ./film-v2.mp4 --to SHARE
11
11
  ```
12
12
 
13
- Without `--project`, each upload creates a new review. With `--project`, the upload adds a version to that review. The command does not initialize or write anything in the working folder.
13
+ 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.
14
14
 
15
- Add `--json` for machine-readable output containing `project`, `render`, `link`, and `versionLink`. A failed upload reports the project ID for retrying; only completed uploads appear in review history.
15
+ 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.
16
16
 
17
17
  ## Supported videos
18
18
 
@@ -27,24 +27,25 @@ Fractional frame rates are preserved. Variable-frame-rate videos retain playback
27
27
  `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.
28
28
 
29
29
  ```sh
30
- osmo comments list --project PROJECT_ID --open --json
31
- osmo comments reply COMMENT_ID "Updated in the latest version." --project PROJECT_ID
32
- osmo comments resolve COMMENT_ID --project PROJECT_ID
33
- osmo comments reopen COMMENT_ID --project PROJECT_ID
30
+ osmo comments list SHARE --open --json
31
+ osmo comments add SHARE "The logo lands late." --at 3.5
32
+ osmo comments reply COMMENT_ID "Updated in the latest version."
33
+ osmo comments resolve COMMENT_ID
34
+ osmo comments reopen COMMENT_ID
34
35
  ```
35
36
 
36
- Reviews support time ranges, canvas annotations, replies, and resolving comments.
37
+ 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.
37
38
 
38
39
  ## Disable review links
39
40
 
40
41
  ```sh
41
- osmo unshare --project PROJECT_ID
42
+ osmo unshare SHARE
42
43
  ```
43
44
 
44
- Requires login and owner or editor access to the project. Works from any folder without local project files, Git, or FFmpeg. Add `--json` for `{ "status": "undeployed", "project": "PROJECT_ID" }`. Repeating the command is safe.
45
+ 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.
45
46
 
46
- Videos, comments, and history remain stored. The main review link, all version links, public comment reads/writes, and new public download links stop working. Authenticated project access is retained.
47
+ 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.
47
48
 
48
49
  Previously obtained direct media URLs and downloaded copies are not revoked; already issued signed downloads can remain valid until expiry.
49
50
 
50
- A successful new `osmo share --video FILE.mp4 --project PROJECT_ID` restores the review links for the project 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.
51
+ 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.
package/README.md CHANGED
@@ -2,22 +2,34 @@
2
2
 
3
3
  Share videos. Collect feedback.
4
4
 
5
+ This preview build requires the matching cloud API update for the new share and comment commands. It does not replace the stable npm release.
6
+
5
7
  Upload a video from any tool and get a review link with timestamped comments and version history.
6
8
 
7
9
  ```sh
8
- npm install -g @osmo.inc/cli
10
+ npm install -g @osmo.inc/cli@preview
9
11
  osmo login
10
- osmo share --video ./video.mp4
12
+ osmo share ./video.mp4
11
13
  ```
12
14
 
13
15
  Add a version, read feedback, or disable the link:
14
16
 
15
17
  ```sh
16
- osmo share --video ./video-v2.mp4 --project PROJECT_ID
17
- osmo comments list --project PROJECT_ID --open --json
18
- osmo unshare --project PROJECT_ID
18
+ osmo shares
19
+ osmo share ./video-v2.mp4 --to SHARE
20
+ osmo comments list SHARE --open --json
21
+ osmo comments add SHARE "The logo lands late." --at 3.5
22
+ osmo comments reply COMMENT_ID "Updated in the latest version."
23
+ osmo comments resolve COMMENT_ID
24
+ osmo unshare SHARE
19
25
  ```
20
26
 
27
+ 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.
28
+
21
29
  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.
22
30
 
23
- [Sharing guide](DEPLOY.md) · [AI agent setup](SETUP.md)
31
+ 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.
32
+
33
+ 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.
34
+
35
+ See the [setup guide](SETUP.md) and [sharing guide](DEPLOY.md). Run `osmo --help` for all commands.
package/SETUP.md CHANGED
@@ -1,30 +1,28 @@
1
1
  # Osmo CLI setup
2
2
 
3
- Requires an Apple Silicon Mac, arm64 Node 22, and ffprobe (included with FFmpeg). The default service is **https://studio.osmo.inc**.
4
-
5
- ## Install
3
+ Requires an Apple Silicon Mac, arm64 Node 22, and ffprobe (included with FFmpeg). The default service is https://studio.osmo.inc.
6
4
 
7
5
  ```sh
8
- npm install -g @osmo.inc/cli
6
+ npm install -g @osmo.inc/cli@preview
9
7
  osmo login
10
- osmo share --video ./video.mp4
8
+ osmo share ./video.mp4
11
9
  ```
12
10
 
13
11
  ## Setup prompt for an AI agent
14
12
 
15
13
  ```text
16
- Install @osmo.inc/cli from npm. Check for arm64 Node 22 and ffprobe.
14
+ Install @osmo.inc/cli@preview from npm. Check for arm64 Node 22 and ffprobe.
17
15
  Run osmo login --json and show me the approval link and code. After I approve,
18
16
  poll login status with the returned sessionId, respecting retryAfter.
19
- Run osmo whoami --json, then osmo share --video /path/to/video.mp4 --json.
20
- No project setup or Git repository is needed. Return the review link and project ID.
17
+ Run osmo whoami --json, then osmo share /path/to/video.mp4 --json.
18
+ No project setup or Git repository is needed. Return the review link and share ID.
21
19
  Never read or print stored credentials.
22
20
  ```
23
21
 
24
22
  Use H.264 MP4, 8-bit 4:2:0 video, optionally with AAC audio, up to 2 GiB. Files are uploaded as supplied.
25
23
 
26
- For later versions, use `osmo share --video FILE.mp4 --project PROJECT_ID`.
27
- Read feedback with `osmo comments list --project PROJECT_ID --open --json`.
28
- Disable review links with `osmo unshare --project PROJECT_ID`, preserving the data.
24
+ 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.
25
+
26
+ 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.
29
27
 
30
28
  See the [sharing guide](DEPLOY.md) for version history, comments, and link access.