Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beimzhan/shell-whiz
🚀 AI assistant for the command line 💫
https://github.com/beimzhan/shell-whiz
chatgpt chatgpt-api
Last synced: 2 months ago
JSON representation
🚀 AI assistant for the command line 💫
- Host: GitHub
- URL: https://github.com/beimzhan/shell-whiz
- Owner: beyimjan
- License: gpl-3.0
- Created: 2023-07-05T07:16:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-23T10:15:41.000Z (9 months ago)
- Last Synced: 2024-05-18T19:44:54.215Z (8 months ago)
- Topics: chatgpt, chatgpt-api
- Language: Python
- Homepage: https://pypi.org/project/shell-whiz
- Size: 3.92 MB
- Stars: 40
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ai-devtools - Shell Whiz
- awesome-ai-dev-tools - Shell Whiz - Configurable CLI assistant for shell commands. (Shell Assistants / IDE Extensions)
README
Shell Whiz is an AI assistant for the command line. It will help you find the right command to solve your task. This way, you can _save your time and effort_ without diving into documentation, man pages, or searching the web.
## Installation 🛠️
To install Shell Whiz, run the following command:
```bash
pip install shell-whiz
```
Or, if you prefer to use [pipx](https://github.com/pypa/pipx):
```bash
pipx install shell-whiz
```
This will add the `sw` command to your `PATH`.
To use the assistant you'll need an API key from OpenAI. Obtain this key by visiting https://platform.openai.com/api-keys. Once you have the key, you can set it either by running `sw config` or by setting the `OPENAI_API_KEY` environment variable.
## Getting started ✨
You can run the assistant directly using `sw ask`, but I recommend creating an alias for it. For example, you can add the following line to the bottom of your `~/.bashrc` file:
```bash
alias '??'='sw ask'
```
PowerShell users can create a function in their [PowerShell profile](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles).
```powershell
function ?? {
sw ask `
-s (Get-Command powershell.exe).Source `
-m gpt-4o `
-p "I use PowerShell on a daily basis" `
@Args
}
```
You can also create a function that allows you to save executed commands in history. Here are the functions for Bash and Zsh:
```bash
# ~/.bashrc
whiz-shell() {
TMPFILE=$(mktemp)
trap 'rm -f $TMPFILE' EXIT
if sw ask -o "$TMPFILE" "$@"; then
if [ -e "$TMPFILE" ]; then
SW_CMD=$(cat "$TMPFILE")
history -s $(history 1 | cut -d' ' -f4-)
history -s "$SW_CMD"
eval "$SW_CMD"
else
echo "Sorry, something went wrong." >&2
fi
else
return 1
fi
}
alias '??'='whiz-shell'
```
```zsh
# ~/.zshrc
whiz-shell() {
TMPFILE=$(mktemp)
trap 'rm -f $TMPFILE' EXIT
if sw ask -o "$TMPFILE" "$@"; then
if [ -e "$TMPFILE" ]; then
SW_CMD=$(cat "$TMPFILE")
print -s "$SW_CMD"
eval "$SW_CMD"
else
echo "Sorry, something went wrong." >&2
fi
else
return 1
fi
}
alias '??'='whiz-shell'
```
To track API usage and costs, periodically visit the [OpenAI API Usage](https://platform.openai.com/usage) page.
## Advanced usage 🚀
The assistant can be easily configured for any task using command line arguments.
The most powerful option is `-p "..."` or `--preferences "..."`. This setting can be used to select the shell environment or even the language of the assistant's responses. The default value is `I use Bash on Linux`.
Run `sw ask --help` for more information.
