HELIX Docs
CLI & AI toolsCommand reference

helix init

Scaffold a complete, build-ready HELIX Instant world project (or, with --ability, a humanoid-character ability)

CLI version 0.1.27-helix3.551. Run helix init --help for the text your installed build prints.

helix init

Scaffold a complete, build-ready HELIX Instant world project (or, with --ability, a humanoid-character ability)

helix init [options] <directory>
ArgumentRequiredDescription
directoryyesdirectory to create
OptionDescription
--abilityscaffold an ability bundle for the humanoid-character system instead of a world
--title <title>world title shown in the tab, loading screen, and catalog
--slug <slug>URL-safe world slug (defaults to the directory name)
--kind <kind>character (single-player), multiplayer (presence + proximity voice), or scene (multiplayer whose environment is a streamed HELIX Scene v2 document) (default "character")
--max-players <n>multiplayer only: room size (2-64) (default "8")
--terrain <preset>scene worlds only: generate a 1 km x 1 km starter terrain from a built-in preset
--overwritereplace files that already exist (default: skip them)

On this page