@higgsfield/video-editor-mcp 1.1.0 → 2.0.0

package/README.md

@@ -1,38 +1,75 @@
 # Higgsfield Video Editor
 
-Edit and render video projects on your Mac with the Higgsfield Video Editor plugin for the ChatGPT
-desktop app. Arrange clips, text, audio and motion graphics, preview the timeline, and render a video.
-The package includes the local MCP server, the editor, Higgsedit and the editing skills.
+Edit videos with ChatGPT on your Mac. Say what you want: cut the clips, add a title, caption the speech, put
+music under it, animate the text. The edit opens in the Video Editor panel inside the chat and updates as you
+talk. You can scrub, trim and tweak there too. When it is right, export an MP4.
 
-Requires macOS and Node.js 22.12 or later. Chrome is downloaded on the first render.
+Your footage and projects stay on your Mac. Only image and video generation, if you use it, goes through your
+Higgsfield account.
+
+## Install
+
+You need macOS, the ChatGPT desktop app, Node.js 22.12 or newer and ffmpeg (`brew install node ffmpeg`).
+
+```sh
+npx @higgsfield/video-editor-mcp install
+```
+
+Then start a new chat, type `@` and pick **Higgsfield Video Editor**. No restart needed. Headless Chrome
+(about 100 MB) downloads on the first preview or export.
+
+## Use it
+
+Try, with the mention in front:
+
+- "@Higgsfield Video Editor Create a vertical video project with an animated title and music."
+- "@Higgsfield Video Editor Trim the dead air in ~/Movies/trip, caption the interview and add a lower third at 0:06."
+- "@Higgsfield Video Editor Export it, then a 1:1 version for the feed."
+
+A project is a folder under Movies, Documents or Downloads: `index.tsx` is the edit, `media/` holds your
+footage, exports land in `renders/`. Set `HIGGSEDIT_PROJECT_ROOTS` (folders separated by `:`) to allow other
+locations.
+
+## Updates
+
+The editor checks npm for a newer version once an hour, in the background, and uses it from the next new chat.
+To update now, run the install line again; a new chat has the update. **Edit video → Settings → Check for updates…** in the panel
+shows the running version. `VIDEO_EDITOR_AUTO_UPDATE=0` in the server's environment turns the background
+check off.
+
+## Other MCP clients
+
+The same install serves Claude Code, Claude Desktop and the Codex CLI. This prints the server entry, with
+absolute paths so it works whatever your PATH holds:
 
 ```sh
-dir="$HOME/.higgsfield/video-editor-mcp"
-npm install --prefix "$dir" --registry=https://registry.npmjs.org/ --ignore-scripts --no-audit --no-fund @higgsfield/video-editor-mcp@latest
-cli="$dir/node_modules/@higgsfield/video-editor-mcp/dist/cli.mjs"
-node "$cli" doctor
-node "$cli" install-plugin
+npx @higgsfield/video-editor-mcp config
 ```
 
-Reload the desktop app to discover the skills, then start a new chat for the tools. Keep the installed
-package on disk: the plugin launches that persistent copy. `install-codex` registers only the MCP
-server, and `config` prints the entry for another MCP client.
+The project knowledge ships with the tools, so those clients need no plugin.
 
-Image and video generation requires connecting your Higgsfield account. The first generation call
-opens the browser to sign in; credentials stay in `~/.higgsfield/mcp-auth`.
+## When something is off
+
+```sh
+npx @higgsfield/video-editor-mcp doctor
+```
+
+checks Node, ffmpeg, the bundled `higgsedit` CLI, the server and the panel, and shows the last update check.
+In a chat, ask the editor to run its diagnostics.
+
+## Remove
+
+```sh
+npx @higgsfield/video-editor-mcp uninstall
+```
 
-Projects must be under `~/Movies`, `~/Documents` or `~/Downloads`. `HIGGSEDIT_PROJECT_ROOTS` overrides
-these locations with a list separated by `:`.
+removes the plugin from ChatGPT and the installed package. Your projects stay where they are.
 
-The launcher checks npmjs for updates in the background at startup, at most once per hour. Prereleases
-follow `next`; stable installations follow `latest`. Updates install an exact version with lifecycle
-scripts disabled and pass the package's doctor before activation. Active chats keep their version.
-Reload the app for updated skills and start a new chat to use the new editor.
+## Under the hood
 
-The **Edit video → Settings → Check for updates…** menu item shows the running version and any
-prepared update. **Check for updates**, or `node "$cli" update`, forces a check. Offline or failed checks keep the installed version.
-`VIDEO_EDITOR_AUTO_UPDATE=0` disables background checks. `VIDEO_EDITOR_UPDATE_CHANNEL=next` or `latest`
-selects the channel. Public update state lives in `~/.higgsfield/video-editor-mcp/public-updates/`.
+The package is a local MCP server over stdio. It bundles [`@higgsfield/higgsedit`](https://www.npmjs.com/package/@higgsfield/higgsedit),
+the command-line video editor, and starts `higgsedit dev` for each open project. That server holds the project,
+applies edits to `index.tsx` by element id, renders frames and MP4s with headless Chrome and ffmpeg, and serves
+the editor panel. The chat's tools and the panel talk to the same server, so they share one undo history.
 
-Proprietary: see `LICENSE`. Bundled open source software and fonts are covered by
-`THIRD_PARTY_NOTICES.md`.
+Proprietary: see `LICENSE`. Bundled open source software and fonts are listed in `THIRD_PARTY_NOTICES.md`.