reelme 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# reelme
|
|
2
|
+
|
|
3
|
+
Turn your repo into launch videos for social platforms — rendered locally with [Remotion](https://www.remotion.dev), zero cloud, zero API keys.
|
|
4
|
+
|
|
5
|
+
`reelme` is the rendering engine behind the [reelme agent skill](https://github.com/RubenGlez/reelme). The skill does the thinking (it reads your repo, interviews you, and writes a `reelme.json` brief at your repo root); this CLI does the work: it scaffolds a Remotion project in a global cache and renders one video variant per publishing platform.
|
|
6
|
+
|
|
7
|
+
## Install & use
|
|
8
|
+
|
|
9
|
+
No install needed:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx reelme render
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Run it in a repo that has a `reelme.json`. To create one, use the agent skill in Claude Code, Cursor, Gemini CLI, or any [Agent Skills](https://agentskills.io)-compatible agent:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx skills add RubenGlez/reelme
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Commands
|
|
22
|
+
|
|
23
|
+
| Command | What it does |
|
|
24
|
+
|---|---|
|
|
25
|
+
| `npx reelme render` | Renders every platform selected in `reelme.json` to `./reelme-out/` |
|
|
26
|
+
| `npx reelme studio` | Opens Remotion Studio against the cached project, for previewing and tweaking |
|
|
27
|
+
| `npx reelme clean` | Removes the reelme cache (`~/.reelme/cache`) |
|
|
28
|
+
|
|
29
|
+
## How it works
|
|
30
|
+
|
|
31
|
+
- Your repo keeps only two things: `reelme.json` (the brief — commit it, it's your video's source of truth across releases) and `reelme-out/` (rendered videos; add it to `.gitignore`).
|
|
32
|
+
- The heavy Remotion project lives in `~/.reelme/cache/<project-hash>/`, scaffolded on first render and reused afterwards. Re-renders don't reinstall anything; upgrading the CLI rebuilds the scaffold automatically.
|
|
33
|
+
- Each platform you select (X, LinkedIn, YouTube, TikTok, Instagram Reel/Story/Feed, GitHub README) maps to a preset that resolves dimensions, duration ceilings, and safe areas internally — you never deal with aspect ratios. GitHub README outputs a GIF; everything else is MP4. Briefs with a `teaser` cut also get a short `<platform>-teaser.mp4` per social platform.
|
|
34
|
+
|
|
35
|
+
## Requirements
|
|
36
|
+
|
|
37
|
+
- Node.js >= 18
|
|
38
|
+
- [pnpm](https://pnpm.io) (used to install render dependencies inside the cache)
|
|
39
|
+
|
|
40
|
+
## License
|
|
41
|
+
|
|
42
|
+
MIT
|