Skip to content

CliApp

4 exports Added in v1.0.0 Source

Constructors

make

Added in v1.0.0 Source

Signature

declare const make: <A>(config: CliApp.ConstructorArgs<A>) => CliApp<A>;

Execution

run

Added in v1.0.0 Source

Signature

declare const run: {
  <R, E, A>(args: readonly Array<string>, execute: (a: A) => Effect<void, E, R>): (self: CliApp<A>) => Effect<void | E, any, ValidationError>;
  <R, E, A>(self: CliApp<A>, args: readonly Array<string>, execute: (a: A) => Effect<void, E, R>): Effect<void | E, any, ValidationError>;
}

Models

CliApp interface

Added in v1.0.0 Source

A CliApp<A> is a complete description of a command-line application.

Signature

interface CliApp<A> extends Pipeable {
  readonly command: Command<A>;
  readonly executable: string;
  readonly footer: HelpDoc;
  readonly name: string;
  readonly summary: Span;
  readonly version: string;
}

Other

CliApp

Added in v1.0.0 Source