diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index e27dbdd..437ed79 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -31,8 +31,12 @@ jobs:
- name: Upload pages artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v2
+ - name: Build pages Jekyll
+ if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+ uses: actions/jekyll-build-pages@v1
with:
- path: docs/
+ source: ./docs
+ destination: ./_site
- name: Create Release Pull Request or Publish
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: changesets/action@v1
diff --git a/docs/_config.yml b/docs/_config.yml
deleted file mode 100644
index 868123b..0000000
--- a/docs/_config.yml
+++ /dev/null
@@ -1,9 +0,0 @@
-remote_theme: mikearnaldi/just-the-docs
-
-# Enable or disable the site search
-search_enabled: true
-
-# Aux links for the upper right navigation
-aux_links:
- '@effect/cli on GitHub':
- - 'https://github.com/Effect-TS/cli'
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index d77a441..0000000
--- a/docs/index.md
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: Home
-nav_order: 1
----
diff --git a/docs/modules/Args.ts.md b/docs/modules/Args.ts.md
deleted file mode 100644
index 48af178..0000000
--- a/docs/modules/Args.ts.md
+++ /dev/null
@@ -1,506 +0,0 @@
----
-title: Args.ts
-nav_order: 1
-parent: Modules
----
-
-## Args overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [combinators](#combinators)
- - [atLeast](#atleast)
- - [atMost](#atmost)
- - [between](#between)
- - [repeated](#repeated)
- - [repeatedAtLeastOnce](#repeatedatleastonce)
- - [toRegularLanguage](#toregularlanguage)
-- [constructors](#constructors)
- - [all](#all)
- - [boolean](#boolean)
- - [choice](#choice)
- - [date](#date)
- - [directory](#directory)
- - [file](#file)
- - [float](#float)
- - [integer](#integer)
- - [none](#none)
- - [path](#path)
- - [text](#text)
-- [mapping](#mapping)
- - [map](#map)
- - [mapOrFail](#maporfail)
- - [mapTryCatch](#maptrycatch)
-- [models](#models)
- - [Args (interface)](#args-interface)
-- [refinements](#refinements)
- - [isArgs](#isargs)
-- [symbols](#symbols)
- - [ArgsTypeId](#argstypeid)
- - [ArgsTypeId (type alias)](#argstypeid-type-alias)
-- [utils](#utils)
- - [All (namespace)](#all-namespace)
- - [ArgsAny (type alias)](#argsany-type-alias)
- - [Return (type alias)](#return-type-alias)
- - [ReturnIterable (type alias)](#returniterable-type-alias)
- - [ReturnObject (type alias)](#returnobject-type-alias)
- - [ReturnTuple (type alias)](#returntuple-type-alias)
- - [Args (namespace)](#args-namespace)
- - [BaseArgsConfig (interface)](#baseargsconfig-interface)
- - [PathArgsConfig (interface)](#pathargsconfig-interface)
- - [Variance (interface)](#variance-interface)
-
----
-
-# combinators
-
-## atLeast
-
-**Signature**
-
-```ts
-export declare const atLeast: {
- (times: 0): (self: Args) => Args
- (times: number): (self: Args) => Args
- (self: Args, times: 0): Args
- (self: Args, times: number): Args
-}
-```
-
-Added in v1.0.0
-
-## atMost
-
-**Signature**
-
-```ts
-export declare const atMost: {
- (times: number): (self: Args) => Args
- (self: Args, times: number): Args
-}
-```
-
-Added in v1.0.0
-
-## between
-
-**Signature**
-
-```ts
-export declare const between: {
- (min: 0, max: number): (self: Args) => Args
- (min: number, max: number): (self: Args) => Args
- (self: Args, min: 0, max: number): Args
- (self: Args, min: number, max: number): Args
-}
-```
-
-Added in v1.0.0
-
-## repeated
-
-**Signature**
-
-```ts
-export declare const repeated: (self: Args) => Args
-```
-
-Added in v1.0.0
-
-## repeatedAtLeastOnce
-
-**Signature**
-
-```ts
-export declare const repeatedAtLeastOnce: (self: Args) => Args
-```
-
-Added in v1.0.0
-
-## toRegularLanguage
-
-Returns a `RegularLanguage` whose accepted language is equivalent to the language accepted by the provided `Args`.
-
-**Signature**
-
-```ts
-export declare const toRegularLanguage: (self: Args) => RegularLanguage
-```
-
-Added in v1.0.0
-
-# constructors
-
-## all
-
-**Signature**
-
-```ts
-export declare const all: > | Record>>(
- arg: Arg
-) => All.Return
-```
-
-Added in v1.0.0
-
-## boolean
-
-Creates a boolean argument.
-
-Can optionally provide a custom argument name (defaults to `"boolean"`).
-
-**Signature**
-
-```ts
-export declare const boolean: (options?: Args.BaseArgsConfig) => Args
-```
-
-Added in v1.0.0
-
-## choice
-
-Creates a choice argument.
-
-Can optionally provide a custom argument name (defaults to `"choice"`).
-
-**Signature**
-
-```ts
-export declare const choice: (
- choices: readonly [[string, A], ...[string, A][]],
- config?: Args.BaseArgsConfig
-) => Args
-```
-
-Added in v1.0.0
-
-## date
-
-Creates a date argument.
-
-Can optionally provide a custom argument name (defaults to `"date"`).
-
-**Signature**
-
-```ts
-export declare const date: (config?: Args.BaseArgsConfig) => Args
-```
-
-Added in v1.0.0
-
-## directory
-
-Creates a directory argument.
-
-Can optionally provide a custom argument name (defaults to `"directory"`).
-
-**Signature**
-
-```ts
-export declare const directory: (config?: Args.PathArgsConfig) => Args
-```
-
-Added in v1.0.0
-
-## file
-
-Creates a file argument.
-
-Can optionally provide a custom argument name (defaults to `"file"`).
-
-**Signature**
-
-```ts
-export declare const file: (config?: Args.PathArgsConfig) => Args
-```
-
-Added in v1.0.0
-
-## float
-
-Creates a floating point number argument.
-
-Can optionally provide a custom argument name (defaults to `"float"`).
-
-**Signature**
-
-```ts
-export declare const float: (config?: Args.BaseArgsConfig) => Args
-```
-
-Added in v1.0.0
-
-## integer
-
-Creates an integer argument.
-
-Can optionally provide a custom argument name (defaults to `"integer"`).
-
-**Signature**
-
-```ts
-export declare const integer: (config?: Args.BaseArgsConfig) => Args
-```
-
-Added in v1.0.0
-
-## none
-
-Creates an empty argument.
-
-**Signature**
-
-```ts
-export declare const none: Args
-```
-
-Added in v1.0.0
-
-## path
-
-Creates a path argument.
-
-Can optionally provide a custom argument name (defaults to `"path"`).
-
-**Signature**
-
-```ts
-export declare const path: (config?: Args.PathArgsConfig) => Args
-```
-
-Added in v1.0.0
-
-## text
-
-Creates a text argument.
-
-Can optionally provide a custom argument name (defaults to `"text"`).
-
-**Signature**
-
-```ts
-export declare const text: (config?: Args.BaseArgsConfig) => Args
-```
-
-Added in v1.0.0
-
-# mapping
-
-## map
-
-**Signature**
-
-```ts
-export declare const map: {
- (f: (a: A) => B): (self: Args) => Args
- (self: Args, f: (a: A) => B): Args
-}
-```
-
-Added in v1.0.0
-
-## mapOrFail
-
-**Signature**
-
-```ts
-export declare const mapOrFail: {
- (f: (a: A) => Either): (self: Args) => Args
- (self: Args, f: (a: A) => Either): Args
-}
-```
-
-Added in v1.0.0
-
-## mapTryCatch
-
-**Signature**
-
-```ts
-export declare const mapTryCatch: {
- (f: (a: A) => B, onError: (e: unknown) => HelpDoc): (self: Args) => Args
- (self: Args, f: (a: A) => B, onError: (e: unknown) => HelpDoc): Args
-}
-```
-
-Added in v1.0.0
-
-# models
-
-## Args (interface)
-
-Represents arguments that can be passed to a command-line application.
-
-**Signature**
-
-```ts
-export interface Args extends Args.Variance, Parameter, Pipeable {
- get maxSize(): number
- get minSize(): number
- get identifier(): Option
- get usage(): Usage
- validate(
- args: ReadonlyArray,
- config: CliConfig
- ): Effect, A]>
- addDescription(description: string): Args
-}
-```
-
-Added in v1.0.0
-
-# refinements
-
-## isArgs
-
-**Signature**
-
-```ts
-export declare const isArgs: (u: unknown) => u is Args
-```
-
-Added in v1.0.0
-
-# symbols
-
-## ArgsTypeId
-
-**Signature**
-
-```ts
-export declare const ArgsTypeId: typeof ArgsTypeId
-```
-
-Added in v1.0.0
-
-## ArgsTypeId (type alias)
-
-**Signature**
-
-```ts
-export type ArgsTypeId = typeof ArgsTypeId
-```
-
-Added in v1.0.0
-
-# utils
-
-## All (namespace)
-
-Added in v1.0.0
-
-### ArgsAny (type alias)
-
-**Signature**
-
-```ts
-export type ArgsAny = Args
-```
-
-Added in v1.0.0
-
-### Return (type alias)
-
-**Signature**
-
-```ts
-export type Return | Record> = [Arg] extends [ReadonlyArray]
- ? ReturnTuple
- : [Arg] extends [Iterable]
- ? ReturnIterable
- : [Arg] extends [Record]
- ? ReturnObject
- : never
-```
-
-Added in v1.0.0
-
-### ReturnIterable (type alias)
-
-**Signature**
-
-```ts
-export type ReturnIterable> = [T] extends [Iterable>]
- ? Args>
- : never
-```
-
-Added in v1.0.0
-
-### ReturnObject (type alias)
-
-**Signature**
-
-```ts
-export type ReturnObject = [T] extends [{ [K: string]: ArgsAny }]
- ? Args<{
- -readonly [K in keyof T]: [T[K]] extends [Args.Variance] ? _A : never
- }>
- : never
-```
-
-Added in v1.0.0
-
-### ReturnTuple (type alias)
-
-**Signature**
-
-```ts
-export type ReturnTuple> = Args<
- T[number] extends never
- ? []
- : {
- -readonly [K in keyof T]: [T[K]] extends [Args.Variance] ? _A : never
- }
-> extends infer X
- ? X
- : never
-```
-
-Added in v1.0.0
-
-## Args (namespace)
-
-Added in v1.0.0
-
-### BaseArgsConfig (interface)
-
-**Signature**
-
-```ts
-export interface BaseArgsConfig {
- readonly name?: string
-}
-```
-
-Added in v1.0.0
-
-### PathArgsConfig (interface)
-
-**Signature**
-
-```ts
-export interface PathArgsConfig extends BaseArgsConfig {
- readonly exists?: Primitive.PathExists
-}
-```
-
-Added in v1.0.0
-
-### Variance (interface)
-
-**Signature**
-
-```ts
-export interface Variance {
- readonly [ArgsTypeId]: {
- readonly _A: (_: never) => A
- }
-}
-```
-
-Added in v1.0.0
diff --git a/docs/modules/AutoCorrect.ts.md b/docs/modules/AutoCorrect.ts.md
deleted file mode 100644
index a163c52..0000000
--- a/docs/modules/AutoCorrect.ts.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-title: AutoCorrect.ts
-nav_order: 2
-parent: Modules
----
-
-## AutoCorrect overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [utilities](#utilities)
- - [levensteinDistance](#levensteindistance)
-
----
-
-# utilities
-
-## levensteinDistance
-
-**Signature**
-
-```ts
-export declare const levensteinDistance: (first: string, second: string, config: CliConfig) => number
-```
-
-Added in v1.0.0
diff --git a/docs/modules/BuiltInOptions.ts.md b/docs/modules/BuiltInOptions.ts.md
deleted file mode 100644
index d18f178..0000000
--- a/docs/modules/BuiltInOptions.ts.md
+++ /dev/null
@@ -1,201 +0,0 @@
----
-title: BuiltInOptions.ts
-nav_order: 3
-parent: Modules
----
-
-## BuiltInOptions overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [constructors](#constructors)
- - [showCompletionScript](#showcompletionscript)
- - [showCompletions](#showcompletions)
- - [showHelp](#showhelp)
- - [showWizard](#showwizard)
-- [models](#models)
- - [BuiltInOptions (type alias)](#builtinoptions-type-alias)
- - [ShowCompletionScript (interface)](#showcompletionscript-interface)
- - [ShowCompletions (interface)](#showcompletions-interface)
- - [ShowHelp (interface)](#showhelp-interface)
- - [ShowWizard (interface)](#showwizard-interface)
-- [options](#options)
- - [builtInOptions](#builtinoptions)
-- [refinements](#refinements)
- - [isShowCompletionScript](#isshowcompletionscript)
- - [isShowCompletions](#isshowcompletions)
- - [isShowHelp](#isshowhelp)
- - [isShowWizard](#isshowwizard)
-
----
-
-# constructors
-
-## showCompletionScript
-
-**Signature**
-
-```ts
-export declare const showCompletionScript: (pathToExecutable: string, shellType: ShellType) => BuiltInOptions
-```
-
-Added in v1.0.0
-
-## showCompletions
-
-**Signature**
-
-```ts
-export declare const showCompletions: (index: number, shellType: ShellType) => BuiltInOptions
-```
-
-Added in v1.0.0
-
-## showHelp
-
-**Signature**
-
-```ts
-export declare const showHelp: (usage: Usage, helpDoc: HelpDoc) => BuiltInOptions
-```
-
-Added in v1.0.0
-
-## showWizard
-
-**Signature**
-
-```ts
-export declare const showWizard: (commmand: Command) => BuiltInOptions
-```
-
-Added in v1.0.0
-
-# models
-
-## BuiltInOptions (type alias)
-
-**Signature**
-
-```ts
-export type BuiltInOptions = ShowHelp | ShowCompletionScript | ShowCompletions | ShowWizard
-```
-
-Added in v1.0.0
-
-## ShowCompletionScript (interface)
-
-**Signature**
-
-```ts
-export interface ShowCompletionScript {
- readonly _tag: "ShowCompletionScript"
- readonly pathToExecutable: string
- readonly shellType: ShellType
-}
-```
-
-Added in v1.0.0
-
-## ShowCompletions (interface)
-
-**Signature**
-
-```ts
-export interface ShowCompletions {
- readonly _tag: "ShowCompletions"
- readonly index: number
- readonly shellType: ShellType
-}
-```
-
-Added in v1.0.0
-
-## ShowHelp (interface)
-
-**Signature**
-
-```ts
-export interface ShowHelp {
- readonly _tag: "ShowHelp"
- readonly usage: Usage
- readonly helpDoc: HelpDoc
-}
-```
-
-Added in v1.0.0
-
-## ShowWizard (interface)
-
-**Signature**
-
-```ts
-export interface ShowWizard {
- readonly _tag: "ShowWizard"
- readonly commmand: Command
-}
-```
-
-Added in v1.0.0
-
-# options
-
-## builtInOptions
-
-**Signature**
-
-```ts
-export declare const builtInOptions: (
- command: Command,
- usage: Usage,
- helpDoc: HelpDoc
-) => Options>
-```
-
-Added in v1.0.0
-
-# refinements
-
-## isShowCompletionScript
-
-**Signature**
-
-```ts
-export declare const isShowCompletionScript: (self: BuiltInOptions) => self is ShowCompletionScript
-```
-
-Added in v1.0.0
-
-## isShowCompletions
-
-**Signature**
-
-```ts
-export declare const isShowCompletions: (self: BuiltInOptions) => self is ShowCompletions
-```
-
-Added in v1.0.0
-
-## isShowHelp
-
-**Signature**
-
-```ts
-export declare const isShowHelp: (self: BuiltInOptions) => self is ShowHelp
-```
-
-Added in v1.0.0
-
-## isShowWizard
-
-**Signature**
-
-```ts
-export declare const isShowWizard: (self: BuiltInOptions) => self is ShowWizard
-```
-
-Added in v1.0.0
diff --git a/docs/modules/CliApp.ts.md b/docs/modules/CliApp.ts.md
deleted file mode 100644
index fef2ca6..0000000
--- a/docs/modules/CliApp.ts.md
+++ /dev/null
@@ -1,101 +0,0 @@
----
-title: CliApp.ts
-nav_order: 4
-parent: Modules
----
-
-## CliApp overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [constructors](#constructors)
- - [make](#make)
-- [execution](#execution)
- - [run](#run)
-- [models](#models)
- - [CliApp (interface)](#cliapp-interface)
-- [utils](#utils)
- - [CliApp (namespace)](#cliapp-namespace)
- - [Environment (type alias)](#environment-type-alias)
-
----
-
-# constructors
-
-## make
-
-**Signature**
-
-```ts
-export declare const make: (config: {
- name: string
- version: string
- command: Command
- summary?: Span | undefined
- footer?: HelpDoc | undefined
-}) => CliApp
-```
-
-Added in v1.0.0
-
-# execution
-
-## run
-
-**Signature**
-
-```ts
-export declare const run: {
- (
- args: ReadonlyArray,
- execute: (a: A) => Effect
- ): (self: CliApp) => Effect
- (
- self: CliApp,
- args: ReadonlyArray,
- execute: (a: A) => Effect
- ): Effect
-}
-```
-
-Added in v1.0.0
-
-# models
-
-## CliApp (interface)
-
-A `CliApp` is a complete description of a command-line application.
-
-**Signature**
-
-```ts
-export interface CliApp {
- readonly name: string
- readonly version: string
- readonly command: Command
- readonly summary: Span
- readonly footer: HelpDoc
-}
-```
-
-Added in v1.0.0
-
-# utils
-
-## CliApp (namespace)
-
-Added in v1.0.0
-
-### Environment (type alias)
-
-**Signature**
-
-```ts
-export type Environment = CommandExecutor | FileSystem | Path
-```
-
-Added in v1.0.0
diff --git a/docs/modules/CliConfig.ts.md b/docs/modules/CliConfig.ts.md
deleted file mode 100644
index a103188..0000000
--- a/docs/modules/CliConfig.ts.md
+++ /dev/null
@@ -1,134 +0,0 @@
----
-title: CliConfig.ts
-nav_order: 5
-parent: Modules
----
-
-## CliConfig overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [constructors](#constructors)
- - [defaultConfig](#defaultconfig)
- - [make](#make)
-- [context](#context)
- - [CliConfig](#cliconfig)
- - [defaultLayer](#defaultlayer)
- - [layer](#layer)
-- [models](#models)
- - [CliConfig (interface)](#cliconfig-interface)
-- [utilities](#utilities)
- - [normalizeCase](#normalizecase)
-
----
-
-# constructors
-
-## defaultConfig
-
-**Signature**
-
-```ts
-export declare const defaultConfig: CliConfig
-```
-
-Added in v1.0.0
-
-## make
-
-**Signature**
-
-```ts
-export declare const make: (params: Partial) => CliConfig
-```
-
-Added in v1.0.0
-
-# context
-
-## CliConfig
-
-**Signature**
-
-```ts
-export declare const CliConfig: Context.Tag
-```
-
-Added in v1.0.0
-
-## defaultLayer
-
-**Signature**
-
-```ts
-export declare const defaultLayer: Layer.Layer
-```
-
-Added in v1.0.0
-
-## layer
-
-**Signature**
-
-```ts
-export declare const layer: (config?: Partial) => Layer.Layer
-```
-
-Added in v1.0.0
-
-# models
-
-## CliConfig (interface)
-
-Represents how arguments from the command-line are to be parsed.
-
-**Signature**
-
-```ts
-export interface CliConfig {
- /**
- * Whether or not the argument parser should be case sensitive.
- */
- readonly isCaseSensitive: boolean
- /**
- * Threshold for when to show auto correct suggestions.
- */
- readonly autoCorrectLimit: number
- /**
- * Whether or not to perform a final check of the command-line arguments for
- * a built-in option, even if the provided command is not valid.
- */
- readonly finalCheckBuiltIn: boolean
- /**
- * Whether or not to display all the names of an option in the usage of a
- * particular command.
- */
- readonly showAllNames: boolean
- /**
- * Whether or not to display the type of an option in the usage of a
- * particular command.
- */
- readonly showTypes: boolean
-}
-```
-
-Added in v1.0.0
-
-# utilities
-
-## normalizeCase
-
-**Signature**
-
-```ts
-export declare const normalizeCase: {
- (text: string): (self: CliConfig) => string
- (self: CliConfig, text: string): string
-}
-```
-
-Added in v1.0.0
diff --git a/docs/modules/Command.ts.md b/docs/modules/Command.ts.md
deleted file mode 100644
index 914a25d..0000000
--- a/docs/modules/Command.ts.md
+++ /dev/null
@@ -1,315 +0,0 @@
----
-title: Command.ts
-nav_order: 6
-parent: Modules
----
-
-## Command overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [combinators](#combinators)
- - [orElse](#orelse)
- - [orElseEither](#orelseeither)
- - [subcommands](#subcommands)
- - [toRegularLanguage](#toregularlanguage)
- - [withHelp](#withhelp)
-- [constructors](#constructors)
- - [prompt](#prompt)
- - [standard](#standard)
-- [mapping](#mapping)
- - [map](#map)
-- [models](#models)
- - [Command (interface)](#command-interface)
-- [symbols](#symbols)
- - [CommandTypeId](#commandtypeid)
- - [CommandTypeId (type alias)](#commandtypeid-type-alias)
-- [utils](#utils)
- - [Command (namespace)](#command-namespace)
- - [ConstructorConfig (interface)](#constructorconfig-interface)
- - [Variance (interface)](#variance-interface)
- - [ComputeParsedType (type alias)](#computeparsedtype-type-alias)
- - [GetParsedType (type alias)](#getparsedtype-type-alias)
- - [ParsedStandardCommand (type alias)](#parsedstandardcommand-type-alias)
- - [ParsedSubcommand (type alias)](#parsedsubcommand-type-alias)
- - [ParsedUserInputCommand (type alias)](#parseduserinputcommand-type-alias)
- - [Subcommands (type alias)](#subcommands-type-alias)
-
----
-
-# combinators
-
-## orElse
-
-**Signature**
-
-```ts
-export declare const orElse: {
- (that: Command): (self: Command) => Command
- (self: Command, that: Command): Command
-}
-```
-
-Added in v1.0.0
-
-## orElseEither
-
-**Signature**
-
-```ts
-export declare const orElseEither: {
- (that: Command): (self: Command) => Command>
- (self: Command, that: Command): Command>
-}
-```
-
-Added in v1.0.0
-
-## subcommands
-
-**Signature**
-
-```ts
-export declare const subcommands: {
- , ...Command[]]>(
- subcommands: [...Subcommands]
- ): (
- self: Command
- ) => Command<
- Command.ComputeParsedType> }>>
- >
- , ...Command[]]>(
- self: Command,
- subcommands: [...Subcommands]
- ): Command<
- Command.ComputeParsedType> }>>
- >
-}
-```
-
-Added in v1.0.0
-
-## toRegularLanguage
-
-Returns a `RegularLanguage` whose accepted language is equivalent to the
-language accepted by the provided `Command`.
-
-**Signature**
-
-```ts
-export declare const toRegularLanguage: {
- (allowAlias: boolean): (self: Command) => RegularLanguage
- (self: Command, allowAlias: boolean): RegularLanguage
-}
-```
-
-Added in v1.0.0
-
-## withHelp
-
-**Signature**
-
-```ts
-export declare const withHelp: {
- (help: string | HelpDoc): (self: Command) => Command
- (self: Command, help: string | HelpDoc): Command
-}
-```
-
-Added in v1.0.0
-
-# constructors
-
-## prompt
-
-**Signature**
-
-```ts
-export declare const prompt: (
- name: Name,
- prompt: Prompt
-) => Command<{ readonly name: Name; readonly value: A }>
-```
-
-Added in v1.0.0
-
-## standard
-
-**Signature**
-
-```ts
-export declare const standard: (
- name: Name,
- config?: Command.ConstructorConfig | undefined
-) => Command<{ readonly name: Name; readonly options: OptionsType; readonly args: ArgsType }>
-```
-
-Added in v1.0.0
-
-# mapping
-
-## map
-
-**Signature**
-
-```ts
-export declare const map: {
- (f: (a: A) => B): (self: Command) => Command
- (self: Command, f: (a: A) => B): Command
-}
-```
-
-Added in v1.0.0
-
-# models
-
-## Command (interface)
-
-A `Command` represents a command in a command-line application.
-
-Every command-line application will have at least one command: the
-application itself. Other command-line applications may support multiple
-commands.
-
-**Signature**
-
-```ts
-export interface Command extends Command.Variance, Named, Pipeable {
- get usage(): Usage
- get subcommands(): HashMap>
- parse(
- args: ReadonlyArray,
- config: CliConfig
- ): Effect>
-}
-```
-
-Added in v1.0.0
-
-# symbols
-
-## CommandTypeId
-
-**Signature**
-
-```ts
-export declare const CommandTypeId: typeof CommandTypeId
-```
-
-Added in v1.0.0
-
-## CommandTypeId (type alias)
-
-**Signature**
-
-```ts
-export type CommandTypeId = typeof CommandTypeId
-```
-
-Added in v1.0.0
-
-# utils
-
-## Command (namespace)
-
-Added in v1.0.0
-
-### ConstructorConfig (interface)
-
-**Signature**
-
-```ts
-export interface ConstructorConfig {
- readonly options?: Options
- readonly args?: Args
-}
-```
-
-Added in v1.0.0
-
-### Variance (interface)
-
-**Signature**
-
-```ts
-export interface Variance {
- readonly [CommandTypeId]: {
- readonly _A: (_: never) => A
- }
-}
-```
-
-Added in v1.0.0
-
-### ComputeParsedType (type alias)
-
-**Signature**
-
-```ts
-export type ComputeParsedType = { [K in keyof A]: A[K] } extends infer X ? X : never
-```
-
-Added in v1.0.0
-
-### GetParsedType (type alias)
-
-**Signature**
-
-```ts
-export type GetParsedType = C extends Command ? P : never
-```
-
-Added in v1.0.0
-
-### ParsedStandardCommand (type alias)
-
-**Signature**
-
-```ts
-export type ParsedStandardCommand = Command.ComputeParsedType<{
- readonly name: Name
- readonly options: OptionsType
- readonly args: ArgsType
-}>
-```
-
-Added in v1.0.0
-
-### ParsedSubcommand (type alias)
-
-**Signature**
-
-```ts
-export type ParsedSubcommand> = A[number] extends Command
- ? GetParsedType
- : never
-```
-
-Added in v1.0.0
-
-### ParsedUserInputCommand (type alias)
-
-**Signature**
-
-```ts
-export type ParsedUserInputCommand = Command.ComputeParsedType<{
- readonly name: Name
- readonly value: ValueType
-}>
-```
-
-Added in v1.0.0
-
-### Subcommands (type alias)
-
-**Signature**
-
-```ts
-export type Subcommands>> = GetParsedType
-```
-
-Added in v1.0.0
diff --git a/docs/modules/CommandDirective.ts.md b/docs/modules/CommandDirective.ts.md
deleted file mode 100644
index c12540e..0000000
--- a/docs/modules/CommandDirective.ts.md
+++ /dev/null
@@ -1,126 +0,0 @@
----
-title: CommandDirective.ts
-nav_order: 7
-parent: Modules
----
-
-## CommandDirective overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [constructors](#constructors)
- - [builtIn](#builtin)
- - [userDefined](#userdefined)
-- [mapping](#mapping)
- - [map](#map)
-- [models](#models)
- - [BuiltIn (interface)](#builtin-interface)
- - [CommandDirective (type alias)](#commanddirective-type-alias)
- - [UserDefined (interface)](#userdefined-interface)
-- [refinements](#refinements)
- - [isBuiltIn](#isbuiltin)
- - [isUserDefined](#isuserdefined)
-
----
-
-# constructors
-
-## builtIn
-
-**Signature**
-
-```ts
-export declare const builtIn: (option: BuiltInOptions) => CommandDirective
-```
-
-Added in v1.0.0
-
-## userDefined
-
-**Signature**
-
-```ts
-export declare const userDefined: (leftover: ReadonlyArray, value: A) => CommandDirective
-```
-
-Added in v1.0.0
-
-# mapping
-
-## map
-
-**Signature**
-
-```ts
-export declare const map: {
- (f: (a: A) => B): (self: CommandDirective) => CommandDirective
- (self: CommandDirective, f: (a: A) => B): CommandDirective
-}
-```
-
-Added in v1.0.0
-
-# models
-
-## BuiltIn (interface)
-
-**Signature**
-
-```ts
-export interface BuiltIn {
- readonly _tag: "BuiltIn"
- readonly option: BuiltInOptions
-}
-```
-
-Added in v1.0.0
-
-## CommandDirective (type alias)
-
-**Signature**
-
-```ts
-export type CommandDirective = BuiltIn | UserDefined
-```
-
-Added in v1.0.0
-
-## UserDefined (interface)
-
-**Signature**
-
-```ts
-export interface UserDefined {
- readonly _tag: "UserDefined"
- readonly leftover: ReadonlyArray
- readonly value: A
-}
-```
-
-Added in v1.0.0
-
-# refinements
-
-## isBuiltIn
-
-**Signature**
-
-```ts
-export declare const isBuiltIn: (self: CommandDirective) => self is BuiltIn
-```
-
-Added in v1.0.0
-
-## isUserDefined
-
-**Signature**
-
-```ts
-export declare const isUserDefined: (self: CommandDirective) => self is UserDefined
-```
-
-Added in v1.0.0
diff --git a/docs/modules/Compgen.ts.md b/docs/modules/Compgen.ts.md
deleted file mode 100644
index 101e9cc..0000000
--- a/docs/modules/Compgen.ts.md
+++ /dev/null
@@ -1,71 +0,0 @@
----
-title: Compgen.ts
-nav_order: 8
-parent: Modules
----
-
-## Compgen overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [context](#context)
- - [Compgen](#compgen)
- - [LiveCompgen](#livecompgen)
- - [TestCompgen](#testcompgen)
-- [models](#models)
- - [Compgen (interface)](#compgen-interface)
-
----
-
-# context
-
-## Compgen
-
-**Signature**
-
-```ts
-export declare const Compgen: Tag
-```
-
-Added in v1.0.0
-
-## LiveCompgen
-
-**Signature**
-
-```ts
-export declare const LiveCompgen: Layer
-```
-
-Added in v1.0.0
-
-## TestCompgen
-
-**Signature**
-
-```ts
-export declare const TestCompgen: (workingDirectory: string) => Layer
-```
-
-Added in v1.0.0
-
-# models
-
-## Compgen (interface)
-
-`Compgen` simplifies the process of calling Bash's built-in `compgen` command.
-
-**Signature**
-
-```ts
-export interface Compgen {
- completeFileNames(word: string): Effect>
- completeDirectoryNames(word: string): Effect>
-}
-```
-
-Added in v1.0.0
diff --git a/docs/modules/Completion.ts.md b/docs/modules/Completion.ts.md
deleted file mode 100644
index 0f6af33..0000000
--- a/docs/modules/Completion.ts.md
+++ /dev/null
@@ -1,52 +0,0 @@
----
-title: Completion.ts
-nav_order: 9
-parent: Modules
----
-
-## Completion overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [completions](#completions)
- - [getCompletionScript](#getcompletionscript)
- - [getCompletions](#getcompletions)
-
----
-
-# completions
-
-## getCompletionScript
-
-**Signature**
-
-```ts
-export declare const getCompletionScript: (
- pathToExecutable: string,
- programNames: readonly [string, ...string[]],
- shellType: ShellType,
- path: Path
-) => string
-```
-
-Added in v1.0.0
-
-## getCompletions
-
-**Signature**
-
-```ts
-export declare const getCompletions: (
- words: ReadonlyArray,
- index: number,
- command: Command,
- config: CliConfig,
- compgen: Compgen
-) => Effect>
-```
-
-Added in v1.0.0
diff --git a/docs/modules/HelpDoc.ts.md b/docs/modules/HelpDoc.ts.md
deleted file mode 100644
index 0a7b7df..0000000
--- a/docs/modules/HelpDoc.ts.md
+++ /dev/null
@@ -1,366 +0,0 @@
----
-title: HelpDoc.ts
-nav_order: 10
-parent: Modules
----
-
-## HelpDoc overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [combinators](#combinators)
- - [orElse](#orelse)
- - [sequence](#sequence)
-- [constructors](#constructors)
- - [blocks](#blocks)
- - [descriptionList](#descriptionlist)
- - [empty](#empty)
- - [enumeration](#enumeration)
- - [h1](#h1)
- - [h2](#h2)
- - [h3](#h3)
- - [p](#p)
-- [getters](#getters)
- - [getSpan](#getspan)
-- [mapping](#mapping)
- - [mapDescriptionList](#mapdescriptionlist)
-- [models](#models)
- - [DescriptionList (interface)](#descriptionlist-interface)
- - [Empty (interface)](#empty-interface)
- - [Enumeration (interface)](#enumeration-interface)
- - [Header (interface)](#header-interface)
- - [HelpDoc (type alias)](#helpdoc-type-alias)
- - [Paragraph (interface)](#paragraph-interface)
- - [Sequence (interface)](#sequence-interface)
-- [refinements](#refinements)
- - [isDescriptionList](#isdescriptionlist)
- - [isEmpty](#isempty)
- - [isEnumeration](#isenumeration)
- - [isHeader](#isheader)
- - [isParagraph](#isparagraph)
- - [isSequence](#issequence)
-- [rendering](#rendering)
- - [toAnsiDoc](#toansidoc)
- - [toAnsiText](#toansitext)
-
----
-
-# combinators
-
-## orElse
-
-**Signature**
-
-```ts
-export declare const orElse: { (that: HelpDoc): (self: HelpDoc) => HelpDoc; (self: HelpDoc, that: HelpDoc): HelpDoc }
-```
-
-Added in v1.0.0
-
-## sequence
-
-**Signature**
-
-```ts
-export declare const sequence: { (that: HelpDoc): (self: HelpDoc) => HelpDoc; (self: HelpDoc, that: HelpDoc): HelpDoc }
-```
-
-Added in v1.0.0
-
-# constructors
-
-## blocks
-
-**Signature**
-
-```ts
-export declare const blocks: (helpDocs: Iterable) => HelpDoc
-```
-
-Added in v1.0.0
-
-## descriptionList
-
-**Signature**
-
-```ts
-export declare const descriptionList: (definitions: readonly [[Span, HelpDoc], ...[Span, HelpDoc][]]) => HelpDoc
-```
-
-Added in v1.0.0
-
-## empty
-
-**Signature**
-
-```ts
-export declare const empty: HelpDoc
-```
-
-Added in v1.0.0
-
-## enumeration
-
-**Signature**
-
-```ts
-export declare const enumeration: (elements: readonly [HelpDoc, ...HelpDoc[]]) => HelpDoc
-```
-
-Added in v1.0.0
-
-## h1
-
-**Signature**
-
-```ts
-export declare const h1: (value: string | Span) => HelpDoc
-```
-
-Added in v1.0.0
-
-## h2
-
-**Signature**
-
-```ts
-export declare const h2: (value: string | Span) => HelpDoc
-```
-
-Added in v1.0.0
-
-## h3
-
-**Signature**
-
-```ts
-export declare const h3: (value: string | Span) => HelpDoc
-```
-
-Added in v1.0.0
-
-## p
-
-**Signature**
-
-```ts
-export declare const p: (value: string | Span) => HelpDoc
-```
-
-Added in v1.0.0
-
-# getters
-
-## getSpan
-
-**Signature**
-
-```ts
-export declare const getSpan: (self: HelpDoc) => Span
-```
-
-Added in v1.0.0
-
-# mapping
-
-## mapDescriptionList
-
-**Signature**
-
-```ts
-export declare const mapDescriptionList: {
- (f: (span: Span, helpDoc: HelpDoc) => readonly [Span, HelpDoc]): (self: HelpDoc) => HelpDoc
- (self: HelpDoc, f: (span: Span, helpDoc: HelpDoc) => readonly [Span, HelpDoc]): HelpDoc
-}
-```
-
-Added in v1.0.0
-
-# models
-
-## DescriptionList (interface)
-
-**Signature**
-
-```ts
-export interface DescriptionList {
- readonly _tag: "DescriptionList"
- readonly definitions: NonEmptyReadonlyArray
-}
-```
-
-Added in v1.0.0
-
-## Empty (interface)
-
-**Signature**
-
-```ts
-export interface Empty {
- readonly _tag: "Empty"
-}
-```
-
-Added in v1.0.0
-
-## Enumeration (interface)
-
-**Signature**
-
-```ts
-export interface Enumeration {
- readonly _tag: "Enumeration"
- readonly elements: NonEmptyReadonlyArray
-}
-```
-
-Added in v1.0.0
-
-## Header (interface)
-
-**Signature**
-
-```ts
-export interface Header {
- readonly _tag: "Header"
- readonly value: Span
- readonly level: number
-}
-```
-
-Added in v1.0.0
-
-## HelpDoc (type alias)
-
-A `HelpDoc` models the full documentation for a command-line application.
-
-`HelpDoc` is composed of optional header and footers, and in-between, a
-list of HelpDoc-level content items.
-
-HelpDoc-level content items, in turn, can be headers, paragraphs, description
-lists, and enumerations.
-
-A `HelpDoc` can be converted into plaintext, JSON, and HTML.
-
-**Signature**
-
-```ts
-export type HelpDoc = Empty | Header | Paragraph | DescriptionList | Enumeration | Sequence
-```
-
-Added in v1.0.0
-
-## Paragraph (interface)
-
-**Signature**
-
-```ts
-export interface Paragraph {
- readonly _tag: "Paragraph"
- readonly value: Span
-}
-```
-
-Added in v1.0.0
-
-## Sequence (interface)
-
-**Signature**
-
-```ts
-export interface Sequence {
- readonly _tag: "Sequence"
- readonly left: HelpDoc
- readonly right: HelpDoc
-}
-```
-
-Added in v1.0.0
-
-# refinements
-
-## isDescriptionList
-
-**Signature**
-
-```ts
-export declare const isDescriptionList: (helpDoc: HelpDoc) => helpDoc is DescriptionList
-```
-
-Added in v1.0.0
-
-## isEmpty
-
-**Signature**
-
-```ts
-export declare const isEmpty: (helpDoc: HelpDoc) => helpDoc is Empty
-```
-
-Added in v1.0.0
-
-## isEnumeration
-
-**Signature**
-
-```ts
-export declare const isEnumeration: (helpDoc: HelpDoc) => helpDoc is Enumeration
-```
-
-Added in v1.0.0
-
-## isHeader
-
-**Signature**
-
-```ts
-export declare const isHeader: (helpDoc: HelpDoc) => helpDoc is Header
-```
-
-Added in v1.0.0
-
-## isParagraph
-
-**Signature**
-
-```ts
-export declare const isParagraph: (helpDoc: HelpDoc) => helpDoc is Paragraph
-```
-
-Added in v1.0.0
-
-## isSequence
-
-**Signature**
-
-```ts
-export declare const isSequence: (helpDoc: HelpDoc) => helpDoc is Sequence
-```
-
-Added in v1.0.0
-
-# rendering
-
-## toAnsiDoc
-
-**Signature**
-
-```ts
-export declare const toAnsiDoc: (self: HelpDoc) => AnsiDoc
-```
-
-Added in v1.0.0
-
-## toAnsiText
-
-**Signature**
-
-```ts
-export declare const toAnsiText: (self: HelpDoc) => string
-```
-
-Added in v1.0.0
diff --git a/docs/modules/HelpDoc/Span.ts.md b/docs/modules/HelpDoc/Span.ts.md
deleted file mode 100644
index cbe5196..0000000
--- a/docs/modules/HelpDoc/Span.ts.md
+++ /dev/null
@@ -1,314 +0,0 @@
----
-title: HelpDoc/Span.ts
-nav_order: 11
-parent: Modules
----
-
-## Span overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [combinators](#combinators)
- - [concat](#concat)
- - [spans](#spans)
-- [constructors](#constructors)
- - [code](#code)
- - [empty](#empty)
- - [error](#error)
- - [space](#space)
- - [strong](#strong)
- - [text](#text)
- - [uri](#uri)
- - [weak](#weak)
-- [models](#models)
- - [Code (interface)](#code-interface)
- - [Error (interface)](#error-interface)
- - [Sequence (interface)](#sequence-interface)
- - [Span (type alias)](#span-type-alias)
- - [Strong (interface)](#strong-interface)
- - [Text (interface)](#text-interface)
- - [URI (interface)](#uri-interface)
- - [Weak (interface)](#weak-interface)
-- [refinements](#refinements)
- - [isError](#iserror)
- - [isSequence](#issequence)
- - [isStrong](#isstrong)
- - [isText](#istext)
- - [isUri](#isuri)
- - [isWeak](#isweak)
-
----
-
-# combinators
-
-## concat
-
-**Signature**
-
-```ts
-export declare const concat: { (that: Span): (self: Span) => Span; (self: Span, that: Span): Span }
-```
-
-Added in v1.0.0
-
-## spans
-
-**Signature**
-
-```ts
-export declare const spans: (spans: Iterable) => Span
-```
-
-Added in v1.0.0
-
-# constructors
-
-## code
-
-**Signature**
-
-```ts
-export declare const code: (value: string) => Span
-```
-
-Added in v1.0.0
-
-## empty
-
-**Signature**
-
-```ts
-export declare const empty: Span
-```
-
-Added in v1.0.0
-
-## error
-
-**Signature**
-
-```ts
-export declare const error: (value: string | Span) => Span
-```
-
-Added in v1.0.0
-
-## space
-
-**Signature**
-
-```ts
-export declare const space: Span
-```
-
-Added in v1.0.0
-
-## strong
-
-**Signature**
-
-```ts
-export declare const strong: (value: string | Span) => Span
-```
-
-Added in v1.0.0
-
-## text
-
-**Signature**
-
-```ts
-export declare const text: (value: string) => Span
-```
-
-Added in v1.0.0
-
-## uri
-
-**Signature**
-
-```ts
-export declare const uri: (value: string) => Span
-```
-
-Added in v1.0.0
-
-## weak
-
-**Signature**
-
-```ts
-export declare const weak: (value: string | Span) => Span
-```
-
-Added in v1.0.0
-
-# models
-
-## Code (interface)
-
-**Signature**
-
-```ts
-export interface Code {
- readonly _tag: "Code"
- readonly value: string
-}
-```
-
-Added in v1.0.0
-
-## Error (interface)
-
-**Signature**
-
-```ts
-export interface Error {
- readonly _tag: "Error"
- readonly value: Span
-}
-```
-
-Added in v1.0.0
-
-## Sequence (interface)
-
-**Signature**
-
-```ts
-export interface Sequence {
- readonly _tag: "Sequence"
- readonly left: Span
- readonly right: Span
-}
-```
-
-Added in v1.0.0
-
-## Span (type alias)
-
-**Signature**
-
-```ts
-export type Span = Text | Code | Error | Weak | Strong | URI | Sequence
-```
-
-Added in v1.0.0
-
-## Strong (interface)
-
-**Signature**
-
-```ts
-export interface Strong {
- readonly _tag: "Strong"
- readonly value: Span
-}
-```
-
-Added in v1.0.0
-
-## Text (interface)
-
-**Signature**
-
-```ts
-export interface Text {
- readonly _tag: "Text"
- readonly value: string
-}
-```
-
-Added in v1.0.0
-
-## URI (interface)
-
-**Signature**
-
-```ts
-export interface URI {
- readonly _tag: "URI"
- readonly value: string
-}
-```
-
-Added in v1.0.0
-
-## Weak (interface)
-
-**Signature**
-
-```ts
-export interface Weak {
- readonly _tag: "Weak"
- readonly value: Span
-}
-```
-
-Added in v1.0.0
-
-# refinements
-
-## isError
-
-**Signature**
-
-```ts
-export declare const isError: (self: Span) => self is Error
-```
-
-Added in v1.0.0
-
-## isSequence
-
-**Signature**
-
-```ts
-export declare const isSequence: (self: Span) => self is Sequence
-```
-
-Added in v1.0.0
-
-## isStrong
-
-**Signature**
-
-```ts
-export declare const isStrong: (self: Span) => self is Strong
-```
-
-Added in v1.0.0
-
-## isText
-
-**Signature**
-
-```ts
-export declare const isText: (self: Span) => self is Text
-```
-
-Added in v1.0.0
-
-## isUri
-
-**Signature**
-
-```ts
-export declare const isUri: (self: Span) => self is URI
-```
-
-Added in v1.0.0
-
-## isWeak
-
-**Signature**
-
-```ts
-export declare const isWeak: (self: Span) => self is Weak
-```
-
-Added in v1.0.0
diff --git a/docs/modules/Options.ts.md b/docs/modules/Options.ts.md
deleted file mode 100644
index a5d4290..0000000
--- a/docs/modules/Options.ts.md
+++ /dev/null
@@ -1,601 +0,0 @@
----
-title: Options.ts
-nav_order: 13
-parent: Modules
----
-
-## Options overview
-
-Added in v1.0.0
-
----
-
-Table of contents
-
-- [combinators](#combinators)
- - [filterMap](#filtermap)
- - [isBool](#isbool)
- - [map](#map)
- - [mapOrFail](#maporfail)
- - [mapTryCatch](#maptrycatch)
- - [optional](#optional)
- - [orElse](#orelse)
- - [orElseEither](#orelseeither)
- - [toRegularLanguage](#toregularlanguage)
- - [validate](#validate)
- - [withAlias](#withalias)
- - [withDefault](#withdefault)
- - [withDescription](#withdescription)
- - [withPseudoName](#withpseudoname)
-- [constructors](#constructors)
- - [all](#all)
- - [boolean](#boolean)
- - [choice](#choice)
- - [choiceWithValue](#choicewithvalue)
- - [date](#date)
- - [directory](#directory)
- - [file](#file)
- - [float](#float)
- - [integer](#integer)
- - [keyValueMap](#keyvaluemap)
- - [none](#none)
- - [text](#text)
-- [models](#models)
- - [Options (interface)](#options-interface)
-- [refinements](#refinements)
- - [isOptions](#isoptions)
-- [symbols](#symbols)
- - [OptionsTypeId](#optionstypeid)
- - [OptionsTypeId (type alias)](#optionstypeid-type-alias)
-- [utils](#utils)
- - [All (namespace)](#all-namespace)
- - [OptionsAny (type alias)](#optionsany-type-alias)
- - [Return (type alias)](#return-type-alias)
- - [ReturnIterable (type alias)](#returniterable-type-alias)
- - [ReturnObject (type alias)](#returnobject-type-alias)
- - [ReturnTuple (type alias)](#returntuple-type-alias)
- - [Options (namespace)](#options-namespace)
- - [BooleanOptionsConfig (interface)](#booleanoptionsconfig-interface)
- - [PathOptionsConfig (interface)](#pathoptionsconfig-interface)
- - [Variance (interface)](#variance-interface)
-
----
-
-# combinators
-
-## filterMap
-
-**Signature**
-
-```ts
-export declare const filterMap: {
- (f: (a: A) => Option, message: string): (self: Options) => Options
- (self: Options, f: (a: A) => Option, message: string): Options
-}
-```
-
-Added in v1.0.0
-
-## isBool
-
-Returns `true` if the specified `Options` is a boolean flag, `false`
-otherwise.
-
-**Signature**
-
-```ts
-export declare const isBool: (self: Options) => boolean
-```
-
-Added in v1.0.0
-
-## map
-
-**Signature**
-
-```ts
-export declare const map: {
- (f: (a: A) => B): (self: Options) => Options
- (self: Options, f: (a: A) => B): Options
-}
-```
-
-Added in v1.0.0
-
-## mapOrFail
-
-**Signature**
-
-```ts
-export declare const mapOrFail: {
- (f: (a: A) => Either): (self: Options) => Options
- (self: Options, f: (a: A) => Either): Options
-}
-```
-
-Added in v1.0.0
-
-## mapTryCatch
-
-**Signature**
-
-```ts
-export declare const mapTryCatch: {
- (f: (a: A) => B, onError: (e: unknown) => HelpDoc): (self: Options) => Options
- (self: Options, f: (a: A) => B, onError: (e: unknown) => HelpDoc): Options
-}
-```
-
-Added in v1.0.0
-
-## optional
-
-**Signature**
-
-```ts
-export declare const optional: (self: Options) => Options>
-```
-
-Added in v1.0.0
-
-## orElse
-
-**Signature**
-
-```ts
-export declare const orElse: {
- (that: Options): (self: Options) => Options
- (self: Options, that: Options): Options
-}
-```
-
-Added in v1.0.0
-
-## orElseEither
-
-**Signature**
-
-```ts
-export declare const orElseEither: {
- (that: Options): (self: Options) => Options>
- (self: Options, that: Options): Options>
-}
-```
-
-Added in v1.0.0
-
-## toRegularLanguage
-
-Returns a `RegularLanguage` whose accepted language is equivalent to the language accepted by the provided
-`Options`.
-
-**Signature**
-
-```ts
-export declare const toRegularLanguage: (self: Options) => RegularLanguage
-```
-
-Added in v1.0.0
-
-## validate
-
-**Signature**
-
-```ts
-export declare const validate: {
- (
- args: ReadonlyArray,
- config: CliConfig
- ): (
- self: Options
- ) => Effect, readonly string[], A]>
- (
- self: Options,
- args: ReadonlyArray,
- config: CliConfig
- ): Effect, readonly string[], A]>
-}
-```
-
-Added in v1.0.0
-
-## withAlias
-
-**Signature**
-
-```ts
-export declare const withAlias: {
- (alias: string): (self: Options) => Options
- (self: Options, alias: string): Options
-}
-```
-
-Added in v1.0.0
-
-## withDefault
-
-**Signature**
-
-```ts
-export declare const withDefault: {
- (fallback: A): (self: Options) => Options
- (self: Options, fallback: A): Options
-}
-```
-
-Added in v1.0.0
-
-## withDescription
-
-**Signature**
-
-```ts
-export declare const withDescription: {
- (description: string): (self: Options) => Options
- (self: Options, description: string): Options
-}
-```
-
-Added in v1.0.0
-
-## withPseudoName
-
-**Signature**
-
-```ts
-export declare const withPseudoName: {
- (pseudoName: string): (self: Options) => Options
- (self: Options, pseudoName: string): Options
-}
-```
-
-Added in v1.0.0
-
-# constructors
-
-## all
-
-**Signature**
-
-```ts
-export declare const all: > | Record>>(
- arg: Arg
-) => All.Return
-```
-
-Added in v1.0.0
-
-## boolean
-
-**Signature**
-
-```ts
-export declare const boolean: (name: string, options?: Options.BooleanOptionsConfig) => Options
-```
-
-Added in v1.0.0
-
-## choice
-
-Constructs command-line `Options` that represent a choice between several
-inputs. The input will be mapped to it's associated value during parsing.
-
-**Signature**
-
-```ts
-export declare const choice: (
- name: string,
- choices: C
-) => Options
-```
-
-**Example**
-
-```ts
-import * as Options from "@effect/cli/Options"
-
-export const animal: Options.Options<"dog" | "cat"> = Options.choice("animal", ["dog", "cat"])
-```
-
-Added in v1.0.0
-
-## choiceWithValue
-
-Constructs command-line `Options` that represent a choice between several
-inputs. The input will be mapped to it's associated value during parsing.
-
-**Signature**
-
-```ts
-export declare const choiceWithValue: (
- name: string,
- choices: C
-) => Options
-```
-
-**Example**
-
-```ts
-import * as Options from "@effect/cli/Options"
-import * as Data from "effect/Data"
-
-export type Animal = Dog | Cat
-
-export interface Dog extends Data.Case {
- readonly _tag: "Dog"
-}
-
-export const Dog = Data.tagged("Dog")
-
-export interface Cat extends Data.Case {
- readonly _tag: "Cat"
-}
-
-export const Cat = Data.tagged("Cat")
-
-export const animal: Options.Options = Options.choiceWithValue("animal", [
- ["dog", Dog()],
- ["cat", Cat()]
-])
-```
-
-Added in v1.0.0
-
-## date
-
-**Signature**
-
-```ts
-export declare const date: (name: string) => Options
-```
-
-Added in v1.0.0
-
-## directory
-
-Creates a parameter expecting path to a directory.
-
-**Signature**
-
-```ts
-export declare const directory: (name: string, config: Options.PathOptionsConfig) => Options
-```
-
-Added in v1.0.0
-
-## file
-
-Creates a parameter expecting path to a file.
-
-**Signature**
-
-```ts
-export declare const file: (name: string, config: Options.PathOptionsConfig) => Options
-```
-
-Added in v1.0.0
-
-## float
-
-**Signature**
-
-```ts
-export declare const float: (name: string) => Options
-```
-
-Added in v1.0.0
-
-## integer
-
-**Signature**
-
-```ts
-export declare const integer: (name: string) => Options
-```
-
-Added in v1.0.0
-
-## keyValueMap
-
-**Signature**
-
-```ts
-export declare const keyValueMap: (name: string) => Options>
-```
-
-Added in v1.0.0
-
-## none
-
-**Signature**
-
-```ts
-export declare const none: Options
-```
-
-Added in v1.0.0
-
-## text
-
-**Signature**
-
-```ts
-export declare const text: (name: string) => Options
-```
-
-Added in v1.0.0
-
-# models
-
-## Options (interface)
-
-**Signature**
-
-```ts
-export interface Options extends Options.Variance, Parameter, Pipeable {
- get identifier(): Option
- get usage(): Usage
- get flattened(): ReadonlyArray
- validate(args: HashMap>, config: CliConfig): Effect