Skip to content

feat(completion): add shell completion scripts for bash, zsh, and fish #3194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lrg913427-dot wants to merge 5 commits into
base: main
Choose a base branch
from
+1,532 −0
Open

feat(completion): add shell completion scripts for bash, zsh, and fish #3194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b38d8c7
feat(completion): add shell completion scripts for bash, zsh, and fish
lrg913427-dot May 2, 2026
0a97317
feat(completion): add shell completion scripts for bash, zsh, and fish
lrg913427-dot May 2, 2026
867a9d2
feat(completion): add shell completion scripts for bash, zsh, and fish
lrg913427-dot May 2, 2026
afe5d6c
feat(completion): add shell completion scripts for bash, zsh, and fish
lrg913427-dot May 2, 2026
44b5596
test: add comprehensive tests for shell completion scripts
lrg913427-dot May 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 170 additions & 0 deletions completions/openai.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
# Bash completion for openai CLI
# Source this file or add to /etc/bash_completion.d/

_openai_completions()
{
local cur prev commands
COMPREPLY=()
cur="${COMP_WORDS[COMP_CWORD]}"
prev="${COMP_WORDS[COMP_CWORD-1]}"

# Main commands
commands="api tools"

# API subcommands
api_commands="chat image audio files models completions fine_tuning"

# Tools subcommands
tools_commands="fine_tunes"

# Global options
global_opts="--verbose --api-base --api-key --proxy --organization --api-type --api-version --azure-endpoint --azure-ad-token --version --help"

# Chat options
chat_opts="--model --messages --temperature --top-p --n --stream --stop --max-tokens --presence-penalty --frequency-penalty --logit-bias --user --response-format --seed --tools --tool-choice --function-call --functions"

# Image options
image_opts="--model --prompt --size --quality --response-format --style --user --n"

# Audio options
audio_opts="--model --voice --input --response-format --speed"

# Files options
files_opts="--file --purpose"

# Models options
models_opts="--list --retrieve --delete"

# Completions options
completions_opts="--model --prompt --suffix --temperature --top-p --n --stream --stop --max-tokens --logprobs --echo --presence-penalty --frequency-penalty --best-of --logit-bias --user --seed"

# Fine-tuning options
fine_tuning_opts="--model --training-file --hyperparameters --suffix --validation-file"

case ${COMP_CWORD} in
1)
COMPREPLY=( $(compgen -W "${commands} ${global_opts}" -- ${cur}) )
return 0
;;
2)
case ${prev} in
api)
COMPREPLY=( $(compgen -W "${api_commands}" -- ${cur}) )
return 0
;;
tools)
COMPREPLY=( $(compgen -W "${tools_commands}" -- ${cur}) )
return 0
;;
-k|--api-key)
# Don't complete API keys
return 0
;;
-b|--api-base)
COMPREPLY=( $(compgen -W "https://api.openai.com/v1 https://api.openai.com/v1/azure" -- ${cur}) )
return 0
;;
-o|--organization)
return 0
;;
*)
;;
esac
;;
3)
case ${COMP_WORDS[1]} in
api)
case ${prev} in
chat)
COMPREPLY=( $(compgen -W "${chat_opts}" -- ${cur}) )
return 0
;;
image)
COMPREPLY=( $(compgen -W "${image_opts}" -- ${cur}) )
return 0
;;
audio)
COMPREPLY=( $(compgen -W "${audio_opts}" -- ${cur}) )
return 0
;;
files)
COMPREPLY=( $(compgen -W "${files_opts}" -- ${cur}) )
return 0
;;
models)
COMPREPLY=( $(compgen -W "${models_opts}" -- ${cur}) )
return 0
;;
completions)
COMPREPLY=( $(compgen -W "${completions_opts}" -- ${cur}) )
return 0
;;
fine_tuning)
COMPREPLY=( $(compgen -W "${fine_tuning_opts}" -- ${cur}) )
return 0
;;
*)
;;
esac
;;
*)
;;
esac
;;
*)
# Complete model names for --model option
if [[ ${prev} == "--model" || ${prev} == "-m" ]]; then
local models="gpt-4o gpt-4o-mini gpt-4-turbo gpt-4 gpt-3.5-turbo o1 o1-mini o1-pro o3 o3-mini o4-mini dall-e-3 dall-e-2 whisper-1 tts-1 tts-1-hd"
COMPREPLY=( $(compgen -W "${models}" -- ${cur}) )
return 0
fi

