reference

CLI reference

runek init / add / list — pull editable component source into your project.

⌖ Explore the library in 3D →

The runek CLI copies component source from the registry into your project — you own and edit the files. Run it with npx runek <command>.

init

npx runek init [options]

Writes runek.config.json and creates the install directory. Run it once per project.

add

npx runek add <name...> [options]

Pulls one or more components. For each, it:

  1. resolves registry dependencies recursively (every component pulls core; house also pulls its walls, floor, roof, door, and window),
  2. writes the source into your install directory, repointing the @runek/core import at your copy,
  3. installs the npm dependencies with your package manager (auto-detected from the lockfile).
npx runek add player terrain bookshelf

list

npx runek list [options]

Prints the catalog, grouped by category.

Options

OptionCommandsDescription
--registry <url|path>allRegistry base. Defaults to the configured one (https://runek.nullorder.org/r). A local path works for development.
--dir <path>init, addInstall directory (default src/runek).
--overwriteaddReplace files that already exist (otherwise they’re skipped).
--no-installaddPrint the dependency install command instead of running it.
--forceinitOverwrite an existing runek.config.json.
-h, --help—Show help.

runek.config.json

{
  "$schema": "https://runek.nullorder.org/registry/config-schema.json",
  "registry": "https://runek.nullorder.org/r",
  "dir": "src/runek",
  "coreImport": "./core"
}