ShellGPT Kali Installer

Automated Kali Linux installer and setup guide for ShellGPT, a terminal-based AI assistant powered by OpenAI-compatible APIs.

---

One-Line Installation

curl -fsSL https://raw.githubusercontent.com/shahbaaz-devsec/shellgpt-kali-installer/main/scripts/shellgpt_kali_installer.sh | bash

---

Overview

This project provides a clean and reproducible way to install ShellGPT on Kali Linux.

It handles:

• Kali APT source repair
• Python virtual environment setup
• ShellGPT installation
• Global sgpt command launcher
• Bash and zsh PATH configuration
• OpenAI API key configuration support
• Clean troubleshooting workflow

---

Features

• Automated ShellGPT installation
• Isolated Python virtual environment
• Global sgpt launcher
• Kali Linux compatible
• Bash and zsh support
• Optional OpenAI API key setup
• OpenRouter-compatible configuration guidance

---

Quick Start

git clone https://github.com/shahbaaz-devsec/shellgpt-kali-installer.git
cd shellgpt-kali-installer
chmod +x scripts/shellgpt_kali_installer.sh
./scripts/shellgpt_kali_installer.sh

---

After Installation

Activate local user binaries:

export PATH="$HOME/.local/bin:$PATH"

Verify ShellGPT:

sgpt --help

Run a test prompt:

sgpt "hello"

---

API Key Requirement

ShellGPT requires an API key from an OpenAI-compatible provider.

A free ChatGPT account does not automatically include OpenAI API credits.

You can use:

• OpenAI API
• OpenRouter
• Other OpenAI-compatible providers

---

OpenAI Setup

export OPENAI_API_KEY="your_openai_api_key_here"
sgpt "hello"

---

OpenRouter Setup

Use OpenRouter if you do not have OpenAI API billing enabled.

export OPENAI_API_KEY="your_openrouter_api_key_here"

Then configure ShellGPT to use:

OPENAI_API_BASE=https://openrouter.ai/api/v1

See:

docs/03-openrouter-setup.md

---

Project Structure

scripts/
  └── shellgpt_kali_installer.sh

docs/
  ├── 01-installation.md
  ├── 02-usage.md
  ├── 03-openrouter-setup.md
  ├── 04-troubleshooting.md
  └── 05-clean-reset.md

---

Requirements

• Kali Linux rolling
• Internet connection
• Python 3
• API key from OpenAI or compatible provider

---

Disclaimer

Use this project responsibly. ShellGPT can generate shell commands, so always review commands before running them.

---

License

MIT License

---

Screenshots

Installation Process

ShellGPT Running