Add shell completion support via a 'completion' subcommand for bash, zsh, and fish. Generic pattern for any Commander.js CLI, with static and dynamic completion examples.
インストールする前に、エージェントに与えられる指示の中身を確認できます。
Add a completion subcommand that outputs shell completion scripts for bash, zsh, and fish.
program
.command('completion')
.description('Output shell completion script')
.argument('<shell>', 'Shell type: bash, zsh, or fish')
.action((shell: string) => {
switch (shell) {
case 'bash':
process.stdout.write(generateBashCompletion())
break
case 'zsh':
process.stdout.write(generateZshCompletion())
break
case 'fish':
process.stdout.write(generateFishCompletion())
break
default:
throw new UserError(`Unknown shell: ${shell}. Supported: bash, zsh, fish`)
}
})
function generateBashCompletion(): string {
// Replace MYCLI and mycli with your CLI name
return `
_mycli_completions() {
local cur prev commands
COMPREPLY=()
cur="\${COMP_WORDS[COMP_CWORD]}"
prev="\${COMP_WORDS[COMP_CWORD-1]}"
commands="<list your subcommands here>"
case "\${prev}" in
mycli)
COMPREPLY=( $(compgen -W "\${commands}" -- "\${cur}") )
return 0
;;
completion)
COMPREPLY=( $(compgen -W "bash zsh fish" -- "\${cur}") )
return 0
;;
esac
if [[ "\${cur}" == -* ]]; then
COMPREPLY=( $(compgen -W "--help --version <your global flags>" -- "\${cur}") )
fi
}
complete -F _mycli_completions mycli
`.trim()
}
function generateZshCompletion(): string {
return `
#compdef mycli
_mycli() {
local -a commands
commands=(
'command1:Description of command 1'
'command2:Description of command 2'
'completion:Output shell completion script'
)
_arguments -C \\
'1:command:->command' \\
'*::arg:->args'
case $state in
command)
_describe 'command' commands
;;
args)
case $words[1] in
command1)
_arguments \\
'--flag1[Description]:value:' \\
'--flag2[Description]'
;;
completion)
_arguments '1:shell:(bash zsh fish)'
;;
esac
;;
esac
}
_mycli "$@"
`.trim()
}
For values that depend on runtime state (e.g., available environments, project names):
# In bash completion, call the CLI with --json for machine-readable output
local items=$(mycli list --json 2>/dev/null | jq -r '.[]' 2>/dev/null)
COMPREPLY=( $(compgen -W "${items}" -- "${cur}") )
Print setup instructions when running mycli completion:
# Bash: Add to ~/.bashrc
eval "$(mycli completion bash)"
# Zsh: Add to ~/.zshrc
eval "$(mycli completion zsh)"
# Fish: Run once
mycli completion fish > ~/.config/fish/completions/mycli.fish
mycli completion bash | bash # Should not error
mycli completion zsh # Should output valid zsh script
mycli completion fish # Should output valid fish script
まだレビューはありません。使ってみた感想をお寄せください。
概要と使いどころ
Add --json flag to CLI commands for machine-readable output on stdout. Generic pattern for any CLI tool, enabling piping to jq and CI/CD integration while keeping human-readable output on stderr.
日本語の概要は準備中です。原文の説明を表示しています。
Add zod schema validation for CLI options and YAML/JSON config files. Generic pattern for runtime validation with type-safe parsing and clear error messages in any Commander.js CLI.
日本語の概要は準備中です。原文の説明を表示しています。
Set up @changesets/cli for semantic versioning, CHANGELOG generation, and npm publishing in a monorepo or single package. Covers init, config, contributor workflow, GitHub Actions release automation, and npm provenance.
日本語の概要は準備中です。原文の説明を表示しています。
Add automatic CI/CD environment detection using ci-info package. Generic pattern for any CLI tool that needs to adapt behavior (prompts, output, integrations) based on whether it's running in CI.
日本語の概要は準備中です。原文の説明を表示しています。
Polish CLI user experience with @clack/prompts for interactive flows, update-notifier for version awareness, and enhanced Commander.js help text with examples and colors. Generic patterns for any Node.js CLI.
日本語の概要は準備中です。原文の説明を表示しています。
Implement a structured error class hierarchy with actionable messages, proper exit codes, debug mode via env var, and bug report hints on unexpected errors. Generic pattern for any CLI tool or Node.js application.
日本語の概要は準備中です。原文の説明を表示しています。