Skip to content

About this page

On this page

CLI commands ​

configCommands({ engine, defaults }) returns ToolchainCommand[] (register them on your commander program with @deltabox/toolchain/cli):

CommandWrites
config:env.env.example
config:typesconfig types (--env also writes env types)
config:jsonconfig.json (metadata)
config:schemaconfig.schema.json
config:markdownthe markdown reference
config:clicli-options.json
config:alleverything, under one output directory
ts
import { configCommands } from '@deltabox/toolchain/config';

const commands = configCommands({
    engine,
    defaults: { typesDir: 'packages/shared/src/types', docsDir: 'docs/reference' },
});
// register `commands` on your commander program

The config:* commands generate config artifacts; they do not write the CLI reference. For that, pass the command descriptors your CLI registers to generateCliDocs().