Skip to content

README.md

Latest commit

 

History

History
58 lines (40 loc) · 1.49 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.49 KB

IronClaw Architecture Overview Video

A Remotion-based animated video that walks new contributors through IronClaw's internals — the five primitives, execution loop, CodeAct, thread state machine, skills pipeline, tool dispatcher, channels, extensibility traits, and the LLM provider decorator chain.

See the project-level render script and Claude skill for end-to-end use:

  • scripts/render-architecture-video.sh — one-command MP4 render
  • .claude/skills/architecture-video/SKILL.md — how to update scenes when architecture changes

Commands

Install dependencies (first time only):

npm ci

Preview in browser (Remotion Studio with hot reload):

npm run dev

Render to MP4 from this directory:

npx remotion render IronClawArchitecture out.mp4

Or from the repository root:

./scripts/render-architecture-video.sh output.mp4

Type-check and lint:

npm run lint

Structure

  • src/IronClawArchitecture.tsx — scene sequencing, durations, transitions
  • src/scenes/*.tsx — one file per scene (12 total)
  • src/components/Code.tsx — shared syntax-highlighted code block
  • src/theme.ts — shared colors and fonts
  • src/Root.tsx — Remotion composition registration

License

This video project is part of IronClaw and dual-licensed MIT OR Apache-2.0. Remotion itself has a custom license; use is covered under the open-source free tier for this project.