@remotion/cloudrun

EXPERIMENTAL

Cloud Run is in Alpha, which means APIs may change in any version and documentation is not yet finished. See the changelog to stay up to date with breaking changes.

npm

npm i --save-exact @remotion/cloudrun@4.0.148

npm i --save-exact @remotion/cloudrun@4.0.148

yarn

pnpm i @remotion/cloudrun@4.0.148

pnpm i @remotion/cloudrun@4.0.148

pnpm

bun i @remotion/cloudrun@4.0.148

bun i @remotion/cloudrun@4.0.148

bun

yarn --exact add @remotion/cloudrun@4.0.148

yarn --exact add @remotion/cloudrun@4.0.148

This assumes you are currently using v4.0.148 of Remotion.
Also update remotion and all `@remotion/*` packages to the same version.
Remove all ^ character in front of the version numbers of it as it can lead to a version conflict.

See the setup guide for complete instructions on how to get started.

APIs

The following Node.JS are available:

getServiceInfo()

Gets information about a service

deployService()

Create a new service in GCP Cloud Run

deleteService()

Delete a service in GCP Cloud Run

getServices()

Lists available Remotion Cloud Run services

speculateServiceName()

Speculate a service name based on its configuration

getRegions()

Get all available regions

deploySite()

Bundle and upload a site to Cloud Storage

deleteSite()

Delete a bundle from Cloud Storage

getSites()

Get all available sites from Cloud Storage

getOrCreateBucket()

Ensure a Remotion Cloud Storage bucket exists

renderMediaOnCloudrun()

Trigger a video or audio render

renderStillOnCloudrun()

Trigger a still render

testPermissions()

Ensure permissions are correctly set up in GCP

CLI

See here for a list of CLI commands.