kubricate / commands/generate/GenerateCommand / GenerateCommandOptions

Interface: GenerateCommandOptions

Extends

• GlobalConfigOptions

Properties

config?

optional config: string;

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

Default

'kubricate.config'

Inherited from

GlobalConfigOptions.config

---

dryRun?

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

false

Inherited from

GlobalConfigOptions.dryRun

---

filter?

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?

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

ConsoleLogger.LogLevel.INFO

Inherited from

GlobalConfigOptions.logger

---

outDir

outDir: string;

---

root?

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

process.cwd()

Inherited from

GlobalConfigOptions.root

---

silent?

optional silent: boolean;

Inherited from

GlobalConfigOptions.silent

---

stdout

stdout: boolean;

Output into stdout

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

---

verbose?

optional verbose: boolean;

Inherited from

GlobalConfigOptions.verbose

---

version?

optional version: string;

Version of the CLI.

Inherited from

GlobalConfigOptions.version