Level up z shell with GPT
Project description
zshgpt
Table of Contents
About
Heavily inspired by the abandoned project https://github.com/microsoft/Codex-CLI Made into a oh-my-zsh plugin.
In your zsh console, type a question, starting with comment sign #
, hit ctrl+g
and get an answer.
# Who edited README.MD last according to git history?
ChatGPT will then answer with e.g.:
git log -1 --format="%an" README.md
Hit enter
to execute or ctrl+c
to deny.
If asked a question that will not resolve in a command, GPT is instructed to use #
.
# Who was Norways first prime minister?
# Norway's first prime minister was Frederik Stang, serving from 1873 to 1880.
Prerequisite
Installing zshgpt
First install zshgpt application, then add the plugin.
Prerequisite
- ⚠️ Valid Openai API-key ⚠️
- make sure to save under
OPENAI_API_KEY
env. export OPENAI_API_KEY='sk-...'
- make sure to save under
With snap
Snap comes preinstalled and is probalby the fastest way if you are on Linux and do not want to use pipx.
Prerequisite
- snap
sudo snap install zshgpt
Instructions if you don't have snap.
With pipx
Prerequisite
- python >= 3.8
- pipx
pipx install zshgpt
WIth pip
Prerequisite
- python >= 3.8
- pip
pip install zshgpt
With homebrew
This is not yet automated and you might get an older version.
Prerequisite
- Homebrew
brew install AndersSteenNilsen/zshgpt/zshgpt
Adding plugin
With Zsh
curl https://raw.githubusercontent.com/AndersSteenNilsen/zshgpt/main/zshgpt.plugin.zsh -o ~ # Copy plugin
echo "source ~/zshgpt.plugin.zsh" >> ~/.zshrc # Add to zshrc
exec zsh # Reload zsh
With Oh My Zsh
Prerequisite
mkdir $ZSH_CUSTOM/plugins/zshgpt
curl https://raw.githubusercontent.com/AndersSteenNilsen/zshgpt/main/zsh_plugin.zsh -o $ZSH_CUSTOM/plugins/zshgpt/zshgpt.plugin.zsh
Then add zshgpt in your list of plugins in ~/.zshrc
plugins(
...
zshgpt
...
)
omz reload
With zplug
~/.zshrc
...
zplug "AndersSteenNilsen/zshgpt"
zplug load
LOGO
Made with DALL-E
License
zshgpt
is distributed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.