Skip to main content

Installation

Cleya is not published to npm. The repository is the distribution.

git clone https://github.com/severment/cleya.git
cd cleya
npm install
npm run build
npm link

npm link puts two binaries on your path:

  • cleya — the CLI
  • cleya-mcp — the MCP server (stdio)

Verify:

cleya doctor
cleya --version

Installing straight from git also works, because the package builds on prepare:

npm install github:severment/cleya

Wire it into an agent​

Cleya speaks MCP over stdio. Add it to your client's server list:

{
  "mcpServers": {
    "cleya": { "command": "cleya-mcp" }
  }
}

Every tool is registered as cleya_<tool> with a typed schema. Point the agent at cleya_capabilities first — one call returns the whole machine-readable manifest (every tool, its options, examples, category and cost hint), which is how an agent learns the toolkit without guessing.

Use it as a library​

import { render, contrast, brandCheck, resolveConfig } from "cleya";

const config = resolveConfig();
const out = await render({ scene: "promo.json", brand: "brand.json", output: "promo.mp4" }, config);
const wcag = await contrast({ input: "promo.mp4", time: 3.2 }, config);

Every tool takes (params, config) and returns Promise<ToolResult<T>>. See the result contract.

Working on Cleya itself​

npm run build      # tsc
npm test           # vitest — 779 tests across 74 files
npm run smoke      # end-to-end render smoke test

Because npm link symlinks the global CLI to your working tree, npm run build makes any change live immediately for every shell and every agent session — no reinstall.