Skip to content

CliConfig

Configuration for Effect CLI command execution.

5 exports Added in v4.0.0 Source

Constructors

make

Added in v4.0.0 Source

Creates CLI configuration by merging the provided options over defaults.

When to use

Use when you need a configuration value to provide directly through the CliConfig context reference.

See

  • layer for providing configuration as a layer

Signature

declare function make(options?: Partial<Service>): Service;

Defaults

defaults

Added in v4.0.0 Source

Default CLI configuration containing every built-in global flag.

Signature

declare const defaults: CliConfig.Service;

Layers

layer

Added in v4.0.0 Source

Creates a layer that provides CLI configuration merged over defaults.

When to use

Use when wiring customized CLI behavior into an application layer.

See

  • make for creating a configuration value directly

Signature

declare function layer(options?: Partial<Service>): Layer<never>;

Other

CliConfig

Added in v4.0.0 Source

Types used by the CliConfig context reference.

Services

CliConfig

Added in v4.0.0 Source

Context reference for configuration shared by CLI parsing, help generation, and command execution.

When to use

Use when you need to customize runner-wide CLI behavior, such as which built-in global flags are available.

Signature

declare class CliConfig extends ({}) {
  constructor(_: never);
}