@osmo.inc/cli 0.1.23 → 0.1.25

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
@@ -39,21 +39,66 @@ osmo studio deploy
39
39
 
40
40
  The first deployment creates a private cloud project. Its review link is separate
41
41
  from source access and opens for anyone who has the link. Later deployments add
42
- versions to the same review destination. `link` is the stable review URL,
43
- `versionLink` identifies one version, and `page` is the cloud project URL.
44
- Use `osmo studio open` for local editing.
42
+ versions to the same review link. The command prints that one link: it shows the
43
+ newest version to anyone who has it, and someone on the project who is signed in
44
+ finds "View project" on it, or "Edit project" with web editing, which opens the
45
+ project itself. With `--json`, `link` is the review URL, `versionLink`
46
+ is this version's own URL, and `page` is the project's page. Use
47
+ `osmo studio open` for local editing.
45
48
 
46
49
  `osmo studio sync` synchronizes local source and cloud revisions;
47
- `osmo studio history` lists revisions. In an already connected project, sync
50
+ `osmo studio history` lists revisions and marks the project's versions: a
51
+ sync's or a deploy's. A comment made in Studio in the web goes on the version
52
+ that was the latest at the time; one made on the review link, on the version
53
+ its reviewer watched. In an already connected project, sync
48
54
  before and after editing. Deploy refuses unseen cloud changes; sync and inspect
49
55
  those changes before trying again. `osmo studio clone PROJECT` copies a project
50
56
  you can access into a local folder. These cloud operations need login.
51
57
 
52
- Read local and cloud feedback with `osmo studio comments list --open --json`.
58
+ Read local and cloud feedback with `osmo studio comments list --open --json`:
59
+ the comments from the local Studio, from Studio in the web (anyone on the
60
+ project can comment there, on the live project) and from the review link, each
61
+ with its scene, its time and, for a cloud comment, the version it is on. A
62
+ comment made in Studio never appears on the review link.
53
63
  Use `osmo studio permissions` to inspect source access. Permissions, invitations,
54
64
  and revocation work as before; deploying does not make private source public.
55
65
 
56
- ## Supported videos
66
+ ## Render on cloud GPUs
67
+
68
+ Use cloud rendering when your machine cannot render quickly or agents need to
69
+ submit several projects at once:
70
+
71
+ ```sh
72
+ osmo studio deploy --cloud
73
+ osmo jobs RENDER_JOB_ID
74
+ osmo jobs cancel RENDER_JOB_ID
75
+ # Or wait for the finished review link:
76
+ osmo studio deploy --cloud --wait
77
+ ```
78
+
79
+ The command uploads the revision and returns a durable job ID. You can disconnect
80
+ after submission; `--wait` only keeps the local command waiting. It publishes to
81
+ the same project and review link as regular deploy. Cloud rendering uses playable
82
+ `Video.src` assets, so upload any required assets with the project.
83
+
84
+ Cloud rendering consumes paid plan allowance or purchased credits. The free plan's
85
+ allowance cannot fund it. Basic allows up to 10 active jobs, Pro 25, and Max 50;
86
+ purchased credits without a paid plan allow 10. Workspace renders use the paying
87
+ seat's limit. Jobs beyond the account limit or available GPU capacity wait in the
88
+ queue. These are account ceilings, not a guarantee of immediately available GPUs.
89
+
90
+ Only active preparation, rendering, and encoding consume allowance. Queueing and
91
+ upload time are free. Failed renders are free; infrastructure retries charge only
92
+ the successful attempt. Cancelling a running render consumes its acknowledged
93
+ processing time. Reusing an identical successful render is free. Jobs reserve
94
+ allowance before starting and never consume more than that reservation.
95
+
96
+ Cloud output supports up to 3840×2160 (or portrait), 60 fps, 10 minutes, and 20 GiB.
97
+ Source files remain limited to 2 GiB each, with a 20 GiB project total. A queued job
98
+ expires after 24 hours. Availability and rates are controlled by the service;
99
+ `--json` includes the job's payer and usage information.
100
+
101
+ ## Supported video uploads
57
102
 
58
103
  Upload MP4 with H.264 8-bit 4:2:0 video and optional AAC audio, up to 2 GiB.
59
104
  Files are uploaded as supplied; export a compatible MP4 from your video tool
package/README.md CHANGED
@@ -26,6 +26,11 @@ osmo studio render
26
26
  Local editing and rendering need no Osmo account. `open` starts the local browser
