gunshi / default

default

gunshi cli entry point.

This entry point exports the bellow APIs and types:

• cli: The main CLI function to run the command, included global options and usage renderer built-in plugins.
• define: A function to define a command.
• lazy: A function to lazily load a command.
• plugin: A function to create a plugin.
• args-tokens utilities, parseArgs and resolveArgs for parsing command line arguments.
• Some basic type definitions, such as CommandContext, Plugin, PluginContext, etc.

Example

import { cli } from 'gunshi'

Functions

Function	Description
cli	Run the command.
parseArgs	Parse command line arguments.
plugin	Define a plugin
resolveArgs	Resolve command line arguments.

Classes

Class	Description
DefaultTranslation	-

Interfaces

Interface	Description
Args	An object that contains argument schema.
ArgSchema	An argument schema This schema is similar to the schema of the node:utils. difference is that: - required property and description property are added - type is not only 'string' and 'boolean', but also 'number', 'enum', 'positional', 'custom' too. - default property type, not support multiple types
ArgToken	Argument token.
CliOptions	CLI options of cli function.
Command	Command interface.
CommandContext	Command context. Command context is the context of the command execution.
CommandContextExtension	Command context extension
CommandEnvironment	Command environment.
GunshiParams	Gunshi unified parameter type. This type combines both argument definitions and command context extensions.
PluginContext	Gunshi plugin context interface.
PluginDependency	Plugin dependency definition
PluginOptions	Plugin definition options

References

define

Re-exports define

---

lazy

Re-exports lazy

Type Aliases

Type Alias	Description
ArgValues	An object that contains the values of the arguments.
Awaitable	-
Commandable	Define a command type.
CommandCallMode	Command call mode.
CommandContextCore	CommandContextCore type (base type without extensions)
CommandDecorator	Command decorator. A function that wraps a command runner to add or modify its behavior.
CommandExamplesFetcher	Command examples fetcher.
CommandLoader	Command loader. A function that returns a command or command runner. This is used to lazily load commands.
CommandRunner	Command runner.
DefaultGunshiParams	Default Gunshi parameters
ExtendContext	Extend command context type. This type is used to extend the command context with additional properties at CommandContext.extensions.
GunshiParamsConstraint	Generic constraint for command-related types. This type constraint allows both GunshiParams and objects with extensions.
LazyCommand	Lazy command interface. Lazy command that's not loaded until it is executed.
OnPluginExtension	Plugin extension callback type
Plugin	Gunshi plugin, which is a function that receives a PluginContext.
PluginExtension	Plugin extension for CommandContext
PluginFunction	Plugin function type
RendererDecorator	Renderer decorator type. A function that wraps a base renderer to add or modify its behavior.
ValidationErrorsDecorator	Validation errors renderer decorator type. A function that wraps a validation errors renderer to add or modify its behavior.