Skip to content
U of H Docs

hyperioncli (flake Commands)

Terminal window
npx hyperioncli@unstable-flake flake [options] [command] <flake>

  1. Initialize a new flake.

    Terminal window
    # [dir] defaults to current directory.
    npx hyperioncli@unstable-flake flake init [dir]

  2. Write configuration in the flake.

    [dir]/flake.json
    {
        /* Schema used for the flake. */
        "$schema": "https://raw.githubusercontent.com/HyperionU/hyperioncli/refs/heads/unstable/src/utils/schema/flake.json",
        /* Description of flake. */
        "description": "Example flake",
        /* Package Manager to use. */
        "packageManager": "[packageManager]",
        /* Services that can be configured using `options`. */
        "services": {
            /* ... */
        },
        /* Options for the enabled services. */
        "options": {
            /* VSCode extentions to install (PackageSet). */
            "packageSet": {
                /* ... */
            },
            /* Path to new Turborepo. (Turbo) */
            "turboPath": /* ... */,
            /* Configuration for a new Nitrox site (Nitrox / Astro) */
            "nitrox": {
                /* ... */
            }
        },
        /* Options for overriding Turborepo's template apps. */
        "turboOverrides": {
            /* ... */
        }
    }

  3. Run the flake command.

    Terminal window
    npx hyperioncli@unstable-flake flake <flake-file>