27
27
  editor and prints its address; it keeps running while you edit. Read the generated
28
28
  `AGENTS.md` before authoring with an agent. `render` saves `exports/scene.mp4`.
29
+ Rendering uses the browser-playable `Video.src` by default. Use
30
+ `osmo studio render --original --out exports/final.mov` to select local
31
+ `Video.originalSrc` where set, recommended for final RAW renders.
32
+ Missing originals fail only with this flag;
33
+ clips without `originalSrc` still use `src`. The flag also works with `--at`.
29
34
 
30
35
  Local Studio supports Apple Silicon macOS and Linux x64/arm64 with glibc. It needs
31
36
  Git 2.29+ for project setup and FFmpeg with libx264 plus ffprobe for video rendering.
@@ -42,6 +47,11 @@ not runnable local projects: media remains as URLs, and no Git history or cloud
42
47
  sync connection is created. Pass a folder argument to override the destination.
43
48
  Cloud operations require login and retain existing source permissions.
44
49
 
50
+ On a machine with limited GPU power, use `osmo studio deploy --cloud` to submit
51
+ the render to Osmo's GPUs using paid allowance or credits. Add `--wait` to wait
52
+ for the review link, or follow the returned job with `osmo jobs JOB_ID`.
53
+ See the [cloud rendering guide](https://unpkg.com/@osmo.inc/cli/DEPLOY.md).
54
+
45
55
  ## Share a video and collect feedback
46
56
 
47
57
  Upload a video from any tool and get a review link with timestamped comments and
@@ -91,3 +101,35 @@ login created using `--no-spend`.
91
101
  A blocked plan also includes `reason`, `resetsAt`, and guidance in `message`.
92
102
  An exhausted plan is a successful status read (exit 0); authentication, network,
93
103
  and permission failures exit 1. Raw internal billing units are never returned.
104
+
105
+
106
+ ### Film resources
107
+
108
+ Film looks download automatically when a project opens, a look is applied, or a
109
+ scene is rendered. Only the tables needed by that scene and camera profile are
110
+ fetched. Studio shows progress and a Retry action if a download fails; a render
111
+ never silently omits a film effect. Installed tables work offline.
112
+
113
+ To prepare the entire library for offline use (about 1.16 GiB unpacked):
114
+
115
+ ```sh
116
+ osmo resources get film
117
+ ```
118
+
119
+ Find individual looks with `osmo resources list --type film`, inspect one with
120
+ `osmo resources show ID`, then install it with `osmo resources get ID`.
121
+ `osmo resources install` is an alias for `get`. An individual look installs all
122
+ three camera variants (about 9.4 MiB); automatic downloads fetch only the needed
123
+ variant (about 3.14 MiB).
124
+
125
+ Film resources install once per user, shared across projects and CLI versions:
126
+
127
+ - macOS: `~/Library/Application Support/Osmo/resources/film`
128
+ - Linux: `$XDG_DATA_HOME/osmo/resources/film` (default `~/.local/share/osmo/resources/film`)
129
+ - Windows: `%LOCALAPPDATA%/Osmo/resources/film` (resource downloads only; local Studio still needs a supported renderer platform)
130
+
131
+ `OSMO_FILM_TABLES` overrides that directory, including for native rendering.
132
+ Files are pinned to the CLI's catalogue, checked by size and SHA-256, and written
133
+ atomically. npm updates and uninstall leave these files in place. Film downloads
134
+ need no login. Shaders and 3D models keep their existing project/folder downloads
135
+ and preserve user-modified files; `--out` applies to those resources, not film.
package/SETUP.md CHANGED
@@ -44,6 +44,14 @@ Cloud sync is optional. For a project already connected to the cloud, sync befor
44
44
  and after editing; resolve any conflicts before deploying. To remix an accessible
45
45
  shared project, sign in, run `osmo studio clone PROJECT`, then open the local copy.
46
46
 
47
+ ## Film looks and offline use
48
+
49
+ Film tables install automatically into a shared per-user Osmo data folder when
50
+ opening projects, changing effects, or rendering. Studio shows download progress
51
+ and Retry. Prepare every look before going offline with `osmo resources get film`
52
+ (about 1.16 GiB); use `osmo resources list --type film` to choose individual looks.
53
+ No separate setup command is needed. CLI updates preserve installed tables.
54
+
47
55
  ## Share an existing video with an AI agent
48
56
 
49
57
  ```text