⌨️ 🦾 Zsh Codex

AI in the command line.

You just need to write a comment or variable name and the AI will write the corresponding code.

Newer Version available (pip install kiera)

What is it?

This is a ZSH plugin that enables you to use OpenAI's powerful Codex AI in the command line. OpenAI Codex is the AI that also powers GitHub Copilot. To use this plugin you need to get access to OpenAI's Codex API.

How do I install it?

Manual Installation

Install the OpenAI package.

pip3 install openai

Download the ZSH plugin.

git clone https://github.com/tom-doerr/zsh_codex.git ~/.oh-my-zsh/custom/plugins/zsh_codex

Add the following to your .zshrc file.

Using oh-my-zsh:

    plugins=(zsh_codex)
    bindkey '^X' create_completion

Without oh-my-zsh:

    # in your/custom/path you need to have a "plugins" folder and in there you clone the repository as zsh_codex
    export ZSH_CUSTOM="your/custom/path"
    source "$ZSH_CUSTOM/plugins/zsh_codex/zsh_codex.plugin.zsh"
    bindkey '^X' create_completion

Create a file called openaiapirc in ~/.config with your ORGANIZATION_ID and SECRET_KEY.

[openai]
organization_id = ...
secret_key = ...

Run zsh, start typing and complete it using ^X!

Fig Installation

Troubleshooting

Unhandled ZLE widget 'create_completion'

zsh-syntax-highlighting: unhandled ZLE widget 'create_completion'
zsh-syntax-highlighting: (This is sometimes caused by doing `bindkey <keys> create_completion` without creating the 'create_completion' widget with `zle -N` or `zle -C`.)

Add the line

zle -N create_completion

before you call bindkey but after loading the plugin (plugins=(zsh_codex)).

Already exists and is not an empty directory

fatal: destination path '~.oh-my-zsh/custom/plugins'

Try to download the ZSH plugin again.

git clone https://github.com/tom-doerr/zsh_codex.git ~/.oh-my-zsh/custom/plugins/zsh_codex

More usage examples

Fish Version

Traffic Statistics

mkualquiera/zsh_codex