npx remotion cloudrun still
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.
Using the npx remotion cloudrun still command, you can render an image on GCP.
The structure of a command is as follows:
- The serve URL is obtained by deploying a Remotion project to a GCP Storage Bucket using the
sites createcommand or callingdeployService(). - The still ID. If not specified, the list of compositions will be fetched and you can choose a composition.
- The
output-locationparameter is optional. If you don't specify it, the image is stored in your Cloud Storage bucket. If you specify a location, it gets downloaded to your device in an additional step.
Example commands
Rendering a still, passing the service name:
Using the site name as opposed to the full serve-url:
Passing in input props:
Flags
--region
The GCP region to select. For lowest latency, the service, site and output bucket should be in the same region.
--props
React Props to pass to the root component of your still. Must be a serialized JSON string (--props='{"hello": "world"}') or a path to a JSON file (./path/to/props.json).
--privacy
One of:
"public"(default): The rendered still is publicly accessible under the Cloud Storage URL."private": The rendered still is not publicly available, but is available within the GCP project to those with the correct permissions.
--force-bucket-name
Specify a specific bucket name to be used for the output. The resulting Google Cloud Storage URL will be in the format gs://{bucket-name}/renders/{render-id}/{file-name}. If not set, Remotion will choose the right bucket to use based on the region.
--jpeg-quality
Value between 0 and 100 for JPEG rendering quality. Doesn't work when a PNG is rendered.
--image-format
jpeg or png - JPEG is faster, but doesn't support transparency. The default image format is jpeg.
--scale
Scales the output frame by the factor you pass in. For example, a 1280x720px frame will become a 1920x1080px frame with a scale factor of 1.5. Vector elements like fonts and HTML markups will be rendered with extra details.
--env-file
Specify a location for a dotenv file - Default .env. Read about how environment variables work in Remotion.
--out-name
The file name of the still output as stored in the Cloud Storage bucket. By default, it is out plus the appropriate file extension, for example: out.png. Must match /([0-9a-zA-Z-!_.*'()/]+)/g.
--cloud-run-url
Specify the url of the service which should be used to perform the render. You must set either cloud-run-url or service-name, but not both.
--service-name
Specify the name of the service which should be used to perform the render. This is used in conjunction with the region to determine the service endpoint, as the same service name can exist across multiple regions. You must set either cloud-run-url or service-name, but not both.