Skip to main content
Run as npx clayzo@latest init in a project that doesn’t have Clayzo yet. It detects npm, pnpm, Yarn or Bun from the lockfile, installs @clayzo/animation and the chosen player as dependencies, installs the clayzo CLI for your whole machine or as a dev dependency, all at one matching version, and runs npx skills add clayzo/agent-skills to install the two agent skills.

Options

Prompts

With a terminal and no --renderer, init asks whether to also install the CanvasKit player (default no). With skills enabled it asks whether to install them (default yes). Without --global or --local, it then asks whether to install the CLI for your whole machine (default yes). It skips that question when the project already has clayzo as a dependency, which it keeps and updates, and when the clayzo running init is already installed for your machine. The skills installer may then ask which agents and whether to install per project or globally; with --yes it installs both skills non-interactively. If the machine-wide install fails, for example because npm can’t write to its global folder, init adds the CLI to the project instead.

Output

The commands it runs are printed to stderr as they run. A JSON summary with the project root, package manager, renderer choice, whether skills were installed, and where the CLI went (cli: global or project) is printed to stdout.