Companion Installation

Companions are local assets + metadata — separate from registry UI components.

Status

vinyaas companion add is not available yet. Built-in species (Ember, Soul, Moss, Flint, Bubble, Rime, Jab, Volt, Drake, Nyx) ship with the docs host today. Explore them on Companions.

bash
vinyaas companion add ember

That command is planned only. Current CLI: init, add, doctor, discovery, catalogs, and status.

Minimal manual setup

To author or vendor a companion in your own app (same shape the docs use):

  1. Create companion/<id>/ with companion.json, assets/idle.png (32×32), and animations/<clip>/N.png frames.
  2. Validate metadata against the companion.json schema (id, capabilities, interactions, animations).
  3. Register the species in your catalog (imports + clip map) and mount a companion host/provider once at the app shell.
  4. Mark perch targets with data-companion-surface.
bash
companion/nyx/
  companion.json
  assets/idle.png
  animations/idle/1.png
  animations/happy/1.png
  animations/glow/1.png
  …

Full authoring notes: Custom Companion.

What will install later

When CLI companion install ships, expect companion.json, sprites, and animation frames — not React UI primitives from the component registry.