cli overview

Shared wiring for the effect-native CLI: command tree, layers, and runtime helpers.

The module keeps our ultra extreme programming feedback loops visible in the generated help output and exposes utilities that the entrypoint and tests share.

Added in v0.0.1

Table of contents

• utils
  • CliLayer
  • MainLayer
  • cli
  • effectNativeCommand
  • run
  • version

utils

CliLayer

CLI configuration shared by the binary and tests.

Signature

export declare const CliLayer: Layer.Layer<CliConfig.CliConfig, never, never>

Added in v0.0.1

MainLayer

Baseline layer stack required by the CLI.

Signature

export declare const MainLayer: Layer.Layer<CliConfig.CliConfig | NodeContext.NodeContext, never, never>

Added in v0.0.1

cli

Fully-configured CLI application ready to interpret process.argv.

Signature

export declare const cli: (
  args: ReadonlyArray<string>
) => Effect.Effect<void, never | ValidationError, never | CliApp.Environment>

Added in v0.0.1

effectNativeCommand

Root command exposed by the CLI.

Signature

export declare const effectNativeCommand: Command.Command<
  "effect-native",
  never,
  never,
  { readonly subcommand: Option<{}> }
>

Added in v0.0.1

run

Convenience helper for executing the CLI with the default layer stack.

Signature

export declare const run: (args: ReadonlyArray<string>) => Effect.Effect<void, ValidationError, never>

Added in v0.0.1

version

Current effect-native package version.

Signature

export declare const version: string

Added in v0.0.1