Command Line Interface

ScaffScript provides a command line interface to run scripts and manage your project.

Commands

gen | generate

Runs the full pipeline (scan, parse, generate, and integrate), based on the provided configuration.

<pm> scaff gen <project_path> [<options>]
<pm> scaff generate <project_path> [<options>]

Argument	Description
<pm>	Your package manager (bun, npm, or pnpm).
project_path	Path to your GameMaker .yyp project file.
<options>	Optional flags to override config options.

The used source path is based on the source option in scaff.config.*. The project_path must end in .yyp and must exist on disk.

Options

Option	Description
--integrate | -i	Force integration, even if noIntegration: true is set in the config.
--no-integration | -!i	Skip integration, even if noIntegration: false is set in the config.

Examples

Using Script Recommended

Make sure you’ve set up the package.json scripts correctly. Here’s an example:

package.json

{
    // --- snip ---
    "scripts": {
       "generate": "scaff gen ./my-game.yyp",
       "generate": "scaff gen ./path/to/your/my-game.yyp",
        "help": "scaff help",
        "scaff": "scaff"
    },
    // --- snip ---
}

Then, you can run the script with your package manager:

bun

bun run generate                        # no option override
bun run generate -- --no-integration    # override config option

npm

npm run generate                        # no option override
npm run generate -- --no-integration    # override config option

pnpm

pnpm run generate                        # no option override
pnpm run generate -- --no-integration    # override config option

Tip

Use single quotes (') to wrap the GameMaker project path. This prevents issues with spaces in the path. For example:

package.json

{
    // --- snip ---
    "scripts": {
        "generate": "scaff gen './My Game With Spaces.yyp'"
    },
    // --- snip ---
}

Using Package Manager

bun

# no option override
bunx scaff gen ./my-game.yyp
bunx scaff generate './My Game/My Game.yyp'

# override config option
bunx scaff gen ./my-game.yyp --no-integration
bunx scaff generate './My Game/My Game.yyp' --no-integration

npm

# no option override
npx scaff gen ./my-game.yyp
npx scaff generate './My Game/My Game.yyp'

# override config option
npx scaff gen ./my-game.yyp --no-integration
npx scaff generate './My Game/My Game.yyp' --no-integration

pnpm

# no option override
pnpm exec scaff gen ./my-game.yyp
pnpm exec scaff generate './My Game/My Game.yyp'

# override config option
pnpm exec scaff gen ./my-game.yyp --no-integration
pnpm exec scaff generate './My Game/My Game.yyp' --no-integration

Tip

Use single quotes (') or double quotes (") to wrap the GameMaker project path. This prevents issues with spaces in the path. Works for all package managers. For example:

bunx scaff gen './My Game/My Game.yyp'

---

help | -h | --help

Prints usage information.

<pm> scaff help
<pm> scaff -h
<pm> scaff --help

Argument	Description
<pm>	Your package manager (bun, npm, or pnpm).

Examples

bun

bunx scaff help
bun run help

npm

npx scaff --help
npm run help

pnpm

pnpm exec scaff -h
pnpm run help

---

Console Output

Tag	Color	Meaning
[DEBUG]	Gray	Step tracing (only when debugLevel >= 1)
[INFO]	Cyan	Progress and success messages
[WARN]	Yellow	Non-fatal issues, skipped items
[ERROR]	Red	Fatal issues that abort the run
[INPUT]	Magenta	Prompt during the integration review step