npx remotion lambda sites

The npx remotion lambda sites command allows to create, view and delete Remotion projects in your S3 bucket.

• create
• ls
• rm
• rmall

create

npx remotion lambda sites create <entry-point>?

npx remotion lambda sites create <entry-point>?

You may pass an entry point as the first argument, otherwise the entry point will be determined.

Bundle and upload a Remotion video to an S3 bucket.

The result will be a URL such as https://remotionlambda-12345.s3.eu-central-1.amazonaws.com/sites/abcdef/index.html.

note

If you make changes locally, you need to redeploy the site. Use --site-name to overwrite an existing site.

You can use this "Serve URL" to render a video on Remotion Lambda using:

• The npx remotion lambda render and npx remotion lambda still commands
• The renderMediaOnLambda() and renderStillOnLambda() functions.
• Locally using the renderMedia() and renderStill() functions.
• Locally using the npx remotion render and npx remotion still commands

If you are rendering on Lambda, you can also pass the site Name (in this case abcdef) as an abbreviation.

Example output

(1/3) [====================] Bundled video 3975ms
(2/3) [====================] Created bucket 457ms
(3/3) [====================] Uploaded to S3 25118ms

Deployed to S3!
Serve URL: https://remotionlambda-12345.s3.eu-central-1.amazonaws.com/sites/abcdef/index.html
Site Name: abcdef

--region

The AWS region to select. Both project and function should be in this region.

--site-name

Uploads the project to a specific directory and returns a deterministic URL. If a site already existed under this name, it will be overwritten. Can only contain the following characters: 0-9, a-z, A-Z, -, !, _, ., *, ', (, )

npx remotion lambda sites create src/index.ts --site-name=my-project

npx remotion lambda sites create src/index.ts --site-name=my-project

--force-bucket-namev3.3.42

Specify a specific bucket name to be used. This is not recommended, instead let Remotion discover the right bucket automatically.

--privacyv3.3.97

Either public (default) or no-acl if you are not using ACL. Sites must have a public URL to be able to be rendered on Lambda, since the headless browser opens that URL.

--public-dirv4.0.140

Define the location of the public/ directory. If not defined, Remotion will assume the location is the `public` folder in your Remotion root.

--enable-folder-expiryv4.0.32

When deploying sites, enable or disable S3 Lifecycle policies which allow for renders to auto-delete after a certain time. Default is null, which does not change any lifecycle policies of the S3 bucket. See: Lambda autodelete.

--throw-if-site-existsv4.0.141

Prevents accidential update of an existing site. If there are any files in the subfolder where the site should be placed, the function will throw.

--disable-git-sourcev4.0.182

Disables the Git Source being connected to the Remotion Studio. Clicking on stack traces and certain menu items will be disabled.

---

ls

npx remotion lambda sites ls

npx remotion lambda sites ls

Get a list of sites. The URL that is printed can be passed to the render command to render a video.

Example output

Site Name Bucket Size Last updated
pr6fwglz05 remotionlambda-abcdefg 14.7 MB 2021-12-02
https://remotionlambda-abcdefg.s3.eu-central-1.amazonaws.com/sites/pr6fwglz05/index.html

testbed remotionlambda-abcdefg 14.7 MB 2021-12-02 

https://remotionlambda-abcdefg.s3.eu-central-1.amazonaws.com/sites/testbed/index.html

--region

The AWS region to select. Both project and function should be in this region.

--quiet, -q

Returns only a list of space-separated sites.

npx remotion lambda sites ls -q

npx remotion lambda sites ls -q

Example output

pr6fwglz05 testbed

rm

Removes a site (or multiple) from S3 by its ID.

bash
npx remotion lambda sites rm abcdef
npx remotion lambda sites rm abcdef my-project # multiple at once

bash
npx remotion lambda sites rm abcdef
npx remotion lambda sites rm abcdef my-project # multiple at once

Example output

