Showreel Studio Help
Help · Keeping films up to date

Check on a schedule

Run freshness checks every night or on every merge, so stale films are found and recorded again without anyone remembering.

showreel fresh is built to run unattended. Signed in, it sends each result to the web app, and it ends with a failure when a film is out of date, so a schedule or a build pipeline can act on it.

How it reports

  • Each result goes to the service, so the web app marks stale films app changed.
  • The command exits with code 1 when a film is still out of date at the end of the run, or could not be checked. Otherwise it exits with 0.

Nightly on a Mac

Schedule this with launchd or cron, in the folder that holds your project:

cd ~/films && showreel fresh --recut --share

The Mac must be awake, signed in to Showreel Studio, and able to reach the app.

On every merge

You can run the same command in a build pipeline, such as GitHub Actions, against a preview of the app. The runner needs:

  • What a Mac running Showreel Studio needs: see What you need.
  • The Showreel Studio CLI installed. See Install Showreel Studio.
  • A sign-in. Copy the ~/.showreel/auth.json of an account into the runner's home folder from a secret. The sign-in lasts 30 days, so renew the secret before then.
  • The service's address, in the SHOWREEL_CORE environment variable.

Then run, in the project folder:

showreel fresh --all --recut --share

What next