halfsize
Compress any video to an exact size (25 MB, 10 MB, ...) locally with FFmpeg, then prove the quality with VMAF/SSIM. One command, no upload, no account.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 11 Nov 2026.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/YKLovePython/halfsize with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/YKLovePython/halfsize'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/yklovepython--halfsize)HTML
<a href="/listings/yklovepython--halfsize"><img src="/api/listings/yklovepython--halfsize/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
Requires [Node.js 18+](https://nodejs.org). FFmpeg is bundled on first install; if it cannot be downloaded, `halfsize` uses your system install instead.
# compress to a size npx halfsize video.mp4 --to 25mb # or just name the app you are uploading to npx halfsize video.mp4 --for discord # several files in one go npx halfsize clip1.mp4 clip2.mp4 clip3.mp4 --to 10mb # smaller file, same quality budget npx halfsize video.mp4 --to 10mb --codec h265 # quality-first mode when size does not matter npx halfsize video.mp4 --crf 23 # preview the plan without encoding npx halfsize video.mp4 --to 25mb --dry-run # machine-readable, for scripts npx halfsize video.mp4 --to 25mb --json
Install it globally if you will use it more than once:
npm install -g halfsize
The local web app
npx halfsize --web
Opens `http://127.0.0.1:4174` — drag a video in, pick 25 MB / 10 MB / 20 MB / 5 MB or type your own limit, and watch the encode. The file goes to a temporary folder **on your own machine**; nothing is sent anywhere.
<p align="center"> </p>
After each run you can download a **share card** (the image at the top of this README) with the real numbers on it.
Use it from an agent
The repo ships a skill in [`skills/halfsize/SKILL.md`](skills/halfsize/SKILL.md). Drop that folder into your agent's skills directory (for Claude Code: `.claude/skills/halfsize/`) and the agent can turn "make this fit in 25 MB" into a compression plus a measured quality report, instead of guessing a bitrate.
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 438 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- <p align="center">
- <img src="https://raw.githubusercontent.com/YKLovePython/halfsize/main/docs/card.webp" width="760" alt="halfsize: 23.2 MB to 1.99 MB, 12x smaller, VMAF 84.4">
- </p>
- <h1 align="center">halfsize</h1>
- <p align="center">
- <b>Compress any video to any size. Locally. And keep the quality.</b>
- </p>
- <p align="center">
- <a href="https://www.npmjs.com/package/halfsize"><img alt="npm" src="https://img.shields.io/npm/v/halfsize?color=b6f36a"></a>
- <a href="https://www.npmjs.com/package/halfsize"><img alt="downloads" src="https://img.shields.io/npm/dm/halfsize?color=b6f36a"></a>
- <a href="LICENSE"><img alt="license" src="https://img.shields.io/badge/license-MIT-b6f36a"></a>
- <a href="https://github.com/YKLovePython/halfsize/actions/workflows/test.yml"><img alt="tests" src="https://github.com/YKLovePython/halfsize/actions/workflows/test.yml/badge.svg"></a>
- <img alt="node" src="https://img.shields.io/badge/node-%3E%3D18-b6f36a">
- <img alt="no upload" src="https://img.shields.io/badge/upload-none-b6f36a">
- </p>
- <p align="center">
- <a href="README.zh-CN.md">中文说明</a> ·
- <a href="https://YKLovePython.github.io/halfsize/">Website & guides</a> ·
- <a href="#quick-start">Quick start</a> ·
- <a href="#how-it-works">How it works</a> ·
- <a href="#faq">FAQ</a>
- </p>
- <p align="center">
- <sub>As featured in <a href="https://www.ruanyifeng.com/blog/2026/11/weekly-issue-418.html">阮一峰《科技爱好者周刊》第 418 期</a> · 2,500+ downloads on npm</sub>
- </p>
- <p align="center">
- <b>New in 0.1.11:</b> <code>--fix</code> repairs an install where npm silently skipped the
- FFmpeg download, and <code>--mcp</code> turns the same command into a tool for Claude Code,
- Cursor and VS Code. Neither one sends your video anywhere.
- <a href="https://github.com/YKLovePython/halfsize/releases/tag/v0.1.11">Release notes</a>
- </p>
- ---
- WeChat and Discord both stop at **20 MB**. Email chokes around the same.
- So you open a video editor, guess a bitrate, export, check the size, export again, and still
- can't tell whether the picture got worse.
- `halfsize` turns that into one command:
- ```bash
- npx halfsize wedding.mp4 --to 25mb
- ```
- It computes the bitrate, picks the resolution that actually fits, encodes twice, then measures
- the result with **SSIM** and **VMAF** so you know whether it still looks the same.
- ```
- halfsize 0.1.11
- source.mp4
- 23.2 MB 8s 1920x1080 30.00 fps h264
- target 2.00 MB
- plan H.264 960x540 1.81 Mbps audio 128 kbps 2-pass
- scale 1920x1080 -> 960x540
- estimate 1.94 MB (12x smaller)
- output source.2mb.mp4
- measuring quality done in 1s
- 23.2 MB -> 1.99 MB 12x smaller 0.4% under target
- VMAF 84.4 SSIM 0.968 slight softening
- -> C:\Videos\source.2mb.mp4
- ```
- ## Why this exists
- "Make it smaller" is a solved problem. **"Make it fit in exactly 20 MB, and tell me if it
- still looks right"** is the part every tool makes you guess at.
- - HandBrake is excellent, but it asks you to think in codecs, RF values, and presets.
- - Online compressors work until you remember you just uploaded a private video to a stranger.
- - `ffmpeg` can do all of this. Nobody remembers the 11 flags, and almost nobody checks VMAF afterwards.
- `halfsize` is the missing 5%: a target size you type, and a quality score you can read.
- | | halfsize | HandBrake | Online compressors |
- |---|---|---|---|
- | Fit an exact size | ✅ one flag | manual bitrate math | usually re-encodes blindly |
- | Tells you the quality cost | ✅ VMAF + SSIM | ❌ | ❌ |
- | Your file stays on your machine | ✅ | ✅ | ❌ |
- | Scriptable / CI friendly | ✅ CLI + JSON | ❌ GUI | ❌ |
- | Learns a new UI | no | yes | yes |
- ## Quick start
- Requires [Node.js 18+](https://nodejs.org). FFmpeg is bundled on first install; if it cannot
- be downloaded, `halfsize` uses your system install instead.
- ```bash
- # compress to a size
- npx halfsize video.mp4 --to 25mb
- # or just name the app you are uploading to
- npx halfsize video.mp4 --for discord
- # several files in one go
- npx halfsize clip1.mp4 clip2.mp4 clip3.mp4 --to 10mb
- # smaller file, same quality budget
- npx halfsize video.mp4 --to 10mb --codec h265
- # quality-first mode when size does not matter
- npx halfsize video.mp4 --crf 23
- # preview the plan without encoding
- npx halfsize video.mp4 --to 25mb --dry-run
- # machine-readable, for scripts
- npx halfsize video.mp4 --to 25mb --json
- ```
- Install it globally if you will use it more than once:
- ```bash
- npm install -g halfsize
- ```
- ### In CI
- The same compression runs in GitHub Actions, and the quality report lands in the build log:
- ```yaml
- - uses: YKLovePython/halfsize-action@v1
- with:
- files: artifacts/recording.mp4
- args: --to 20mb
- ```
- [halfsize-action on the GitHub Marketplace](https://github.com/marketplace/actions/halfsize-compress-video-to-an-exact-size).
- ### The local web app
- ```bash
- npx halfsize --web
- ```
- Opens `http://127.0.0.1:4174` — drag a video in, pick 20 MB / 16 MB / 5 MB or type
- your own limit, and watch the encode. The file goes to a temporary folder **on your own
- machine**; nothing is sent anywhere.
- <p align="center">
- <img src="https://raw.githubusercontent.com/YKLovePython/halfsize/main/docs/screenshot.webp" width="860" alt="halfsize local web app showing 23.2 MB compressed to 1.99 MB with VMAF 84.4">
- </p>
- After each run you can download a **share card** (the image at the top of this README) with the
- real numbers on it.
- Step-by-step guides with measured quality numbers:
- [Discord 20 MB](https://YKLovePython.github.io/halfsize/discord/) ·
- [WhatsApp 16 MB](https://YKLovePython.github.io/halfsize/whatsapp/) ·
- [WeChat 20 MB](https://YKLovePython.github.io/halfsize/wechat/) ·
- [email attachments](https://YKLovePython.github.io/halfsize/email/) ·
- [X / Twitter](https://YKLovePython.github.io/halfsize/twitter/) ·
- [any 20 MB limit](https://YKLovePython.github.io/halfsize/20mb/) ·
- [FFmpeg target size](https://YKLovePython.github.io/halfsize/ffmpeg-compress-to-size/) ·
- [compress without uploading](https://YKLovePython.github.io/halfsize/offline/).
- ### Which size do I need?
- | Where it is going | The cap | Command |
- |---|---|---|
- | Discord (free) | 20 MB per file | `--for discord` |
- | WeChat chat video | 20 MB | `--for wechat` |
- | WhatsApp, sent as media | 16 MB | `--for whatsapp` |
- | Gmail attachment | 25 MB message → 18 MB file | `--for gmail` |
- | Outlook / corporate mail | 20 MB message → 15 MB file | `--for outlook` |
- | X / Twitter | 512 MB | `--for twitter` |
- | Anything else | whatever you type | `--to 700mb` |
- The email rows are smaller on purpose: base64 makes the attachment about 37% bigger than the
- file, so an 18 MB MP4 is what fits in a 25 MB message. Caps change; `--to` always overrides the
- preset. Full table, with what each cap counts and the measured VMAF at each size:
- [size limits by platform](https://YKLovePython.github.io/halfsize/file-size-limits/) ·
- [every target size explained](https://YKLovePython.github.io/halfsize/compress-video-to-size/) ·
- [video size calculator](https://YKLovePython.github.io/halfsize/video-size-calculator/).
- ### Use it from an agent
- The repo ships a skill in [`skills/halfsize/SKILL.md`](skills/halfsize/SKILL.md). Install it with
- the [skills CLI](https://skills.sh) so Claude Code, Codex, Cursor, OpenCode and the rest pick it
- up automatically:
- ```bash
- npx skills add YKLovePython/halfsize
- ```
- Or copy the folder into your agent's skills directory by hand (for Claude Code:
- `.claude/skills/halfsize/`). Either way the agent can turn "make this fit in 25 MB" into a
- compression plus a measured quality report, instead of guessing a bitrate.
- If your client speaks MCP instead, halfsize is also a single-tool MCP server:
- ```json
- {
- "mcpServers": {
- "halfsize": { "command": "npx", "args": ["-y", "halfsize", "--mcp"] }
- }
- }
- ```
- That gives the agent one tool, `compress_video(input, target, output?, codec?, verify?)`,
- backed by the same CLI and the same JSON report. It is stdio only: no port, no daemon,
- nothing listening. Per-client setup (Claude Code, Claude Desktop, Cursor, VS Code) is on
- [MCP server](https://YKLovePython.github.io/halfsize/mcp/).
- ## How it works
- 1. **Probe.** Read duration, resolution, frame rate, audio bitrate, rotation, and HDR metadata.
- 2. **Budget.** Total bitrate = target bytes × 8 ÷ duration, minus audio, minus a small
- container overhead.
- 3. **Pick a resolution.** Walk a ladder from the source size down to 240p and choose the
- largest one whose pixels fit the budget at that codec's bits-per-pixel target
- (H.264: 0.072 bpp, H.265: 0.045 bpp). This is why a 12× shrink still looks reasonable:
- the encoder gets to spend its bits on fewer pixels.
- 4. **Encode twice.** Two-pass ABR with `libx264` or `libx265`. Pass one learns where the bits
- are needed; pass two spends them. Output is `yuv420p`, AAC audio, `+faststart`, and tagged
- `hvc1` for H.265 so it plays on Apple devices. HLG/PQ sources are tone-mapped to SDR BT.709
- in the same pass; without that, 8-bit pixels keep their HDR tags and look grey.
- 5. **Prove it.** Sample three points in the video, compute SSIM at each, and VMAF at the
- midpoint. Compare against thresholds and print a verdict in plain language.
- ```
- VMAF ≥ 95 indistinguishable
- VMAF ≥ 90 looks the same
- VMAF ≥ 80 slight softening
- VMAF ≥ 70 visible loss
- below 70 clearly degraded
- ```
- VMAF is Netflix's perceptual metric; it correlates with human judgement far better than PSNR
- or bitrate. It is not magic, but it is a much better answer than "trust me".
- ## What each size costs
- Same 60-second 1080p clip, default settings, measured on a normal laptop:
- | Target | Output | Resolution | Video bitrate | VMAF | Verdict |
- |---|---|---|---|---|---|
- | 20 MB | 19.45 MB | 1280×720 | 2.46 Mbps | 88.3 | slight softening |
- | 16 MB | 15.59 MB | 960×540 | 1.94 Mbps | 84.8 | slight softening |
- | 10 MB | 9.77 MB | 960×540 | 1.17 Mbps | 82.9 | slight softening |
- | 5 MB | 4.93 MB | 640×360 | 0.55 Mbps | 72.0 | visible loss |
- Source: 60 s, 1920×1080, 30 fps, 18 Mbps H.264 (136 MB). VMAF is measured against the
- source at the midpoint, SSIM at three points. Real numbers move with content: a talking head
- does much better than confetti.
- At 20 MB the tool picked 720p on purpose. Sixty seconds of 1080p at 2.4 Mbps looks worse than
- 720p at the same bits. `--no-downscale` overrides that, and `--codec h265` buys roughly 30%
- more quality at the same size if your player supports it.
- ## CLI reference
- ```
- halfsize <file> [options]
- --to <size> Target size: 25mb, 700k, 1.5gb
- --for <app> Target cap for discord, whatsapp, wechat, gmail, outlook, email, twitter
- --crf <n> Quality mode instead of size mode (18 best, 23 balanced, 28 small)
- --codec <name> h264 (default, maximum compatibility) or h265 (about 30% smaller)
- --preset <name> ultrafast .. veryslow (default: medium)
- --out <file> Output path
- --no-audio Drop the audio track
- --no-verify Skip SSIM/VMAF
- --no-downscale Never reduce resolution (the target may then be missed)
- --force Encode even when the target is below the minimum for this duration
- --json Machine-readable result
- --dry-run Print the plan, do not encode
- --web Start the local web app
- --port <n> Port for the web app (default 4174)
- --doctor Show which FFmpeg and encoders were found
- --fix Download FFmpeg when npm skipped it
- --mcp Run as an MCP server on stdio (for AI agents)
- -h, --help Help
- -v, --version Version
- ```
- Sizes accept `b`, `k`/`kb`, `m`/`mb`, `g`/`gb`, with or without a space. No unit means MB.
- `--for` uses the current free-tier caps (checked November 2026): `discord` 20 MB,
- `whatsapp` 16 MB, `wechat` 20 MB, `gmail`/`email` 18 MB, `outlook` 15 MB, `twitter`
- 512 MB. Email caps apply to the base64-encoded message, so an 18 MB file is the largest
- that stays under Gmail's 25 MB. Caps change, so `--to` always overrides.
- Exit codes: `0` success, `1` error. `--json` returns the plan, the measured quality, and the
- target accuracy, which makes it easy to wrap in a script.
- ## Install notes
- Needs Node.js 18 or newer. The first `npx` run downloads both the package and a
- prebuilt FFmpeg, so it can pause for a minute. If you will use it more than once,
- install it globally and skip that wait on every run:
- ```bash
- npm install -g halfsize
- halfsize video.mp4 --to 25mb
- ```
- If `npx` keeps starting an old cached version, pin it: `npx halfsize@latest ...`.
- `ffmpeg-static` downloads a prebuilt FFmpeg during `npm install`; FFprobe ships inside
- `ffprobe-static`, so it needs no download. If you are behind a proxy or a TLS-inspecting
- network, that download can silently fail and leave you with a CLI that starts but cannot
- encode. One command repairs it, without reinstalling anything:
- ```bash
- npx halfsize@latest --fix
- ```
- `--fix` fetches the same published FFmpeg and FFprobe builds, checks each download against
- the sha256 that `ffmpeg-static` published, and keeps them in a user-level cache
- (`%LOCALAPPDATA%\halfsize\Cache\bin`, `~/Library/Caches/halfsize/bin`, or
- `~/.cache/halfsize/bin`). Every later run, global or `npx`, finds them there. It tries GitHub
- first and falls back to the npmmirror binary mirror, which is fast in mainland China.
- Two alternatives if the download itself is blocked:
- ```bash
- # use the npmmirror binary mirror (fast in mainland China)
- FFMPEG_BINARIES_URL=https://registry.npmmirror.com/-/binary/ffmpeg-static npx halfsize video.mp4 --to 25mb
- # or an FFmpeg already on disk
- HALFSIZE_FFMPEG=/path/to/ffmpeg HALFSIZE_FFPROBE=/path/to/ffprobe npx halfsize video.mp4 --to 25mb
- ```
- If npm says `unable to verify the first certificate`, a proxy or antivirus is inspecting
- TLS. On Node 22.15+ use the system certificate store:
- ```powershell
- $env:NODE_OPTIONS="--use-system-ca"; npx halfsize video.mp4 --to 25mb
- ```
- A failed binary download no longer aborts the install: halfsize still starts and prints the
- `--fix` command. On Windows, `winget install Gyan.FFmpeg` is enough. On macOS,
- `brew install ffmpeg`. On Debian/Ubuntu, `sudo apt install ffmpeg`. Run
- `npx halfsize --doctor` to see what was found.
- ## FAQ
- **Does my video get uploaded?**
- No. Compressing a video never touches the network: the only outbound request halfsize ever
- makes is `--fix` downloading FFmpeg itself when npm skipped it. The web app talks only to
- `127.0.0.1`, and uploaded files go to a temp directory that is deleted when the process exits.
- **How do I get a video under Discord's 20 MB limit?**
- `npx halfsize clip.mp4 --for discord` targets the free-tier cap (20 MB as of late 2026) and
- writes a normal MP4 that plays in Discord's preview. Long 1080p clips usually come out at 720p;
- that resolution drop is what buys the size.
- **WeChat says the video is too large. What now?**
- `npx halfsize clip.mp4 --for wechat` targets the 20 MB chat-video cap. If you need it smaller
- still, pass `--to 10mb` (or any size) instead.
- **How many minutes of video fit in 20 MB?**
- About two minutes at 1.2 Mbps, which is normal 720p. Five minutes only works at 400 kbps
- (low-motion 540p), and ten minutes leaves 133 kbps — that is a slideshow, not video. Since 0.1.9
- the tool does that arithmetic before encoding and reports the smallest size the duration can hold,
- so you find out in a second instead of ten minutes.
- **Why does my iPhone video turn grey after compressing?**
- Because it is HDR. iPhone 12 and later record HLG by default, and older tools re-encode those
- values as ordinary 8-bit video while keeping the HDR tag, so players show it flat and washed out.
- halfsize detects HLG and PQ and converts to SDR BT.709 inside the same encode pass, including the
- quality measurement, so the output looks like what you saw on the phone. On a version before 0.1.9,
- upgrade instead of tuning bitrate.
- **Why did it lower my resolution?**
- Because 20 MB of 4K is not enough bits to look good. Lowering resolution and keeping the
- bitrate per pixel sane almost always looks better than keeping 4K and starving it. Use
- `--no-downscale` if you want to override that.
- **Why is the output slightly under the target, not exactly on it?**
- Container overhead and two-pass ABR both vary a little. `halfsize` aims ~3% under so it never
- overshoots a hard platform cap. In the example above it landed 0.4% under.
- **H.264 or H.265?**
- H.264 plays everywhere, including old Android phones and browsers. H.265 is roughly 30% smaller
- at the same quality but can be awkward in some editors and older hardware. Default is H.264.
- **Does it work on Windows / macOS / Linux?**
- Yes. It is plain Node.js and FFmpeg.
- **Can I batch a folder?**
- Yes. List the files, or let your shell expand them:
- ```bash
- npx halfsize *.mp4 --to 25mb
- ```
- Each file gets its own plan and verdict, a failure does not stop the rest, and `--json` returns
- `{ "files": [ ... ] }`. `--out` is allowed only when there is a single input.
- **Why "halfsize"?**
- Because the honest answer to "how much smaller will it get?" is usually "about half, or a lot
- more than half". The tool reports the real number either way.
- ## Roadmap
- - Hardware encoding (NVENC / QSV / VideoToolbox) as an opt-in fast path
- - A folder watcher that compresses new files as they appear
- - Subtitle and multiple audio track passthrough
- - AV1 (`libsvtav1`) when the source is already AV1-friendly
- - A single-file binary, so Node.js is not required
- If you want one of these, open an issue and say which. Pull requests are welcome; see
- [CONTRIBUTING.md](CONTRIBUTING.md).
- ## Development
- ```bash
- git clone https://github.com/YKLovePython/halfsize.git
- cd halfsize
- npm install
- npm test
- node bin/halfsize.mjs --web
- ```
- The test suite includes a real end-to-end encode: it generates a clip with FFmpeg, compresses
- it to a target, probes the output, and asserts the size and SSIM. No fixtures in the repo.
- ## License
- MIT. Use it, fork it, ship it.
- See [CHANGELOG.md](CHANGELOG.md) for what changed.
- ---
- If `halfsize` saved you from guessing a bitrate, a star helps the next person find it.
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.