Skip to content

Home
Guide
API
Showcase
- v0.27 Release Notes
- Changelog
  Contributing
GitHub

Sidebar Navigation

Introduction

What's Gunshi?
Setup

Essentials

Getting Started
Declarative Configuration
Type Safe
Composable
Lazy & Async
Auto Usage Generation
Plugin System

Advanced

Type System
Parser Combinators
Command Hooks
Context Extensions
Custom Rendering
Internationalization
AI Agent Detection
Documentation Generation
Advanced Lazy Loading and Sub-Commands
Nested Sub-Commands

Plugin

Plugin System Introduction
Getting Started with Plugin Development
Plugin Lifecycle
Plugin Dependencies
Plugin Decorators
Plugin Extensions
Plugin Type System
Plugin Testing
Plugin Development Guidelines
Plugin List

API References

agent
- Functions
  - getAgentProfile
combinators
- Functions
  - args
    boolean
    choice
    combinator
    describe
    extend
    float
    hidden
    integer
    map
    merge
    multiple
    number
    positional
    required
    short
    string
    unrequired
    withDefault
  Interfaces
  - BaseOptions
    BooleanOptions
    CombinatorOptions
    FloatOptions
    IntegerOptions
    NumberOptions
    StringOptions
  Type Aliases
  - Combinator
    CombinatorSchema
context
- Functions
  - createCommandContext
  Interfaces
  - CommandContextParams
default
- Variables
  - ANONYMOUS_COMMAND_NAME
    CommandNotFoundErrorKeys
    CommandResolutionErrorKeys
  Functions
  - cli
    hasPriorityValidationError
    isArgsValidationError
    isCommandNotFoundError
    isCommandResolutionError
    parseArgs
    plugin
    resolveArgs
  Classes
  - ArgsValidationError
    CommandNotFoundError
    CommandResolutionError
    DefaultTranslation
  Interfaces
  - Args
    ArgSchema
    ArgToken
    CliOptions
    Command
    CommandContext
    CommandContextExtension
    CommandEnvironment
    GunshiParams
    PluginContext
    PluginDependency
    PluginOptions
    PluginWithExtension
    PluginWithoutExtension
    RenderingOptions
    SubCommandable
  Type Aliases
  - ArgsValidationErrorCode
    ArgValues
    Awaitable
    Commandable
    CommandCallMode
    CommandContextCore
    CommandDecorator
    CommandExamplesFetcher
    CommandLoader
    CommandNotFoundErrorCode
    CommandNotFoundErrorOptions
    CommandResolutionErrorCode
    CommandResolutionErrorOptions
    CommandRunner
    DefaultGunshiParams
    ExtendContext
    GunshiParamsConstraint
    LazyCommand
    OnPluginExtension
    Plugin
    PluginExtension
    PluginFunction
    Prettify
    RendererDecorator
    ValidationErrorsDecorator
definition
- Functions
  - define
    defineWithTypes
    lazy
    lazyWithTypes
generator
- Functions
  - generate
  Type Aliases
  - GenerateOptions
plugin
- Variables
  - CLI_OPTIONS_DEFAULT
renderer
- Functions
  - renderHeader
    renderUsage
    renderValidationErrors

Extra Topics

Showcase

Release Notes

Gunshi v0.27 Release Notes

On this page

Are you an LLM? You can read better optimized documentation at /api/default/type-aliases/DefaultGunshiParams.md for this page in Markdown format

Type Alias: DefaultGunshiParams

Default Gunshi parameters.

Since

v0.27.0

Signature

ts

export type DefaultGunshiParams = GunshiParams

Pager

Previous pageCommandRunner

Next pageExtendContext

Released under the MIT License.

Copyright © 2025 kazuya kawaguchi.