Gunshi

plugin ​

The entry point for Gunshi plugin module.

Example ​

js
import { plugin } from 'gunshi/plugin'

export default yourPlugin() {
  return plugin({
    id: 'your-plugin-id',
    setup: (ctx) => {
      // your plugin setup logic here
    },
  })
}

Variables ​

VariableDescription
CLI_OPTIONS_DEFAULT

References ​

ANONYMOUS_COMMAND_NAME ​

Re-exports ANONYMOUS_COMMAND_NAME

Args ​

Re-exports Args

ArgSchema ​

Re-exports ArgSchema

ArgsValidationError ​

Re-exports ArgsValidationError

ArgsValidationErrorCode ​

Re-exports ArgsValidationErrorCode

ArgToken ​

Re-exports ArgToken

ArgValues ​

Re-exports ArgValues

Awaitable ​

Re-exports Awaitable

Command ​

Re-exports Command

CommandContext ​

Re-exports CommandContext

CommandContextCore ​

Re-exports CommandContextCore

CommandContextExtension ​

Re-exports CommandContextExtension

CommandContextParams ​

Re-exports CommandContextParams

CommandDecorator ​

Re-exports CommandDecorator

CommandError ​

Re-exports CommandError

CommandErrorOptions ​

Re-exports CommandErrorOptions

CommandExamplesFetcher ​

Re-exports CommandExamplesFetcher

CommandNotFoundError ​

Re-exports CommandNotFoundError

CommandNotFoundErrorCode ​

Re-exports CommandNotFoundErrorCode

CommandNotFoundErrorKeys ​

Re-exports CommandNotFoundErrorKeys

CommandNotFoundErrorOptions ​

Re-exports CommandNotFoundErrorOptions

CommandResolutionError ​

Re-exports CommandResolutionError

CommandResolutionErrorCode ​

Re-exports CommandResolutionErrorCode

CommandResolutionErrorKeys ​

Re-exports CommandResolutionErrorKeys

CommandResolutionErrorOptions ​

Re-exports CommandResolutionErrorOptions

CommandRunner ​

Re-exports CommandRunner

CommandRunnerResult ​

Re-exports CommandRunnerResult

createCommandContext ​

Re-exports createCommandContext

DefaultGunshiParams ​

Re-exports DefaultGunshiParams

ExtendContext ​

Re-exports ExtendContext

GunshiParams ​

Re-exports GunshiParams

GunshiParamsConstraint ​

Re-exports GunshiParamsConstraint

hasPriorityValidationError ​

Re-exports hasPriorityValidationError

isArgsValidationError ​

Re-exports isArgsValidationError

isCommandError ​

Re-exports isCommandError

isCommandNotFoundError ​

Re-exports isCommandNotFoundError

isCommandResolutionError ​

Re-exports isCommandResolutionError

isJsonOutputError ​

Re-exports isJsonOutputError

JsonOutputError ​

Re-exports JsonOutputError

JsonOutputErrorCode ​

Re-exports JsonOutputErrorCode

JsonOutputErrorKeys ​

Re-exports JsonOutputErrorKeys

JsonOutputErrorOptions ​

Re-exports JsonOutputErrorOptions

JsonResult ​

Re-exports JsonResult

LazyCommand ​

Re-exports LazyCommand

OnPluginExtension ​

Re-exports OnPluginExtension

Plugin ​

Re-exports Plugin

plugin ​

Re-exports plugin

PluginContext ​

Re-exports PluginContext

PluginDependency ​

Re-exports PluginDependency

PluginExtension ​

Re-exports PluginExtension

PluginFunction ​

Re-exports PluginFunction

PluginOptions ​

Re-exports PluginOptions

PluginWithExtension ​

Re-exports PluginWithExtension

PluginWithoutExtension ​

Re-exports PluginWithoutExtension

Prettify ​

Re-exports Prettify

RendererDecorator ​

Re-exports RendererDecorator

SubCommandable ​

Re-exports SubCommandable

ValidationErrorsDecorator ​

Re-exports ValidationErrorsDecorator

Released under the MIT License.

Copyright © 2025 kazuya kawaguchi.