# Complete voice options for --voice
if [[ ${prev} == "--voice" ]]; then
local voices="alloy echo fable onyx nova shimmer"
COMPREPLY=( $(compgen -W "${voices}" -- ${cur}) )
return 0
fi

# Complete size options for --size
if [[ ${prev} == "--size" ]]; then
local sizes="256x256 512x512 1024x1024 1792x1024 1024x1792"
COMPREPLY=( $(compgen -W "${sizes}" -- ${cur}) )
return 0
fi

# Complete response format options
if [[ ${prev} == "--response-format" ]]; then
local formats="json url b64 json_object text"
COMPREPLY=( $(compgen -W "${formats}" -- ${cur}) )
return 0
fi

# Complete quality options
if [[ ${prev} == "--quality" ]]; then
local qualities="standard hd"
COMPREPLY=( $(compgen -W "${qualities}" -- ${cur}) )
return 0
fi

# Complete style options
if [[ ${prev} == "--style" ]]; then
local styles="vivid natural"
COMPREPLY=( $(compgen -W "${styles}" -- ${cur}) )
return 0
fi

# Complete purpose options for files
if [[ ${prev} == "--purpose" ]]; then
local purposes="fine-tune assistants"
COMPREPLY=( $(compgen -W "${purposes}" -- ${cur}) )
return 0
fi

# Default: complete with files
COMPREPLY=( $(compgen -f -- ${cur}) )
;;
esac
}

complete -F _openai_completions openai
124 changes: 124 additions & 0 deletions completions/openai.fish
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# Fish completion for openai CLI
# Add to ~/.config/fish/completions/openai.fish

# Global options
complete -c openai -l verbose -d "Set verbosity" -f
complete -c openai -l api-base -d "API base URL" -f
complete -c openai -l api-key -d "API key" -f
complete -c openai -l proxy -d "Proxy" -f
complete -c openai -l organization -d "Organization" -f
complete -c openai -l api-type -d "API type" -a "openai azure" -f
complete -c openai -l api-version -d "API version" -f
complete -c openai -l azure-endpoint -d "Azure endpoint" -f
complete -c openai -l azure-ad-token -d "Azure AD token" -f
complete -c openai -l version -d "Show version" -f
complete -c openai -l help -d "Show help" -f

# Main commands
complete -c openai -n '__fish_use_subcommand' -a api -d "Direct API calls"
complete -c openai -n '__fish_use_subcommand' -a tools -d "Client side tools"

# API subcommands
complete -c openai -n '__fish_seen_subcommand_from api' -a chat -d "Chat completions"
complete -c openai -n '__fish_seen_subcommand_from api' -a image -d "Image generation"
complete -c openai -n '__fish_seen_subcommand_from api' -a audio -d "Audio/speech"
complete -c openai -n '__fish_seen_subcommand_from api' -a files -d "File management"
complete -c openai -n '__fish_seen_subcommand_from api' -a models -d "Model management"
complete -c openai -n '__fish_seen_subcommand_from api' -a completions -d "Text completions"
complete -c openai -n '__fish_seen_subcommand_from api' -a fine_tuning -d "Fine-tuning jobs"

# Tools subcommands
complete -c openai -n '__fish_seen_subcommand_from tools' -a fine_tunes -d "Fine-tuning tools"

# Model names
set -l models gpt-4o gpt-4o-mini gpt-4-turbo gpt-4 gpt-3.5-turbo o1 o1-mini o1-pro o3 o3-mini o4-mini dall-e-3 dall-e-2 whisper-1 tts-1 tts-1-hd

# Voice options
set -l voices alloy echo fable onyx nova shimmer

# Size options
set -l sizes 256x256 512x512 1024x1024 1792x1024 1024x1792

# Response format options
set -l formats json url b64 json_object text

# Quality options
set -l qualities standard hd

# Style options
set -l styles vivid natural

# Purpose options
set -l purposes fine-tune assistants

