Skip to content

AGENTS.md

Latest commit

 

History

History
67 lines (44 loc) · 2.81 KB

AGENTS.md

File metadata and controls

67 lines (44 loc) · 2.81 KB

Setup commands

# Install dependencies (uses Bun)
bun install

# Build all packages
bunx turbo run make

# Run tests and linting
bunx turbo run lint test

# Clean build artifacts
bun run clean

# Build a specific package
bunx turbo run make --filter='<package-name>'

Use bunx (not npx) to run package binaries.

The current Remotion version can be found in packages/core/src/version.ts. The next version should increment the patch version by 1.

Pull request titles should be in the format \[package-name]`: [commit-message]. For example, "@remotion/player: Add new feature.

Before committing

If committing your work:

  1. Run bun run build from the root of the repo to verify all packages build successfully
  2. Run bun run stylecheck to ensure CI passes
  3. Include bun.lock when dependencies change

Contributing

Read the full contribution guide.

Cloud Agents specific instructions

Runtime

Bun v1.3.3 is the required package manager and test runner. It is installed at ~/.bun/bin/bun. Ensure ~/.bun/bin is on PATH (the update script handles this).

Key services

  • Remotion Studio (dev testbed): cd packages/example && bun run dev — starts at http://localhost:3000. This is the main dev UI for previewing video compositions.
  • Player testbed: cd packages/player-example && bun run dev — for testing @remotion/player changes.
  • Docs site: cd packages/docs && bun run start — Docusaurus dev server.

Rendering test videos

From packages/example:

  • bunx remotion compositions — list available compositions.
  • bunx remotion render <comp-id> --output ../../out/video.mp4 — render a video.
  • bunx remotion still <comp-id> --output ../../out/still.png — render a still image.

Known caveats

  • @remotion/lambda-go lint requires Go >= 1.23.0. The VM ships Go 1.22.2, so that package's lint will fail. This is optional and doesn't affect core development.
  • @remotion/openai-whisper tests require OPENAI_API_KEY env var. Without it, 1 test fails. This is expected and non-blocking.
  • The Remotion Studio (bun run dev in packages/example) sometimes reports "Already running on port 3000" if a previous instance is still bound. Check with curl http://localhost:3000 before assuming it failed.
  • After bun install, always run bun run build before running tests or starting the Studio, as many packages depend on built artifacts from other packages.
  • The prepare script in root package.json sets git hooks path to .githooks. The pre-commit hook runs bun pre-commit.ts for formatting.