EdgeAIG's picture
download
raw
58.8 kB
/** * Main building block for defining and running Effect-based command-line * applications. * * A `Command` combines a name, typed flags and positional arguments, optional * subcommands, help metadata, and an effectful handler. The module includes * builders for command trees and the runners that parse command-line input, * handle built-in help and version behavior, render help through `CliOutput`, * and execute the selected handler. * * @since 4.0.0 */ import type { NonEmptyReadonlyArray } from "../../Array.ts"; import * as Context from "../../Context.ts"; import * as Effect from "../../Effect.ts"; import type * as FileSystem from "../../FileSystem.ts"; import type * as Layer from "../../Layer.ts"; import * as Option from "../../Option.ts"; import type * as Path from "../../Path.ts"; import * as Stdio from "../../Stdio.ts"; import * as Terminal from "../../Terminal.ts"; import type { Contravariant, Covariant, NoInfer, Simplify } from "../../Types.ts"; import type { ChildProcessSpawner } from "../process/ChildProcessSpawner.ts"; import * as CliError from "./CliError.ts"; import * as GlobalFlag from "./GlobalFlag.ts"; import { TypeId } from "./internal/command.ts"; import * as Param from "./Param.ts"; /** * Represents a CLI command with its configuration, handler, and metadata. * * **Details** * * Commands are the core building blocks of CLI applications. They define: * * - The command name and description * - Configuration including flags and arguments * - Handler function for execution * - Optional subcommands for hierarchical structures * * **Example** (Defining CLI commands) * * ```ts * import { Console } from "effect" * import { Argument, Command, Flag } from "effect/unstable/cli" * * // Simple command with no configuration * const version: Command.Command<"version", {}, {}, never, never> = Command.make( * "version" * ) * * // Command with flags and arguments * const deploy: Command.Command< * "deploy", * { * readonly env: string * readonly force: boolean * readonly files: ReadonlyArray<string> * }, * {}, * never, * never * > = Command.make("deploy", { * env: Flag.string("env"), * force: Flag.boolean("force"), * files: Argument.string("files").pipe(Argument.variadic()) * }) * * // Command with handler * const greet = Command.make("greet", { * name: Flag.string("name") * }, (config) => Console.log(`Hello, ${config.name}!`)) * ``` * * @category models * @since 4.0.0 */ export interface Command<in out Name extends string, in Input, out ContextInput = {}, out E = never, out R = never> extends Effect.Effect<ContextInput, never, CommandContext<Name>> { readonly [TypeId]: Command.Variance<Input, E, R>; /** * The name of the command. */ readonly name: Name; /** * An optional description of the command. */ readonly description: string | undefined; /** * An optional short description used when listing subcommands. */ readonly shortDescription: string | undefined; /** * An optional alias that can be used as a shorter command name. */ readonly alias: string | undefined; /** * Optional usage examples for the command. */ readonly examples: ReadonlyArray<Command.Example>; /** * The subcommands available under this command. */ readonly subcommands: ReadonlyArray<{ readonly group: string | undefined; readonly commands: NonEmptyReadonlyArray<Command.Any>; }>; /** * Custom annotations associated with this command. */ readonly annotations: Context.Context<never>; /** * Whether this command is hidden from parent help output, shell * completions, and unknown-subcommand suggestions. Hidden commands still * parse and execute normally when invoked by exact name. */ readonly hidden: boolean; } /** * Companion namespace containing type-level helpers and configuration shapes * used by `Command`. * * @since 4.0.0 */ export declare namespace Command { /** * Type-level variance marker for `Command`. * * **Details** * * The parsed input type is contravariant, while the command error and service * requirement types are covariant. * * @category models * @since 4.0.0 */ interface Variance<in Input, out E, out R> { readonly Input: Contravariant<Input>; readonly E: Covariant<E>; readonly R: Covariant<R>; } /** * Represents a concrete usage example for a command. * * @category models * @since 4.0.0 */ interface Example { readonly command: string; readonly description?: string | undefined; } /** * Configuration object for defining command flags, arguments, and nested structures. * * **Details** * * `Command.Config` can contain individual flags and arguments using `Param` * types, nested configuration objects for organization, and arrays of * parameters for repeated elements. * * **Example** (Configuring command input) * * ```ts * import { Argument, Flag } from "effect/unstable/cli" * import type { Command as CliCommand } from "effect/unstable/cli" * * // Simple flat configuration * const simpleConfig: CliCommand.Command.Config = { * name: Flag.string("name"), * age: Flag.integer("age"), * file: Argument.string("file") * } * * // Nested configuration for organization * const nestedConfig: CliCommand.Command.Config = { * user: { * name: Flag.string("name"), * email: Flag.string("email") * }, * server: { * host: Flag.string("host"), * port: Flag.integer("port") * } * } * ``` * * @category models * @since 4.0.0 */ interface Config { readonly [key: string]: Param.Param<Param.ParamKind, any> | ReadonlyArray<Param.Param<Param.ParamKind, any> | Config> | Config; } /** * Configuration shape accepted by `Command.withSharedFlags`. * * **Details** * * Only flags are allowed here; arguments are intentionally excluded. * * @category models * @since 4.0.0 */ interface FlagConfig { readonly [key: string]: Param.Param<typeof Param.flagKind, any> | ReadonlyArray<Param.Param<typeof Param.flagKind, any> | FlagConfig> | FlagConfig; } /** * Utilities for working with command configurations. * * @since 4.0.0 */ namespace Config { /** * Infers the TypeScript type from a Command.Config structure. * * **Details** * * This type utility extracts the final configuration type that handlers will receive, * preserving the nested structure while converting Param types to their values. * * **Example** (Inferring command input) * * ```ts * import { Flag } from "effect/unstable/cli" * import type { Command as CliCommand } from "effect/unstable/cli" * * const config = { * name: Flag.string("name"), * server: { * host: Flag.string("host"), * port: Flag.integer("port") * } * } as const * * type Result = CliCommand.Command.Config.Infer<typeof config> * // { * // readonly name: string * // readonly server: { * // readonly host: string * // readonly port: number * // } * // } * ``` * * @category models * @since 4.0.0 */ type Infer<A extends Config> = Simplify<{ readonly [Key in keyof A]: InferValue<A[Key]>; }>; /** * Helper type utility for recursively inferring types from Config values. * * @category models * @since 4.0.0 */ type InferValue<A> = A extends ReadonlyArray<any> ? { readonly [Key in keyof A]: InferValue<A[Key]>; } : A extends Param.Param<infer _Kind, infer _Value> ? _Value : A extends Config ? Infer<A> : never; } /** * Represents any Command regardless of its type parameters. * * @category models * @since 4.0.0 */ interface Any extends Effect.Effect<any, never, any> { readonly [TypeId]: any; readonly name: string; readonly description: string | undefined; readonly shortDescription: string | undefined; readonly alias: string | undefined; readonly examples: ReadonlyArray<Command.Example>; readonly subcommands: ReadonlyArray<{ readonly group: string | undefined; readonly commands: NonEmptyReadonlyArray<Command.Any>; }>; readonly annotations: Context.Context<never>; readonly hidden: boolean; } /** * A grouped set of subcommands used by `Command.withSubcommands`. * * @category models * @since 4.0.0 */ interface SubcommandGroup<Commands extends ReadonlyArray<Any> = ReadonlyArray<Any>> { readonly group: string; readonly commands: Commands; } /** * Entry type accepted by `Command.withSubcommands`. * * @category models * @since 4.0.0 */ type SubcommandEntry = Any | SubcommandGroup<ReadonlyArray<Any>>; } /** * Services required by CLI parsing and execution. * * **Details** * * This includes file-system and path services for arguments, terminal and * stdio services for running commands, and child-process spawning for * process-related CLI features. * * @category utility types * @since 4.0.0 */ export type Environment = FileSystem.FileSystem | Path.Path | Terminal.Terminal | ChildProcessSpawner | Stdio.Stdio; /** * A utility type to extract the error type from a `Command`. * * @category utility types * @since 4.0.0 */ export type Error<C> = C extends Command<infer _Name, infer _Input, infer _ContextInput, infer _Error, infer _Requirements> ? _Error : never; /** * Service context for a specific command, enabling subcommands to access their parent's parsed configuration. * * **Details** * * When a subcommand handler needs access to flags or arguments from a parent command, * it can yield the parent command directly to retrieve its config. This is powered by * Effect's service system - each command automatically creates a service that provides * its parsed input to child commands. * * **Example** (Accessing parent command context) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const parent = Command.make("app").pipe( * Command.withSharedFlags({ * verbose: Flag.boolean("verbose"), * config: Flag.string("config") * }) * ) * * const child = Command.make("deploy", { * target: Flag.string("target") * }, (config) => * Effect.gen(function*() { * // Access parent's config by yielding the parent command * const parentConfig = yield* parent * yield* Console.log(`Verbose: ${parentConfig.verbose}`) * yield* Console.log(`Config: ${parentConfig.config}`) * yield* Console.log(`Target: ${config.target}`) * })) * * const app = parent.pipe(Command.withSubcommands([child])) * // Usage: app --verbose --config prod.json deploy --target staging * ``` * * @category models * @since 4.0.0 */ export interface CommandContext<Name extends string> { readonly _: unique symbol; readonly name: Name; } /** * Represents the parsed tokens from command-line input before validation. * * @category models * @since 4.0.0 */ export interface ParsedTokens { readonly flags: Record<string, ReadonlyArray<string>>; readonly arguments: ReadonlyArray<string>; readonly errors?: ReadonlyArray<CliError.NonShowHelpErrors>; readonly subcommand: Option.Option<{ readonly name: string; readonly parsedInput: ParsedTokens; }>; } /** * Returns `true` if the provided value is a `Command`. * * **Gotchas** * * This checks for the `Command` type-id property; it does not validate the full * command shape. * * @category guards * @since 4.0.0 */ export declare const isCommand: (u: unknown) => u is Command.Any; /** * Creates a `Command` from a name, an optional configuration, and an optional * handler. * * **Details** * * Use `withDescription` and related metadata combinators to add help text. The * overloads support simple commands, configured commands, and commands with * effectful handlers. * * **Example** (Creating commands) * * ```ts * import { Console, Effect } from "effect" * import { Argument, Command, Flag } from "effect/unstable/cli" * * // Simple command with no configuration * const version = Command.make("version") * * // Command with simple flags * const greet = Command.make("greet", { * name: Flag.string("name"), * count: Flag.integer("count").pipe(Flag.withDefault(1)) * }) * * // Command with nested configuration * const deploy = Command.make("deploy", { * environment: Flag.string("env").pipe( * Flag.withDescription("Target environment") * ), * server: { * host: Flag.string("host").pipe(Flag.withDefault("localhost")), * port: Flag.integer("port").pipe(Flag.withDefault(3000)) * }, * files: Argument.string("files").pipe(Argument.variadic), * force: Flag.boolean("force").pipe(Flag.withDescription("Force deployment")) * }) * * // Command with handler * const deployWithHandler = Command.make("deploy", { * environment: Flag.string("env"), * force: Flag.boolean("force") * }, (config) => * Effect.gen(function*() { * yield* Console.log(`Starting deployment to ${config.environment}`) * * if (!config.force && config.environment === "production") { * return yield* Effect.fail("Production deployments require --force flag") * } * * yield* Console.log("Deployment completed successfully") * })) * ``` * * @category constructors * @since 4.0.0 */ export declare const make: { /** * Creates a `Command` from a name, an optional configuration, and an optional * handler. * * **Details** * * Use `withDescription` and related metadata combinators to add help text. The * overloads support simple commands, configured commands, and commands with * effectful handlers. * * **Example** (Creating commands) * * ```ts * import { Console, Effect } from "effect" * import { Argument, Command, Flag } from "effect/unstable/cli" * * // Simple command with no configuration * const version = Command.make("version") * * // Command with simple flags * const greet = Command.make("greet", { * name: Flag.string("name"), * count: Flag.integer("count").pipe(Flag.withDefault(1)) * }) * * // Command with nested configuration * const deploy = Command.make("deploy", { * environment: Flag.string("env").pipe( * Flag.withDescription("Target environment") * ), * server: { * host: Flag.string("host").pipe(Flag.withDefault("localhost")), * port: Flag.integer("port").pipe(Flag.withDefault(3000)) * }, * files: Argument.string("files").pipe(Argument.variadic), * force: Flag.boolean("force").pipe(Flag.withDescription("Force deployment")) * }) * * // Command with handler * const deployWithHandler = Command.make("deploy", { * environment: Flag.string("env"), * force: Flag.boolean("force") * }, (config) => * Effect.gen(function*() { * yield* Console.log(`Starting deployment to ${config.environment}`) * * if (!config.force && config.environment === "production") { * return yield* Effect.fail("Production deployments require --force flag") * } * * yield* Console.log("Deployment completed successfully") * })) * ``` * * @category constructors * @since 4.0.0 */ <Name extends string>(name: Name): Command<Name, {}, {}, never, never>; /** * Creates a `Command` from a name, an optional configuration, and an optional * handler. * * **Details** * * Use `withDescription` and related metadata combinators to add help text. The * overloads support simple commands, configured commands, and commands with * effectful handlers. * * **Example** (Creating commands) * * ```ts * import { Console, Effect } from "effect" * import { Argument, Command, Flag } from "effect/unstable/cli" * * // Simple command with no configuration * const version = Command.make("version") * * // Command with simple flags * const greet = Command.make("greet", { * name: Flag.string("name"), * count: Flag.integer("count").pipe(Flag.withDefault(1)) * }) * * // Command with nested configuration * const deploy = Command.make("deploy", { * environment: Flag.string("env").pipe( * Flag.withDescription("Target environment") * ), * server: { * host: Flag.string("host").pipe(Flag.withDefault("localhost")), * port: Flag.integer("port").pipe(Flag.withDefault(3000)) * }, * files: Argument.string("files").pipe(Argument.variadic), * force: Flag.boolean("force").pipe(Flag.withDescription("Force deployment")) * }) * * // Command with handler * const deployWithHandler = Command.make("deploy", { * environment: Flag.string("env"), * force: Flag.boolean("force") * }, (config) => * Effect.gen(function*() { * yield* Console.log(`Starting deployment to ${config.environment}`) * * if (!config.force && config.environment === "production") { * return yield* Effect.fail("Production deployments require --force flag") * } * * yield* Console.log("Deployment completed successfully") * })) * ``` * * @category constructors * @since 4.0.0 */ <Name extends string, const Config extends Command.Config>(name: Name, config: Config): Command<Name, Command.Config.Infer<Config>, {}, never, never>; /** * Creates a `Command` from a name, an optional configuration, and an optional * handler. * * **Details** * * Use `withDescription` and related metadata combinators to add help text. The * overloads support simple commands, configured commands, and commands with * effectful handlers. * * **Example** (Creating commands) * * ```ts * import { Console, Effect } from "effect" * import { Argument, Command, Flag } from "effect/unstable/cli" * * // Simple command with no configuration * const version = Command.make("version") * * // Command with simple flags * const greet = Command.make("greet", { * name: Flag.string("name"), * count: Flag.integer("count").pipe(Flag.withDefault(1)) * }) * * // Command with nested configuration * const deploy = Command.make("deploy", { * environment: Flag.string("env").pipe( * Flag.withDescription("Target environment") * ), * server: { * host: Flag.string("host").pipe(Flag.withDefault("localhost")), * port: Flag.integer("port").pipe(Flag.withDefault(3000)) * }, * files: Argument.string("files").pipe(Argument.variadic), * force: Flag.boolean("force").pipe(Flag.withDescription("Force deployment")) * }) * * // Command with handler * const deployWithHandler = Command.make("deploy", { * environment: Flag.string("env"), * force: Flag.boolean("force") * }, (config) => * Effect.gen(function*() { * yield* Console.log(`Starting deployment to ${config.environment}`) * * if (!config.force && config.environment === "production") { * return yield* Effect.fail("Production deployments require --force flag") * } * * yield* Console.log("Deployment completed successfully") * })) * ``` * * @category constructors * @since 4.0.0 */ <Name extends string, const Config extends Command.Config, R, E>(name: Name, config: Config, handler: (config: Command.Config.Infer<Config>) => Effect.Effect<void, E, R>): Command<Name, Command.Config.Infer<Config>, {}, E, Exclude<R, GlobalFlag.BuiltInSettingContext>>; }; /** * Adds or replaces the handler for a command. * * **Example** (Adding command handlers) * * ```ts * import { Console } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * // Command without initial handler * const greet = Command.make("greet", { * name: Flag.string("name") * }) * * // Add handler later * const greetWithHandler = greet.pipe( * Command.withHandler((config: { readonly name: string }) => * Console.log(`Hello, ${config.name}!`) * ) * ) * ``` * * @category combinators * @since 4.0.0 */ export declare const withHandler: { /** * Adds or replaces the handler for a command. * * **Example** (Adding command handlers) * * ```ts * import { Console } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * // Command without initial handler * const greet = Command.make("greet", { * name: Flag.string("name") * }) * * // Add handler later * const greetWithHandler = greet.pipe( * Command.withHandler((config: { readonly name: string }) => * Console.log(`Hello, ${config.name}!`) * ) * ) * ``` * * @category combinators * @since 4.0.0 */ <A, R, E>(handler: (value: A) => Effect.Effect<void, E, R>): <Name extends string, XR, XE, ContextInput>(self: Command<Name, A, ContextInput, XE, XR>) => Command<Name, A, ContextInput, E, Exclude<R, GlobalFlag.BuiltInSettingContext>>; /** * Adds or replaces the handler for a command. * * **Example** (Adding command handlers) * * ```ts * import { Console } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * // Command without initial handler * const greet = Command.make("greet", { * name: Flag.string("name") * }) * * // Add handler later * const greetWithHandler = greet.pipe( * Command.withHandler((config: { readonly name: string }) => * Console.log(`Hello, ${config.name}!`) * ) * ) * ``` * * @category combinators * @since 4.0.0 */ <Name extends string, A, XR, XE, R, E, ContextInput>(self: Command<Name, A, ContextInput, XE, XR>, handler: (value: A) => Effect.Effect<void, E, R>): Command<Name, A, ContextInput, E, Exclude<R, GlobalFlag.BuiltInSettingContext>>; }; /** * Adds subcommands to a command, creating a hierarchical command structure. * * **Details** * * Subcommands can access their parent's parsed configuration by yielding the parent * command within their handler. This enables shared parent flags that affect * all subcommands. * * **Example** (Adding subcommands) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * // Parent command with shared flags * const git = Command.make("git").pipe( * Command.withSharedFlags({ * verbose: Flag.boolean("verbose") * }) * ) * * // Subcommand that accesses parent config * const clone = Command.make("clone", { * repository: Flag.string("repo") * }, (config) => * Effect.gen(function*() { * const parent = yield* git // Access parent's parsed config * if (parent.verbose) { * yield* Console.log("Verbose mode enabled") * } * yield* Console.log(`Cloning ${config.repository}`) * })) * * const app = git.pipe(Command.withSubcommands([clone])) * // Usage: git --verbose clone --repo github.com/foo/bar * ``` * * @category combinators * @since 4.0.0 */ export declare const withSubcommands: { /** * Adds subcommands to a command, creating a hierarchical command structure. * * **Details** * * Subcommands can access their parent's parsed configuration by yielding the parent * command within their handler. This enables shared parent flags that affect * all subcommands. * * **Example** (Adding subcommands) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * // Parent command with shared flags * const git = Command.make("git").pipe( * Command.withSharedFlags({ * verbose: Flag.boolean("verbose") * }) * ) * * // Subcommand that accesses parent config * const clone = Command.make("clone", { * repository: Flag.string("repo") * }, (config) => * Effect.gen(function*() { * const parent = yield* git // Access parent's parsed config * if (parent.verbose) { * yield* Console.log("Verbose mode enabled") * } * yield* Console.log(`Cloning ${config.repository}`) * })) * * const app = git.pipe(Command.withSubcommands([clone])) * // Usage: git --verbose clone --repo github.com/foo/bar * ``` * * @category combinators * @since 4.0.0 */ <const Subcommands extends ReadonlyArray<Command.SubcommandEntry>>(subcommands: Subcommands): <Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Simplify<Input | ContextInput>, ContextInput, E | ExtractSubcommandErrors<Subcommands>, R | Exclude<ExtractSubcommandContext<Subcommands>, CommandContext<Name>>>; /** * Adds subcommands to a command, creating a hierarchical command structure. * * **Details** * * Subcommands can access their parent's parsed configuration by yielding the parent * command within their handler. This enables shared parent flags that affect * all subcommands. * * **Example** (Adding subcommands) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * // Parent command with shared flags * const git = Command.make("git").pipe( * Command.withSharedFlags({ * verbose: Flag.boolean("verbose") * }) * ) * * // Subcommand that accesses parent config * const clone = Command.make("clone", { * repository: Flag.string("repo") * }, (config) => * Effect.gen(function*() { * const parent = yield* git // Access parent's parsed config * if (parent.verbose) { * yield* Console.log("Verbose mode enabled") * } * yield* Console.log(`Cloning ${config.repository}`) * })) * * const app = git.pipe(Command.withSubcommands([clone])) * // Usage: git --verbose clone --repo github.com/foo/bar * ``` * * @category combinators * @since 4.0.0 */ <Name extends string, Input, E, R, ContextInput, const Subcommands extends ReadonlyArray<Command.SubcommandEntry>>(self: Command<Name, Input, ContextInput, E, R>, subcommands: Subcommands): Command<Name, Simplify<Input | ContextInput>, ContextInput, E | ExtractSubcommandErrors<Subcommands>, R | Exclude<ExtractSubcommandContext<Subcommands>, CommandContext<Name>>>; }; /** * Adds flags that are inherited by subcommands. * * **Details** * * Shared flags are available to this command's handler and to descendant * handlers via `yield* parentCommand`. Shared flags are accepted both before * and after a selected subcommand name (npm-style). * * @category combinators * @since 4.0.0 */ export declare const withSharedFlags: { /** * Adds flags that are inherited by subcommands. * * **Details** * * Shared flags are available to this command's handler and to descendant * handlers via `yield* parentCommand`. Shared flags are accepted both before * and after a selected subcommand name (npm-style). * * @category combinators * @since 4.0.0 */ <const SharedFlags extends Command.FlagConfig>(sharedFlags: SharedFlags): <Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Simplify<Input & Command.Config.Infer<SharedFlags>>, Simplify<ContextInput & Command.Config.Infer<SharedFlags>>, E, R>; /** * Adds flags that are inherited by subcommands. * * **Details** * * Shared flags are available to this command's handler and to descendant * handlers via `yield* parentCommand`. Shared flags are accepted both before * and after a selected subcommand name (npm-style). * * @category combinators * @since 4.0.0 */ <Name extends string, Input, E, R, ContextInput, const SharedFlags extends Command.FlagConfig>(self: Command<Name, Input, ContextInput, E, R>, sharedFlags: SharedFlags): Command<Name, Simplify<Input & Command.Config.Infer<SharedFlags>>, Simplify<ContextInput & Command.Config.Infer<SharedFlags>>, E, R>; }; /** * Adds global flags to a command scope. * * **Details** * * Declared global flags apply to the command and all of its descendants. * * @category combinators * @since 4.0.0 */ export declare const withGlobalFlags: { /** * Adds global flags to a command scope. * * **Details** * * Declared global flags apply to the command and all of its descendants. * * @category combinators * @since 4.0.0 */ <const GlobalFlags extends ReadonlyArray<GlobalFlag.GlobalFlag<any>>>(globalFlags: GlobalFlags): <Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E, Exclude<R, ExtractGlobalFlagContext<GlobalFlags>>>; /** * Adds global flags to a command scope. * * **Details** * * Declared global flags apply to the command and all of its descendants. * * @category combinators * @since 4.0.0 */ <Name extends string, Input, E, R, ContextInput, const GlobalFlags extends ReadonlyArray<GlobalFlag.GlobalFlag<any>>>(self: Command<Name, Input, ContextInput, E, R>, globalFlags: GlobalFlags): Command<Name, Input, ContextInput, E, Exclude<R, ExtractGlobalFlagContext<GlobalFlags>>>; }; type ExtractGlobalFlagContext<T extends ReadonlyArray<GlobalFlag.GlobalFlag<any>>> = T[number] extends infer F ? F extends GlobalFlag.Setting<infer Id, infer _A> ? GlobalFlag.Setting.Identifier<Id> : never : never; type ExtractSubcommand<T> = T extends Command<infer _Name, infer _Input, infer _CI, infer _E, infer _R> ? T : T extends Command.SubcommandGroup<infer Commands> ? Commands[number] : never; type ExtractSubcommandErrors<T extends ReadonlyArray<Command.SubcommandEntry>> = Error<ExtractSubcommand<T[number]>>; type ExtractSubcommandContext<T extends ReadonlyArray<Command.SubcommandEntry>> = ExtractSubcommand<T[number]> extends Command<infer _Name, infer _Input, infer _CI, infer _E, infer _R> ? _R : never; /** * Sets the description for a command. * * **Details** * * Descriptions provide users with information about what the command does * when they view help documentation. * * **Example** (Setting descriptions) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const deploy = Command.make("deploy", { * environment: Flag.string("env") * }, (config) => * Effect.gen(function*() { * yield* Console.log(`Deploying to ${config.environment}`) * })).pipe( * Command.withDescription("Deploy the application to a specified environment") * ) * ``` * * @category combinators * @since 4.0.0 */ export declare const withDescription: { /** * Sets the description for a command. * * **Details** * * Descriptions provide users with information about what the command does * when they view help documentation. * * **Example** (Setting descriptions) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const deploy = Command.make("deploy", { * environment: Flag.string("env") * }, (config) => * Effect.gen(function*() { * yield* Console.log(`Deploying to ${config.environment}`) * })).pipe( * Command.withDescription("Deploy the application to a specified environment") * ) * ``` * * @category combinators * @since 4.0.0 */ (description: string): <const Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E, R>; /** * Sets the description for a command. * * **Details** * * Descriptions provide users with information about what the command does * when they view help documentation. * * **Example** (Setting descriptions) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const deploy = Command.make("deploy", { * environment: Flag.string("env") * }, (config) => * Effect.gen(function*() { * yield* Console.log(`Deploying to ${config.environment}`) * })).pipe( * Command.withDescription("Deploy the application to a specified environment") * ) * ``` * * @category combinators * @since 4.0.0 */ <const Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>, description: string): Command<Name, Input, ContextInput, E, R>; }; /** * Sets a short description for a command. * * **Details** * * Short descriptions are used when listing subcommands in help output and * shell completions. If no short description is provided, the full * `description` is used as a fallback. * * @category combinators * @since 4.0.0 */ export declare const withShortDescription: { /** * Sets a short description for a command. * * **Details** * * Short descriptions are used when listing subcommands in help output and * shell completions. If no short description is provided, the full * `description` is used as a fallback. * * @category combinators * @since 4.0.0 */ (shortDescription: string): <const Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E, R>; /** * Sets a short description for a command. * * **Details** * * Short descriptions are used when listing subcommands in help output and * shell completions. If no short description is provided, the full * `description` is used as a fallback. * * @category combinators * @since 4.0.0 */ <const Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>, shortDescription: string): Command<Name, Input, ContextInput, E, R>; }; /** * Sets an alias for a command. * * **Details** * * Aliases are accepted as alternate subcommand names during parsing and are * shown in help output as `name, alias`. * * @category combinators * @since 4.0.0 */ export declare const withAlias: { /** * Sets an alias for a command. * * **Details** * * Aliases are accepted as alternate subcommand names during parsing and are * shown in help output as `name, alias`. * * @category combinators * @since 4.0.0 */ (alias: string): <const Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E, R>; /** * Sets an alias for a command. * * **Details** * * Aliases are accepted as alternate subcommand names during parsing and are * shown in help output as `name, alias`. * * @category combinators * @since 4.0.0 */ <const Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>, alias: string): Command<Name, Input, ContextInput, E, R>; }; /** * Hides a subcommand from parent help output, shell completions, and * "did you mean?" suggestions while keeping it fully invocable by exact name. * * **When to use** * * Use when experimental or internal subcommands should be accepted but not advertised on * the public CLI surface. * * **Example** (Hiding a subcommand) * * ```ts * import { Command } from "effect/unstable/cli" * * // `experimental` still runs when invoked as `mycli experimental`, * // but it does not appear under SUBCOMMANDS in `mycli --help`. * const experimental = Command.make("experimental").pipe( * Command.withHidden * ) * * const root = Command.make("mycli").pipe( * Command.withSubcommands([experimental]) * ) * ``` * * @category combinators * @since 4.0.0 */ export declare const withHidden: <const Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E, R>; /** * Adds a custom annotation to a command. * * **When to use** * * Use to attach one command-scoped metadata value under a `Context.Key`, * especially for consumers such as custom help formatters. * * **Details** * * Annotations are stored on the command's annotation context and flow into * generated help document annotations. * * **Gotchas** * * Adding the same `Context.Key` again replaces the earlier value. * * @see {@link annotateMerge} for merging an existing annotation context * * @category combinators * @since 4.0.0 */ export declare const annotate: { /** * Adds a custom annotation to a command. * * **When to use** * * Use to attach one command-scoped metadata value under a `Context.Key`, * especially for consumers such as custom help formatters. * * **Details** * * Annotations are stored on the command's annotation context and flow into * generated help document annotations. * * **Gotchas** * * Adding the same `Context.Key` again replaces the earlier value. * * @see {@link annotateMerge} for merging an existing annotation context * * @category combinators * @since 4.0.0 */ <I, S>(service: Context.Key<I, S>, value: NoInfer<S>): <Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E, R>; /** * Adds a custom annotation to a command. * * **When to use** * * Use to attach one command-scoped metadata value under a `Context.Key`, * especially for consumers such as custom help formatters. * * **Details** * * Annotations are stored on the command's annotation context and flow into * generated help document annotations. * * **Gotchas** * * Adding the same `Context.Key` again replaces the earlier value. * * @see {@link annotateMerge} for merging an existing annotation context * * @category combinators * @since 4.0.0 */ <Name extends string, Input, E, R, ContextInput, I, S>(self: Command<Name, Input, ContextInput, E, R>, service: Context.Key<I, S>, value: NoInfer<S>): Command<Name, Input, ContextInput, E, R>; }; /** * Merges a Context of annotations into a command. * * **When to use** * * Use when you need to attach an already-built `Context.Context` of command * annotations. * * **Details** * * Merged annotations are stored on the command and exposed through generated * help document annotations. * * **Gotchas** * * If both contexts contain the same `Context.Key`, the incoming annotations * context wins. * * @see {@link annotate} for adding a single annotation without constructing a `Context` * * @category combinators * @since 4.0.0 */ export declare const annotateMerge: { /** * Merges a Context of annotations into a command. * * **When to use** * * Use when you need to attach an already-built `Context.Context` of command * annotations. * * **Details** * * Merged annotations are stored on the command and exposed through generated * help document annotations. * * **Gotchas** * * If both contexts contain the same `Context.Key`, the incoming annotations * context wins. * * @see {@link annotate} for adding a single annotation without constructing a `Context` * * @category combinators * @since 4.0.0 */ <I>(annotations: Context.Context<I>): <Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E, R>; /** * Merges a Context of annotations into a command. * * **When to use** * * Use when you need to attach an already-built `Context.Context` of command * annotations. * * **Details** * * Merged annotations are stored on the command and exposed through generated * help document annotations. * * **Gotchas** * * If both contexts contain the same `Context.Key`, the incoming annotations * context wins. * * @see {@link annotate} for adding a single annotation without constructing a `Context` * * @category combinators * @since 4.0.0 */ <Name extends string, Input, E, R, ContextInput, I>(self: Command<Name, Input, ContextInput, E, R>, annotations: Context.Context<I>): Command<Name, Input, ContextInput, E, R>; }; /** * Sets usage examples for a command. * * **Details** * * Examples are exposed in structured `HelpDoc` data and rendered by the * default formatter in an `EXAMPLES` section. * * **Example** (Adding usage examples) * * ```ts * import { Command } from "effect/unstable/cli" * * const login = Command.make("login").pipe( * Command.withExamples([ * { command: "myapp login", description: "Log in with browser OAuth" }, * { command: "myapp login --token sbp_abc123", description: "Log in with a token" } * ]) * ) * ``` * * @category combinators * @since 4.0.0 */ export declare const withExamples: { /** * Sets usage examples for a command. * * **Details** * * Examples are exposed in structured `HelpDoc` data and rendered by the * default formatter in an `EXAMPLES` section. * * **Example** (Adding usage examples) * * ```ts * import { Command } from "effect/unstable/cli" * * const login = Command.make("login").pipe( * Command.withExamples([ * { command: "myapp login", description: "Log in with browser OAuth" }, * { command: "myapp login --token sbp_abc123", description: "Log in with a token" } * ]) * ) * ``` * * @category combinators * @since 4.0.0 */ (examples: ReadonlyArray<Command.Example>): <const Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E, R>; /** * Sets usage examples for a command. * * **Details** * * Examples are exposed in structured `HelpDoc` data and rendered by the * default formatter in an `EXAMPLES` section. * * **Example** (Adding usage examples) * * ```ts * import { Command } from "effect/unstable/cli" * * const login = Command.make("login").pipe( * Command.withExamples([ * { command: "myapp login", description: "Log in with browser OAuth" }, * { command: "myapp login --token sbp_abc123", description: "Log in with a token" } * ]) * ) * ``` * * @category combinators * @since 4.0.0 */ <const Name extends string, Input, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>, examples: ReadonlyArray<Command.Example>): Command<Name, Input, ContextInput, E, R>; }; /** * Provides the handler of a command with the services produced by a layer * that optionally depends on the command-line input to be created. * * **Example** (Providing command services) * * ```ts * import { Effect, FileSystem, PlatformError } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const deploy = Command.make("deploy", { * env: Flag.string("env") * }, (config) => * Effect.gen(function*() { * const fs = yield* FileSystem.FileSystem * // Use fs... * })).pipe( * // Provide FileSystem based on the --env flag * Command.provide((config) => * config.env === "local" * ? FileSystem.layerNoop({}) * : FileSystem.layerNoop({ * access: () => * Effect.fail( * PlatformError.badArgument({ * module: "FileSystem", * method: "access" * }) * ) * }) * ) * ) * ``` * * @category providing services * @since 4.0.0 */ export declare const provide: { /** * Provides the handler of a command with the services produced by a layer * that optionally depends on the command-line input to be created. * * **Example** (Providing command services) * * ```ts * import { Effect, FileSystem, PlatformError } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const deploy = Command.make("deploy", { * env: Flag.string("env") * }, (config) => * Effect.gen(function*() { * const fs = yield* FileSystem.FileSystem * // Use fs... * })).pipe( * // Provide FileSystem based on the --env flag * Command.provide((config) => * config.env === "local" * ? FileSystem.layerNoop({}) * : FileSystem.layerNoop({ * access: () => * Effect.fail( * PlatformError.badArgument({ * module: "FileSystem", * method: "access" * }) * ) * }) * ) * ) * ``` * * @category providing services * @since 4.0.0 */ <Input, LR, LE, LA>(layer: Layer.Layer<LA, LE, LR> | ((input: Input) => Layer.Layer<LA, LE, LR>), options?: { readonly local?: boolean | undefined; } | undefined): <const Name extends string, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E | LE, Exclude<R, LA> | LR>; /** * Provides the handler of a command with the services produced by a layer * that optionally depends on the command-line input to be created. * * **Example** (Providing command services) * * ```ts * import { Effect, FileSystem, PlatformError } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const deploy = Command.make("deploy", { * env: Flag.string("env") * }, (config) => * Effect.gen(function*() { * const fs = yield* FileSystem.FileSystem * // Use fs... * })).pipe( * // Provide FileSystem based on the --env flag * Command.provide((config) => * config.env === "local" * ? FileSystem.layerNoop({}) * : FileSystem.layerNoop({ * access: () => * Effect.fail( * PlatformError.badArgument({ * module: "FileSystem", * method: "access" * }) * ) * }) * ) * ) * ``` * * @category providing services * @since 4.0.0 */ <const Name extends string, Input, E, R, ContextInput, LA, LE, LR>(self: Command<Name, Input, ContextInput, E, R>, layer: Layer.Layer<LA, LE, LR> | ((input: Input) => Layer.Layer<LA, LE, LR>), options?: { readonly local?: boolean | undefined; } | undefined): Command<Name, Input, ContextInput, E | LE, Exclude<R, LA> | LR>; }; /** * Provides the handler of a command with the implementation of a service that * optionally depends on the command-line input to be constructed. * * **When to use** * * Use when a command handler needs a pure service implementation, optionally * derived from the parsed command input. * * @category providing services * @since 4.0.0 */ export declare const provideSync: { /** * Provides the handler of a command with the implementation of a service that * optionally depends on the command-line input to be constructed. * * **When to use** * * Use when a command handler needs a pure service implementation, optionally * derived from the parsed command input. * * @category providing services * @since 4.0.0 */ <I, S, Input>(service: Context.Key<I, S>, implementation: S | ((input: Input) => S)): <const Name extends string, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E, Exclude<R, I>>; /** * Provides the handler of a command with the implementation of a service that * optionally depends on the command-line input to be constructed. * * **When to use** * * Use when a command handler needs a pure service implementation, optionally * derived from the parsed command input. * * @category providing services * @since 4.0.0 */ <const Name extends string, Input, E, R, ContextInput, I, S>(self: Command<Name, Input, ContextInput, E, R>, service: Context.Key<I, S>, implementation: S | ((input: Input) => S)): Command<Name, Input, ContextInput, E, Exclude<R, I>>; }; /** * Provides the handler of a command with the service produced by an effect * that optionally depends on the command-line input to be created. * * **When to use** * * Use to acquire a service effectfully for each command run, optionally using * parsed command input. * * @see {@link provideSync} for synchronous service acquisition * @see {@link provide} for providing an already-available service * @see {@link provideEffectDiscard} for running an effect before the handler without providing a service * * @category providing services * @since 4.0.0 */ export declare const provideEffect: { /** * Provides the handler of a command with the service produced by an effect * that optionally depends on the command-line input to be created. * * **When to use** * * Use to acquire a service effectfully for each command run, optionally using * parsed command input. * * @see {@link provideSync} for synchronous service acquisition * @see {@link provide} for providing an already-available service * @see {@link provideEffectDiscard} for running an effect before the handler without providing a service * * @category providing services * @since 4.0.0 */ <I, S, Input, R2, E2>(service: Context.Key<I, S>, effect: Effect.Effect<S, E2, R2> | ((input: Input) => Effect.Effect<S, E2, R2>)): <const Name extends string, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E | E2, Exclude<R, I> | R2>; /** * Provides the handler of a command with the service produced by an effect * that optionally depends on the command-line input to be created. * * **When to use** * * Use to acquire a service effectfully for each command run, optionally using * parsed command input. * * @see {@link provideSync} for synchronous service acquisition * @see {@link provide} for providing an already-available service * @see {@link provideEffectDiscard} for running an effect before the handler without providing a service * * @category providing services * @since 4.0.0 */ <const Name extends string, Input, E, R, ContextInput, I, S, R2, E2>(self: Command<Name, Input, ContextInput, E, R>, service: Context.Key<I, S>, effect: Effect.Effect<S, E2, R2> | ((input: Input) => Effect.Effect<S, E2, R2>)): Command<Name, Input, ContextInput, E | E2, Exclude<R, I> | R2>; }; /** * Allows for execution of an effect, which optionally depends on command-line * input to be created, prior to executing the handler of a command. * * @category providing services * @since 4.0.0 */ export declare const provideEffectDiscard: { /** * Allows for execution of an effect, which optionally depends on command-line * input to be created, prior to executing the handler of a command. * * @category providing services * @since 4.0.0 */ <_, Input, E2, R2>(effect: Effect.Effect<_, E2, R2> | ((input: Input) => Effect.Effect<_, E2, R2>)): <const Name extends string, E, R, ContextInput>(self: Command<Name, Input, ContextInput, E, R>) => Command<Name, Input, ContextInput, E | E2, R | R2>; /** * Allows for execution of an effect, which optionally depends on command-line * input to be created, prior to executing the handler of a command. * * @category providing services * @since 4.0.0 */ <const Name extends string, Input, E, R, ContextInput, _, E2, R2>(self: Command<Name, Input, ContextInput, E, R>, effect: Effect.Effect<_, E2, R2> | ((input: Input) => Effect.Effect<_, E2, R2>)): Command<Name, Input, ContextInput, E | E2, R | R2>; }; /** * Runs a command using the arguments supplied by the `Stdio` service. * * **When to use** * * Use when command-line arguments should come from `Stdio` at the application * entry point. * * **Example** (Running commands with standard input) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const greetCommand = Command.make("greet", { * name: Flag.string("name") * }, (config) => * Effect.gen(function*() { * yield* Console.log(`Hello, ${config.name}!`) * })) * * // Automatically gets args from the Stdio service * const program = Command.run(greetCommand, { * version: "1.0.0" * }) * ``` * * @see {@link runWith} for running a command with an explicit argument array * * @category command execution * @since 4.0.0 */ export declare const run: { /** * Runs a command using the arguments supplied by the `Stdio` service. * * **When to use** * * Use when command-line arguments should come from `Stdio` at the application * entry point. * * **Example** (Running commands with standard input) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const greetCommand = Command.make("greet", { * name: Flag.string("name") * }, (config) => * Effect.gen(function*() { * yield* Console.log(`Hello, ${config.name}!`) * })) * * // Automatically gets args from the Stdio service * const program = Command.run(greetCommand, { * version: "1.0.0" * }) * ``` * * @see {@link runWith} for running a command with an explicit argument array * * @category command execution * @since 4.0.0 */ (config: { readonly version: string; }): <Name extends string, Input, E, R, ContextInput>(command: Command<Name, Input, ContextInput, E, R>) => Effect.Effect<void, E | CliError.CliError, R | Environment>; /** * Runs a command using the arguments supplied by the `Stdio` service. * * **When to use** * * Use when command-line arguments should come from `Stdio` at the application * entry point. * * **Example** (Running commands with standard input) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const greetCommand = Command.make("greet", { * name: Flag.string("name") * }, (config) => * Effect.gen(function*() { * yield* Console.log(`Hello, ${config.name}!`) * })) * * // Automatically gets args from the Stdio service * const program = Command.run(greetCommand, { * version: "1.0.0" * }) * ``` * * @see {@link runWith} for running a command with an explicit argument array * * @category command execution * @since 4.0.0 */ <Name extends string, Input, E, R, ContextInput>(command: Command<Name, Input, ContextInput, E, R>, config: { readonly version: string; }): Effect.Effect<void, E | CliError.CliError, R | Environment>; }; /** * Runs a command with explicitly provided arguments instead of using arguments from `Stdio`. * * **When to use** * * Use when you need to test CLI applications or programmatically execute * commands with specific arguments. * * **Example** (Running commands with explicit arguments) * * ```ts * import { Console, Effect } from "effect" * import { Command, Flag } from "effect/unstable/cli" * * const greet = Command.make("greet", { * name: Flag.string("name"), * count: Flag.integer("count").pipe(Flag.withDefault(1)) * }, (config) => * Effect.gen(function*() { * for (let i = 0; i < config.count; i++) { * yield* Console.log(`Hello, ${config.name}!`) * } * })) * * // Test with specific arguments * const testProgram = Effect.gen(function*() { * const runCommand = Command.runWith(greet, { version: "1.0.0" }) * * // Test normal execution * yield* runCommand(["--name", "Alice", "--count", "2"]) * * // Test help display * yield* runCommand(["--help"]) * * // Test version display * yield* runCommand(["--version"]) * }) * ``` * * @category command execution * @since 4.0.0 */ export declare const runWith: <const Name extends string, Input, E, R, ContextInput>(command: Command<Name, Input, ContextInput, E, R>, config: { readonly version: string; }) => (input: ReadonlyArray<string>) => Effect.Effect<void, Exclude<E, Terminal.QuitError> | CliError.CliError, R | Environment>; export {}; //# sourceMappingURL=Command.d.ts.map
/**
* Main building block for defining and running Effect-based command-line
* applications.
*
* A `Command` combines a name, typed flags and positional arguments, optional
* subcommands, help metadata, and an effectful handler. The module includes
* builders for command trees and the runners that parse command-line input,
* handle built-in help and version behavior, render help through `CliOutput`,
* and execute the selected handler.
*
* @since 4.0.0
*/
import type { NonEmptyReadonlyArray } from "../../Array.ts";
import * as Context from "../../Context.ts";
import * as Effect from "../../Effect.ts";
import type * as FileSystem from "../../FileSystem.ts";
import type * as Layer from "../../Layer.ts";
import * as Option from "../../Option.ts";
import type * as Path from "../../Path.ts";
import * as Stdio from "../../Stdio.ts";
import * as Terminal from "../../Terminal.ts";
import type { Contravariant, Covariant, NoInfer, Simplify } from "../../Types.ts";
import type { ChildProcessSpawner } from "../process/ChildProcessSpawner.ts";
import * as CliError from "./CliError.ts";
import * as GlobalFlag from "./GlobalFlag.ts";
import { TypeId } from "./internal/command.ts";
import * as Param from "./Param.ts";
/**
* Represents a CLI command with its configuration, handler, and metadata.
*
* **Details**
*
* Commands are the core building blocks of CLI applications. They define:
*
* - The command name and description
* - Configuration including flags and arguments
* - Handler function for execution
* - Optional subcommands for hierarchical structures
*
* **Example** (Defining CLI commands)
*
* ```ts
* import { Console } from "effect"
* import { Argument, Command, Flag } from "effect/unstable/cli"
*
* // Simple command with no configuration
* const version: Command.Command<"version", {}, {}, never, never> = Command.make(
* "version"
* )
*
* // Command with flags and arguments
* const deploy: Command.Command<
* "deploy",
* {
* readonly env: string
* readonly force: boolean
* readonly files: ReadonlyArray<string>
* },
* {},
* never,
* never
* > = Command.make("deploy", {
* env: Flag.string("env"),
* force: Flag.boolean("force"),
* files: Argument.string("files").pipe(Argument.variadic())
* })
*
* // Command with handler
* const greet = Command.make("greet", {
* name: Flag.string("name")
* }, (config) => Console.log(`Hello, ${config.name}!`))
* ```
*
* @category models
* @since 4.0.0
*/
export interface Command<in out Name extends string, in Input, out ContextInput = {}, out E = never, out R = never> extends Effect.Effect<ContextInput, never, CommandContext<Name>> {
readonly [TypeId]: Command.Variance<Input, E, R>;
/**
* The name of the command.
*/
readonly name: Name;
/**
* An optional description of the command.
*/
readonly description: string | undefined;
/**
* An optional short description used when listing subcommands.
*/
readonly shortDescription: string | undefined;
/**
* An optional alias that can be used as a shorter command name.
*/
readonly alias: string | undefined;
/**
* Optional usage examples for the command.
*/
readonly examples: ReadonlyArray<Command.Example>;
/**
* The subcommands available under this command.

Xet Storage Details

Size:
58.8 kB
·
Xet hash:
7d1cf6ab1752390f84fa48087b22e2e2cf9e9d8f15e35062bb96eb45cd7cec65

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.