Files
frames/docs/schema/frames.json
T
zooqueen 457e510c8a docs: name the binary the package actually installs
The published package is @hanzo/frame and its bin is `frames`, so
`npx @hanzo/frame <command>` and a bare `frames <command>` are the two
forms that run. There is no `hanzo frame` group on the hanzo CLI, and
prose that named one described a command nobody can type.
2026-08-13 17:31:23 -07:00

62 lines
2.4 KiB
JSON

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://frames.hanzo.ai/schema/frames.json",
"title": "Hyperframes Project Config",
"description": "Per-project configuration for a Hyperframes project (frames.json). Tells `frames add` which registry to pull items from and where to drop them in the project tree. Created by `frames init`; users may edit it to point at custom registries or reshape their project layout.",
"type": "object",
"required": ["registry", "paths"],
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string",
"format": "uri",
"description": "JSON Schema URL — https://frames.hanzo.ai/schema/frames.json."
},
"registry": {
"type": "string",
"format": "uri",
"minLength": 1,
"description": "Base URL of the registry to pull items from. Point at the official Hyperframes registry or a custom one."
},
"paths": {
"type": "object",
"description": "Target paths for each item type, relative to the project root.",
"required": ["blocks", "components", "assets"],
"additionalProperties": false,
"properties": {
"blocks": {
"type": "string",
"minLength": 1,
"description": "Where `frames:block` items land. Defaults to `compositions`."
},
"components": {
"type": "string",
"minLength": 1,
"description": "Where `frames:component` items land. Defaults to `compositions/components`."
},
"assets": {
"type": "string",
"minLength": 1,
"description": "Where asset files (images, fonts, videos) land. Defaults to `assets`."
}
}
},
"media": {
"type": "object",
"description": "Media handling options.",
"additionalProperties": false,
"properties": {
"autoProxy": {
"type": "boolean",
"description": "Automatically create H.264 proxies for browser-hostile video codecs on supported preview surfaces. Defaults to true."
}
}
},
"authoringSkill": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{0,63}$",
"description": "Owning authoring-workflow skill slug (e.g. product-launch-video). Set by `frames init --skill` or seeded from the first `frames render --skill`; every render of this project is then attributed to it on anonymous telemetry, without re-passing the flag."
}
}
}