feat(cli): add shell completion support#2810
Open
Ahmed-AdelB wants to merge 1 commit intoopenai:mainfrom
Open
Conversation
Add shell completion script generator for bash, zsh, fish, and PowerShell. Usage: - Bash: eval "$(openai completion bash)" - Zsh: eval "$(openai completion zsh)" - Fish: openai completion fish > ~/.config/fish/completions/openai.fish - PowerShell: . (openai completion powershell | Out-String) This adds a new `completion` subcommand that generates shell-specific completion scripts. The scripts provide tab completion for: - Main commands (api, tools, completion) - API subcommands (chat.completions.create, models.list, etc.) - Global options (-v, -k, -o, --api-key, etc.) Fixes openai#843 Author: Ahmed Adel Bakr Alderai
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds shell completion support to the OpenAI CLI, addressing issue #843.
Features
compgenand bash-completion library_argumentsand_describecompletion frameworkRegister-ArgumentCompleterpatternUsage
Commands Supported
api,tools,completionchat.completions.create,models.list,models.retrieve,files.*,audio.*,images.*,embeddings.create,moderations.createfine_tunes.prepare_data-v,-k,-o,-t,--api-key,--organization, etc.Implementation Notes
argcomplete_completion.py) and minimal modifications to_cli.pyChanges
src/openai/cli/_completion.py(new): Shell completion script generatorsrc/openai/cli/_cli.py: Added import and registration for completion subcommandTest Plan
Fixes #843
Author: Ahmed Adel Bakr Alderai