Site abcdef in bucket remotionlambda-gc1w0xbfzl (14.7 MB): Delete? (Y/n): Y
Deleted sites/abcdef/052787b08233d85edebfc4ce4610944e.mp4
Deleted sites/abcdef/258.bundle.js
Deleted sites/abcdef/15.bundle.js
Deleted sites/abcdef/249.bundle.js.map
Deleted sites/abcdef/263.bundle.js
Deleted sites/abcdef/143.bundle.js
Deleted sites/abcdef/258.bundle.js.map
Deleted sites/abcdef/15.bundle.js.map
Deleted sites/abcdef/185.bundle.js.map
Deleted sites/abcdef/249.bundle.js
Deleted sites/abcdef/143.bundle.js.map
Deleted sites/abcdef/185.bundle.js
Deleted sites/abcdef/1f2d09019ff34eed846a5151b8561d5b.mp4
Deleted sites/abcdef/263.bundle.js.map
Deleted sites/abcdef/268.bundle.js
Deleted sites/abcdef/378.bundle.js.map
Deleted sites/abcdef/268.bundle.js.map
Deleted sites/abcdef/378.bundle.js
Deleted sites/abcdef/2b91c5234e41d3c36d4bf6df37876958.webm
Deleted sites/abcdef/450.bundle.js
Deleted sites/abcdef/46.bundle.js.map
Deleted sites/abcdef/46.bundle.js
Deleted sites/abcdef/450.bundle.js.map
Deleted sites/abcdef/534.bundle.js.map
Deleted sites/abcdef/569.bundle.js
Deleted sites/abcdef/3577958454aa99ad707b596f65151746.webm
Deleted sites/abcdef/534.bundle.js
Deleted sites/abcdef/575.bundle.js.map
Deleted sites/abcdef/575.bundle.js
Deleted sites/abcdef/569.bundle.js.map
Deleted sites/abcdef/801.bundle.js
Deleted sites/abcdef/7badbf53d3130d91b90c46181a2ecdc4.webm
Deleted sites/abcdef/801.bundle.js.map
Deleted sites/abcdef/873.bundle.js
Deleted sites/abcdef/98.bundle.js.map
Deleted sites/abcdef/bff822b868a2b87b31877f3606c9cc13.mp3
Deleted sites/abcdef/873.bundle.js.map
Deleted sites/abcdef/98.bundle.js
Deleted sites/abcdef/a2f36e3a48b4989e0da1fea9959fb35f.mp3
Deleted sites/abcdef/bundle.js
Deleted sites/abcdef/bundle.js.map
Deleted sites/abcdef/a7d87d9934059032eebb9c1536378a2a.webm
Deleted sites/abcdef/index.html
Deleted site abcdef and freed up 14.7 MB.

--region

The AWS region to select. Both project and function should be in this region.

--yes, -y

Removes a site without asking for confirmation.

npx remotion lambda sites rm abcdef -y

npx remotion lambda sites rm abcdef -y

--force-bucket-namev3.3.42

Specify a specific bucket name to be used. This is not recommended, instead let Remotion discover the right bucket automatically.

rmall

Remove all sites in the selected AWS region.

bash
npx remotion lambda sites rmall

bash
npx remotion lambda sites rmall

Example output

Site abcdef in bucket remotionlambda-gc1w0xbfzl (14.7 MB): Delete? (Y/n): Y
Deleted sites/abcdef/052787b08233d85edebfc4ce4610944e.mp4
Deleted sites/abcdef/258.bundle.js
Deleted sites/abcdef/15.bundle.js
Deleted sites/abcdef/249.bundle.js.map
Deleted sites/abcdef/263.bundle.js
Deleted sites/abcdef/143.bundle.js
Deleted sites/abcdef/258.bundle.js.map
Deleted sites/abcdef/15.bundle.js.map
Deleted sites/abcdef/185.bundle.js.map
Deleted sites/abcdef/249.bundle.js
Deleted sites/abcdef/143.bundle.js.map
Deleted sites/abcdef/185.bundle.js
Deleted sites/abcdef/1f2d09019ff34eed846a5151b8561d5b.mp4
Deleted sites/abcdef/263.bundle.js.map
Deleted sites/abcdef/268.bundle.js
Deleted sites/abcdef/378.bundle.js.map
Deleted sites/abcdef/268.bundle.js.map
Deleted sites/abcdef/378.bundle.js
Deleted sites/abcdef/2b91c5234e41d3c36d4bf6df37876958.webm
Deleted sites/abcdef/450.bundle.js
Deleted sites/abcdef/46.bundle.js.map
Deleted sites/abcdef/46.bundle.js
Deleted sites/abcdef/450.bundle.js.map
Deleted sites/abcdef/534.bundle.js.map
Deleted sites/abcdef/569.bundle.js
Deleted sites/abcdef/3577958454aa99ad707b596f65151746.webm
Deleted sites/abcdef/534.bundle.js
Deleted sites/abcdef/575.bundle.js.map
Deleted sites/abcdef/575.bundle.js
Deleted sites/abcdef/569.bundle.js.map
Deleted sites/abcdef/801.bundle.js
Deleted sites/abcdef/7badbf53d3130d91b90c46181a2ecdc4.webm
Deleted sites/abcdef/801.bundle.js.map
Deleted sites/abcdef/873.bundle.js
Deleted sites/abcdef/98.bundle.js.map
Deleted sites/abcdef/bff822b868a2b87b31877f3606c9cc13.mp3
Deleted sites/abcdef/873.bundle.js.map
Deleted sites/abcdef/98.bundle.js
Deleted sites/abcdef/a2f36e3a48b4989e0da1fea9959fb35f.mp3
Deleted sites/abcdef/bundle.js
Deleted sites/abcdef/bundle.js.map
Deleted sites/abcdef/a7d87d9934059032eebb9c1536378a2a.webm
Deleted sites/abcdef/index.html
Deleted site abcdef and freed up 14.7 MB.

--region

The AWS region to select. Both project and function should be in this region.

--yes, -y

Removes all sites without asking for confirmation.

npx remotion lambda sites rmall -y

npx remotion lambda sites rmall -y

--force-bucket-namev3.3.42

Specify a specific bucket name to be used. This is not recommended, instead let Remotion discover the right bucket automatically.