# Chat options
complete -c openai -n '__fish_seen_subcommand_from chat' -l model -d "Model to use" -a "$models" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l messages -d "Messages JSON" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l temperature -d "Temperature" -a "0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1.0" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l top-p -d "Top P" -a "0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1.0" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l n -d "Number of completions" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l stream -d "Stream responses" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l stop -d "Stop sequences" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l max-tokens -d "Max tokens" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l presence-penalty -d "Presence penalty" -a "-2.0 -1.0 0.0 1.0 2.0" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l frequency-penalty -d "Frequency penalty" -a "-2.0 -1.0 0.0 1.0 2.0" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l logit-bias -d "Logit bias JSON" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l user -d "User ID" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l response-format -d "Response format" -a "$formats" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l seed -d "Seed" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l tools -d "Tools JSON" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l tool-choice -d "Tool choice" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l function-call -d "Function call" -f
complete -c openai -n '__fish_seen_subcommand_from chat' -l functions -d "Functions JSON" -f

# Image options
complete -c openai -n '__fish_seen_subcommand_from image' -l model -d "Model" -a "dall-e-3 dall-e-2" -f
complete -c openai -n '__fish_seen_subcommand_from image' -l prompt -d "Prompt" -f
complete -c openai -n '__fish_seen_subcommand_from image' -l size -d "Size" -a "$sizes" -f
complete -c openai -n '__fish_seen_subcommand_from image' -l quality -d "Quality" -a "$qualities" -f
complete -c openai -n '__fish_seen_subcommand_from image' -l response-format -d "Format" -a "url b64" -f
complete -c openai -n '__fish_seen_subcommand_from image' -l style -d "Style" -a "$styles" -f
complete -c openai -n '__fish_seen_subcommand_from image' -l user -d "User ID" -f
complete -c openai -n '__fish_seen_subcommand_from image' -l n -d "Number of images" -f

# Audio options
complete -c openai -n '__fish_seen_subcommand_from audio' -l model -d "Model" -a "whisper-1 tts-1 tts-1-hd" -f
complete -c openai -n '__fish_seen_subcommand_from audio' -l voice -d "Voice" -a "$voices" -f
complete -c openai -n '__fish_seen_subcommand_from audio' -l input -d "Input text/file" -f
complete -c openai -n '__fish_seen_subcommand_from audio' -l response-format -d "Format" -a "mp3 opus aac flac wav pcm" -f
complete -c openai -n '__fish_seen_subcommand_from audio' -l speed -d "Speed" -a "0.25 0.5 1.0 2.0 4.0" -f

# Files options
complete -c openai -n '__fish_seen_subcommand_from files' -l file -d "File path" -f
complete -c openai -n '__fish_seen_subcommand_from files' -l purpose -d "Purpose" -a "$purposes" -f

# Models options
complete -c openai -n '__fish_seen_subcommand_from models' -l list -d "List models" -f
complete -c openai -n '__fish_seen_subcommand_from models' -l retrieve -d "Retrieve model" -a "$models" -f
complete -c openai -n '__fish_seen_subcommand_from models' -l delete -d "Delete model" -a "$models" -f

# Completions options
complete -c openai -n '__fish_seen_subcommand_from completions' -l model -d "Model" -a "$models" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l prompt -d "Prompt" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l suffix -d "Suffix" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l temperature -d "Temperature" -a "0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1.0" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l top-p -d "Top P" -a "0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1.0" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l n -d "Number" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l stream -d "Stream" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l stop -d "Stop" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l max-tokens -d "Max tokens" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l logprobs -d "Log probs" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l echo -d "Echo prompt" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l presence-penalty -d "Presence penalty" -a "-2.0 -1.0 0.0 1.0 2.0" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l frequency-penalty -d "Frequency penalty" -a "-2.0 -1.0 0.0 1.0 2.0" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l best-of -d "Best of" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l logit-bias -d "Logit bias JSON" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l user -d "User ID" -f
complete -c openai -n '__fish_seen_subcommand_from completions' -l seed -d "Seed" -f

# Fine-tuning options
complete -c openai -n '__fish_seen_subcommand_from fine_tuning' -l model -d "Model" -a "$models" -f
complete -c openai -n '__fish_seen_subcommand_from fine_tuning' -l training-file -d "Training file" -f
complete -c openai -n '__fish_seen_subcommand_from fine_tuning' -l hyperparameters -d "Hyperparameters JSON" -f
complete -c openai -n '__fish_seen_subcommand_from fine_tuning' -l suffix -d "Suffix" -f
complete -c openai -n '__fish_seen_subcommand_from fine_tuning' -l validation-file -d "Validation file" -f
Loading