Kubricate

Appearance

kubricate / commands/generate/GenerateCommand / GenerateCommandOptions

Interface: GenerateCommandOptions ​

Extends ​

Properties ​

config? ​

ts
optional config: string;

Config file name to load. If not specified, the default config file name will be used.

Default ​

ts
'kubricate.config'

Inherited from ​

GlobalConfigOptions.config

dryRun? ​

ts
optional dryRun: boolean;

Dry run mode. If set to true, the CLI will not execute any commands, but will print what would be done.

Default ​

ts
false

Inherited from ​

GlobalConfigOptions.dryRun

filter? ​

ts
optional filter: string[];

Filter stacks or resources by ID (e.g., myStack or myStack.resource)

Empty if not specified, all stacks will be included.

logger? ​

ts
optional logger: ConsoleLogger;

Enable verbose output. This will enable debug logging and show more information in the output. If not specified, the default log level will be used.

Default ​

ts
ConsoleLogger.LogLevel.INFO

Inherited from ​

GlobalConfigOptions.logger

outDir ​

ts
outDir: string;

root? ​

ts
optional root: string;

Working directory to load the config from. This is the directory where the config file is located. If not specified, the current working directory will be used.

Default ​

ts
process.cwd()

Inherited from ​

GlobalConfigOptions.root

silent? ​

ts
optional silent: boolean;

Inherited from ​

GlobalConfigOptions.silent

stdout ​

ts
stdout: boolean;

Output into stdout

When set, the generated files will be printed to stdout instead of being written to disk.

verbose? ​

ts
optional verbose: boolean;

Inherited from ​

GlobalConfigOptions.verbose

version? ​

ts
optional version: string;

Version of the CLI.

Inherited from ​

GlobalConfigOptions.version