⌨️ 🦾 PowerShell Codex

AI in the command line. Powered by the AI behind GitHub Copilot.

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

What is it?

This is a powershell 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.

Forked from the impressive zsh version of this extension by Tom Doerr.

How to Install

1. Through PowerShellGallery (recommended, cross-platform)

# to install or update to the latest version
Install-Module -Name PoshCodex -Force

# to check if it's installed properly:
Get-Module -Name PoshCodex # should display the Write-Completion command

# Auto-import the module on every powershell session, so you can directly use the keybind for completion:
echo "`nImport-Module PoshCodex" >> $PROFILE

2. Through Scoop (Windows only)

Scoop is an easy-to-use command-line installer for Windows apps. You can get Scoop from here.

scoop bucket add poshcodex_bucket https://github.com/rishi255/posh_codex
scoop install PoshCodex # not case sensitive

# to update the module later:
scoop update PoshCodex

# Auto-import the module on every powershell session, so you can directly use the keybind for completion:
echo "`nImport-Module PoshCodex" >> $PROFILE

3. By building the module yourself

# Clone the repository
git clone https://github.com/rishi255/posh_codex
cd ./posh_codex/PoshCodex/

# Install Invoke-Build and build the module
Install-Module InvokeBuild -Force -RequiredVersion 3.2.1
Invoke-Build -File build.ps1 -Configuration 'Release'

# Now import the built module
Import-Module ./Output/PoshCodex/<version_number>/PoshCodex.psd1

# Now the module can be used in the current powershell session.
# See above step for auto-import on every powershell session.

Configuration of the OpenAI Codex API Key

This module requires access to the OpenAI Codex API for best results. You can join the waitlist for a Codex API key by following the instructions here.

Until you get a Codex API key, you can use the generic GPT-3 OpenAI API key by signing up on the OpenAI website.
However, the base GPT-3 model is not tailored for code completions and hence the suggestions are nowhere as good as the ones from the Codex API.

The module expects an environment variable called OPENAI_API_KEY to be set in the environment. You can set it with the following command:

$env:OPENAI_API_KEY="your_api_key"

Usage

Just type a comment or partial code snippet, and hit the keybind!

See the GIF above for a demonstration.

# type some comment that describes what you want to do, eg:
"# install the 'scoop' module" # with/without any of the quotes

# Just hit Ctrl+Alt+x (or your own keybind if changed) and the AI will write the corresponding code for you.

Changing the keybind

The module exposes a function to change the keybind to whatever you want to use. Default keybind is Ctrl+Alt+x, and can be changed like this:

Set-CompletionKeybind 'Shift+y'
Set-CompletionKeybind 'Tab'

# to set keybind as combination of two chords
Set-CompletionKeybind 'Ctrl+K,Ctrl+E'

List of all supported keys that can be separated by + is given here.

alexhaislip/posh_codex