Skills › HyperFrames › hyperframes-registry › install-locations.md

install-locations.md

45 lines · skills/hyperframes-registry/references/install-locations.md at a595755

Open on GitHub

1# Install Locations

Install Locations

Raw lines 1 to 2

3## Default paths

5| Item type | Default install path | Configured by |

6| --------- | ------------------------------------- | ----------------------------------- |

7| Block | `compositions/<name>.html` | `hyperframes.json#paths.blocks` |

8| Component | `compositions/components/<name>.html` | `hyperframes.json#paths.components` |

Default paths

Item type	Default install path	Configured by
Block	`compositions/<name>.html`	`hyperframes.json#paths.blocks`
Component	`compositions/components/<name>.html`	`hyperframes.json#paths.components`

Raw lines 3 to 9

10## How path remapping works

12The `target` field in each item's `registry-item.json` specifies a default install path. The `add` command remaps the prefix based on `hyperframes.json#paths`:

14- Block targets starting with `compositions/` get remapped to `<paths.blocks>/`

15- Component targets starting with `compositions/components/` get remapped to `<paths.components>/`

How path remapping works

The target field in each item's registry-item.json specifies a default install path. The add command remaps the prefix based on hyperframes.json#paths:

Block targets starting with compositions/ get remapped to <paths.blocks>/
Component targets starting with compositions/components/ get remapped to <paths.components>/

Raw lines 10 to 16

17## hyperframes.json

19Created automatically by `hyperframes init`. If it doesn't exist when you run `add`, the CLI creates it with defaults:

21```json

22{

23 "$schema": "https://hyperframes.heygen.com/schema/hyperframes.json",

24 "registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",

25 "paths": {

26 "blocks": "compositions",

27 "components": "compositions/components",

28 "assets": "assets"

29 }

30}

31```

hyperframes.json

Created automatically by hyperframes init. If it doesn't exist when you run add, the CLI creates it with defaults:

{
  "$schema": "https://hyperframes.heygen.com/schema/hyperframes.json",
  "registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
  "paths": {
    "blocks": "compositions",
    "components": "compositions/components",
    "assets": "assets"
  }
}

Raw lines 17 to 32

33## Custom layouts

35To install blocks into a `scenes/` directory instead of `compositions/`:

37```json

38{

39 "paths": {

40 "blocks": "scenes"

41 }

42}

43```

45Then `hyperframes add data-chart` writes to `scenes/data-chart.html` instead of `compositions/data-chart.html`. The snippet output reflects the remapped path.

Custom layouts

To install blocks into a scenes/ directory instead of compositions/:

{
  "paths": {
    "blocks": "scenes"
  }
}

Then hyperframes add data-chart writes to scenes/data-chart.html instead of compositions/data-chart.html. The snippet output reflects the remapped path.

Raw lines 33 to 45