@docyrus/animaguru 0.26.0 → 0.28.0

package/README.md

@@ -29,7 +29,7 @@ The npm package requires Node.js 24+. Its default registry is https://registry.n
 
 From this repository, `npm ci && npm run cli:build` builds the CLI and `npm run cli -- --help` runs it. `npm run cli:release` prepares the npm tarball and public Mac downloads. `npm run cli:publish` publishes that reviewed release under the Docyrus organization; publishing requires a logged-in npm account with organization access and any required 2FA. Each release needs a new version in `cli/package.json`; the CLI version is read from that file. `npm run deploy` builds release downloads before uploading the site.
 
-The command `animaguru schema` returns the Crust command schema, and `animaguru catalog` lists supported art styles, actions, asset types, models, video profiles and speech voices; `catalog --type music` (or `sprites`, `image`, `video`, `speech`, `sfx`, `avatars`) returns only that part. Shell completions: `animaguru completion zsh` (also bash and fish).
+The command `animaguru schema` returns the Crust command schema, and `animaguru catalog` lists supported art styles, actions, asset types, models, video profiles and speech voices; `catalog --type music` (or `sprites`, `image`, `vector`, `video`, `speech`, `sfx`, `model`, `avatars`) returns only that part. Shell completions: `animaguru completion zsh` (also bash and fish).
 
 ## Required updates
 
@@ -49,9 +49,17 @@ CLI 0.25.0 adds seven contemporary motion-design styles: Aurora & Glass, Liquid
 
 CLI 0.26.0 adds `npm run export:mp4 -- --watermark`: beside the clean MP4, the export saves `SLUG-LANGUAGE-watermarked.mp4` with AnimaGuru's "Made with AnimaGuru" badge, drawn with the font, logo and layout of the web app's watermark. AnimaGuru's lead pipeline uploads it as the film's preview, so a film no longer waits for a reviewer's browser to watermark it.
 
