Skip to content

@gluonjs/core / packages/create-gluon/src / runCli

Function: runCli() ​

runCli(arguments_, io?): Promise<AddComponentResult | ScaffoldResult | undefined>

Parameters ​

arguments_ ​

readonly string[]

io? ​

CliIo = {}

Returns ​

Promise<AddComponentResult | ScaffoldResult | undefined>

Example ​

Run the scaffold command against caller-owned input, output, working directory, or prompt adapters so automation can avoid process globals:

ts
import { PassThrough } from 'node:stream';
import { runCli, type CliIo } from 'create-gluon';

const output = new PassThrough();
output.setEncoding('utf8');
output.on('data', (text: string) => console.log(text));

const io = { output, cwd: '/tmp' } satisfies CliIo;
await runCli(['--help'], io);

Version-matched documentation. Examples are checked against the public package contracts.