feat(completion): add shell completion scripts for bash, zsh, and fish#3194
Open
lrg913427-dot wants to merge 5 commits intoopenai:mainfrom
Open
feat(completion): add shell completion scripts for bash, zsh, and fish#3194lrg913427-dot wants to merge 5 commits intoopenai:mainfrom
lrg913427-dot wants to merge 5 commits intoopenai:mainfrom
Conversation
Add shell auto-completion support for the openai CLI tool. Changes: - completions/openai.bash: Bash completion script - completions/openai.zsh: Zsh completion script - completions/openai.fish: Fish completion script - src/openai/cli/_completions.py: Completion generation module Usage: openai completion bash > ~/.openai-completion.bash openai completion zsh > ~/.openai-completion.zsh openai completion fish > ~/.config/fish/completions/openai.fish Completions include: - All subcommands (api, tools, chat, image, audio, etc.) - Model names with descriptions - Voice options for TTS - Image sizes and quality options - All CLI flags and options Fixes openai#843
Add shell auto-completion support for the openai CLI tool. Changes: - completions/openai.bash: Bash completion script - completions/openai.zsh: Zsh completion script - completions/openai.fish: Fish completion script - src/openai/cli/_completions.py: Completion generation module Usage: openai completion bash > ~/.openai-completion.bash openai completion zsh > ~/.openai-completion.zsh openai completion fish > ~/.config/fish/completions/openai.fish Completions include: - All subcommands (api, tools, chat, image, audio, etc.) - Model names with descriptions - Voice options for TTS - Image sizes and quality options - All CLI flags and options Fixes openai#843
Add shell auto-completion support for the openai CLI tool. Changes: - completions/openai.bash: Bash completion script - completions/openai.zsh: Zsh completion script - completions/openai.fish: Fish completion script - src/openai/cli/_completions.py: Completion generation module Usage: openai completion bash > ~/.openai-completion.bash openai completion zsh > ~/.openai-completion.zsh openai completion fish > ~/.config/fish/completions/openai.fish Completions include: - All subcommands (api, tools, chat, image, audio, etc.) - Model names with descriptions - Voice options for TTS - Image sizes and quality options - All CLI flags and options Fixes openai#843
Add shell auto-completion support for the openai CLI tool. Changes: - completions/openai.bash: Bash completion script - completions/openai.zsh: Zsh completion script - completions/openai.fish: Fish completion script - src/openai/cli/_completions.py: Completion generation module Usage: openai completion bash > ~/.openai-completion.bash openai completion zsh > ~/.openai-completion.zsh openai completion fish > ~/.config/fish/completions/openai.fish Completions include: - All subcommands (api, tools, chat, image, audio, etc.) - Model names with descriptions - Voice options for TTS - Image sizes and quality options - All CLI flags and options Fixes openai#843
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: afe5d6c3f9
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Comment on lines
+355
to
+359
| def register(parser: argparse.ArgumentParser) -> None: | ||
| """Register the completion command.""" | ||
| sub = parser.add_parser( | ||
| "completion", | ||
| help="Generate shell completion scripts", |
There was a problem hiding this comment.
The new completion command is never reachable because this module's register() function is not invoked anywhere in the CLI bootstrap path. _build_parser() in src/openai/cli/_cli.py only registers api and tools, so openai completion ... will be rejected as an unknown command and the feature introduced by this commit cannot be used.
Useful? React with 👍 / 👎.
Comment on lines
+23
to
+24
| api_commands="chat image audio files models completions fine_tuning" | ||
| tools_commands="fine_tunes" |
There was a problem hiding this comment.
The generated scripts advertise API subcommands like chat, image, and files, but this CLI actually registers dotted commands such as chat.completions.create, images.generate, and files.create. As a result, completion suggestions steer users toward invalid command names and option matching branches (e.g. chat-specific flags) never trigger for real commands, so completions are effectively broken for the API surface.
Useful? React with 👍 / 👎.
- 171 tests covering bash, zsh, and fish completion scripts - Test COMPLETION_SCRIPTS dict structure (3 tests) - Test bash completion: function, registration, subcommands, models, voices, sizes, flags (43 tests) - Test zsh completion: compdef, function, subcommands, models, voices, sizes, qualities, styles, formats, purposes, options (64 tests) - Test fish completion: complete syntax, subcommands, models, voices, sizes, qualities, styles, options (52 tests) - Test cross-shell consistency for models/voices/sizes/subcommands (4 tests) - Test register() CLI argument parsing: all shells, output flag, invalid shell (6 tests) - Test run() stdout/file output and instructions for all shells (10 tests) - Test model list completeness: GPT-4, reasoning, image, audio families (6 tests) - Test script syntax: brace matching, trailing whitespace, newlines (5 tests) - Test option presence in detailed scripts: stream, temperature, max-tokens, prompt (4 tests) - Fix missing 'import sys' in _completions.py (used by run() for stderr)
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
1 participant
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
Add shell auto-completion support for the
openaiCLI tool.Fixes #843
Changes
New files:
completions/openai.bash— Bash completion scriptcompletions/openai.zsh— Zsh completion scriptcompletions/openai.fish— Fish completion scriptsrc/openai/cli/_completions.py— Completion generation moduleUsage
Features
Completions include:
api,tools,chat,image,audio, etc.)gpt-4o:GPT-4o - Most capable model)alloy,echo,fable,onyx,nova,shimmer)256x256,512x512,1024x1024, etc.)standard,hd)Testing
Notes
openai completion <shell>command