+CLI 0.27.0 adds vector assets: `--type vector` draws an editable SVG with Ideogram on fal, from a prompt (optionally following up to five saved images) or by tracing a saved image. `assets download` saves it as `.svg`. See [Vectors](#vectors).
+
+CLI 0.28.0 adds 3D model assets and real 3D shots. `assets generate --type model` builds a GLB from a saved image (`--reference SHA`) or from `--prompt` with Tripo H3.1 or Hunyuan3D 3.1 Pro, and `--rig --animations idle,walk,wave` auto-rigs a humanoid character with up to ten clips from Meshy's library. New video workspaces include three.js and the kit's `ThreeStage`, which renders a three.js scene as a layer of the Pixi film, with clips posed at absolute film time so seeking and export stay deterministic. The `animaguru-3d-models` skill covers generation, optimisation and staging.
+
+CLI 0.28.0 also adds `animaguru skills install`, which installs every AnimaGuru and PixiJS skill, the latest published on animaguru.com, into a folder for Claude Code and Codex with the open `skills` CLI. See [Install every skill](#install-every-skill).
+
+CLI 0.28.0 also adds four 3D styles in a new 3D scenes family, each with a runnable three.js study (`npm run example -- product-turntable-3d`): 3D Product Turntable, 3D Character Stage, 3D Toy Diorama and 3D Exploded Teardown. Their skills build on `animaguru-3d-models` for generated and rigged models; the studies are modelled in code.
+
 CLI 0.16.2 also installs `animaguru-art-motion` for Codex and Claude Code: one skill with 36 English art-treatment references and nine explainer motion grammars, plus AnimaGuru generation, timing, camera and review guidance. Request it explicitly for a custom film treatment; its references are separate from the gallery presets. Source coverage and the upstream MIT notice are included in the skill.
 
-CLI 0.5.2 includes a complete local PixiJS video workspace, now with 55 visual styles:
+CLI 0.5.2 includes a complete local PixiJS video workspace, now with 59 visual styles:
 
 ```sh
 animaguru templates
@@ -90,6 +98,19 @@ Available in CLI 0.3.0 and later, `init` writes the bundled skill to `.agents/sk
 
 Running `init` again refreshes an existing skill with the bundled version without a warning or confirmation (`created: false`). An identical skill is left unchanged. Skill installation happens when you explicitly run `init` or scaffold a new project with `create`. The npm and macOS packages both include the skill.
 
+### Install every skill
+
+```sh
+cd /path/to/your/project
+animaguru skills install
+```
+
+CLI 0.28.0 adds `skills install`, which installs every AnimaGuru skill (the CLI, video, style, purpose, brand, 3D and other skills) and the PixiJS skills they build on, the latest ones published on animaguru.com, whatever the CLI's version. It runs the open [skills CLI](https://github.com/vercel-labs/skills) (`npx skills@1.7.4 add https://animaguru.com/cli/skills --skill '*' --agent claude-code --agent codex --copy --yes`, with its telemetry off), which copies each skill into `.claude/skills/` for Claude Code and `.agents/skills/` for Codex, Cursor, Gemini CLI and other agents that read it, checks each download's digest, and records the source in `skills-lock.json`. Run it again, or `npx skills update --project --yes`, to refresh them; skills you added yourself are left alone. `--dir PATH` installs into another folder (created if missing). It needs `npx` (npm, with Node.js 24) and a network connection, and prints JSON listing the installed skills; the skills CLI's own progress goes to stderr.
+
+Skills describe the CLI and workspace code of their release: in a video workspace made by an older CLI, update the CLI and the workspace too, or the newest skills may name commands or kit helpers the workspace lacks.
+
+The catalog is an [Agent Skills discovery](https://agentskills.io) index at `https://animaguru.com/cli/skills/.well-known/agent-skills/index.json`, with one zip per skill. `npm run cli:release` (and so every site build) regenerates it from `cli/skills` and `cli/vendor/pixijs-skills` into `public/cli/skills/` (`scripts/skills-catalog.mjs`), and fails on a skill the skills CLI would skip, such as an unquoted description containing ": ".
+
 ## Authentication and server
 
 The default server is https://animaguru.com. Use `--url http://localhost:5190` on the leaf command or `ANIMAGURU_URL` to override it. HTTP is allowed only for loopback development. Authentication is stored separately per server in `~/.config/animaguru/credentials.json`, with file permissions 0600. Set `ANIMAGURU_CONFIG_DIR` for an isolated configuration directory. Browser login uses a ten-minute, single-use device code and receives a seven-day revocable Better Auth session. `auth login --no-browser` prints the URL for manual use. `auth logout` revokes the token. `ANIMAGURU_TOKEN` supports secret injection by agent runners; do not put tokens in arguments or commit them.
@@ -290,6 +311,23 @@ animaguru assets generate PROJECT_ID --type video --model fal/flux-3-max \
 
 `--keyframes` takes 1–10 `seconds,SHA` pairs, separated by semicolons, of this project's images or sprite art. Each is reached at its second, within `--seconds`; the clip has 24 frames a second and each keyframe needs a frame of its own. `--aspect-ratio auto` (default) follows the first keyframe, or give a ratio. FLUX 3 Max always works through the prompt before filming: `--prompt-expansion quality` asks for its thorough, slower level, any other value its light one. It takes `--seed`. Its dry runs are local estimates.
 
+### Vectors
+
+CLI 0.27.0 adds vectors: editable SVG files drawn by Ideogram on fal.ai (`fal/ideogram-vector`), for logos, icons, mascots and flat illustrations that stay sharp at any size and can be animated shape by shape.
+
+```sh
+# Draw from a prompt; --references guide the look, the first one leading.
+animaguru assets generate PROJECT_ID --type vector --name "Fox mascot" \
+  --prompt "A friendly fox mascot waving, flat colors, bold clean outlines" \
+  --quality medium --aspect-ratio 1:1 --references CHARACTER_SHEET_SHA --dry-run
+
+# Trace a saved image or sprite into shapes; it takes no prompt.
+animaguru assets generate PROJECT_ID --type vector --name "Logo" \
+  --workflow image-to-vector --source IMAGE_SHA --shapes simple --dry-run
+```
+
+`--workflow` is `text-to-vector` (default) or `image-to-vector`. From text, `--quality` is `low` (13 credits), `medium` (default, 16) or `high` (20, or 32 with references); `--aspect-ratio` is `auto` (default, the model's choice) or a ratio from 1:4 to 4:1 (`catalog --type vector` lists them); `--references` takes up to five of this project's images or sprite art of up to 10 MB each, named Image 1, Image 2… in the prompt; `--seed` repeats a result. `image-to-vector` traces `--source`, one of this project's images or sprite art of up to 50 MB, for 10 credits: `--shapes detailed` (default) keeps fine detail and `simple` uses fewer, simpler shapes. The result is saved as `image/svg+xml` and downloads as `NAME.svg`. Vectors can't be used as image or video references; trace or draw one from an image instead.
+
 Images have a full background by default; `--transparent` requests a cutout. CLI 0.17.0 adds `--references`, `--mask` and the 16:9 and 9:16 shapes. `--aspect-ratio` is 1:1 (default, 1024×1024), 3:2 (1536×1024), 2:3 (1024×1536), 16:9 (1536×864) or 9:16 (864×1536). `--references` takes up to four comma-separated blob SHAs of this project's images (including attached uploads) or sprite art, and the new image follows them: generate a character sheet once, then reference it in every scene to keep the character consistent. Refer to them in the prompt as Image 1, Image 2 and so on, and say what to take from each. Each reference adds a little to the estimate. `--mask` edits only part of Image 1, the first reference: give up to eight rectangles as `x,y,width,height` fractions of its size from the top left, separated by semicolons (`0,0,1,0.4` is the top 40%). The rest of the image is kept, and the result keeps Image 1's shape, which must be one of the five above. Gemini speech's `--prompt` is the verbatim transcript, and `--delivery` controls how it sounds without being spoken. Gemini speech supports both `gemini-3.8-flash-tts` and `gemini-3.8-flash-lite-tts`. Music uses Lyria. Google audio requires the server's `AI_PROVIDER_KEY_GOOGLE` secret; no provider keys are stored in the CLI.
 
 Preview a validated request and its estimated credits with `--dry-run`, without spending credits; most dry runs work offline without signing in:
@@ -312,7 +350,7 @@ animaguru assets submit PROJECT_ID --file speech.json --model gemini-3.8-flash-t
 
 `--model` overrides the file's model. Unrelated type-specific flags are rejected rather than ignored, and the error lists the flags that type accepts.
 
-`assets generate` and `assets submit` accept `--wait` to block until the job finishes (failing if generation fails) and `--download PATH` to wait and then save the result; `--timeout` sets the wait in seconds (default 600). A `PATH` that is an existing folder or ends in `/` receives `NAME.EXT`, named after the asset and its type (`.wav`, `.mp3`, `.png`…). The JSON output adds `job`, `asset` (`id`, `name`, `type`, `mimeType`) and `download` (`path`, `size`) to the submission receipt.
+`assets generate` and `assets submit` accept `--wait` to block until the job finishes (failing if generation fails) and `--download PATH` to wait and then save the result; `--timeout` sets the wait in seconds (default 600). A `PATH` that is an existing folder or ends in `/` receives `NAME.EXT`, named after the asset and its type (`.wav`, `.mp3`, `.png`, `.svg`…). The JSON output adds `job`, `asset` (`id`, `name`, `type`, `mimeType`) and `download` (`path`, `size`) to the submission receipt.
 
 ```sh
 animaguru assets generate PROJECT_ID --type speech --name vo-01-hook \