Skip to content

Add Shell Auto-Completion Support for Bash, Zsh, Fish, and PowerShell #53

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Shell Auto-Completion Support for Bash, Zsh, Fish, and PowerShell #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions src/openai/cli/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
from ._cli import main as main
# openai/cli/main.py
import click

@click.group()
def cli():
"""OpenAI CLI — interact with the API from your terminal."""
pass

@cli.command()
@click.option("--shell", type=click.Choice(["bash", "zsh", "fish", "powershell"]), help="Shell type.")
def install_completion(shell):
"""
Install auto-completion for the OpenAI CLI.
"""
click.echo(f"To enable completion for {shell}, run:")
if shell == "bash":
click.echo('eval "$(_OPENAI_COMPLETE=bash_source openai)"')
elif shell == "zsh":
click.echo('eval "$(_OPENAI_COMPLETE=zsh_source openai)"')
elif shell == "fish":
click.echo('eval (env _OPENAI_COMPLETE=fish_source openai)')
elif shell == "powershell":
click.echo('Invoke-Expression -Command $(_OPENAI_COMPLETE=powershell_source openai)')
else:
click.echo("Unsupported shell. Use one of: bash, zsh, fish, powershell.")