Skip to main content

CLI with OpenAI integration

Project description

Ghost in the Shell

AI Shell is a cross-platform command-line assistant that lets you use natural language to run shell commands. Whether you’re on macOS, Linux, or Windows, just type what you want to do — AI Shell will suggest the correct shell command, ask for your confirmation, and optionally execute it.

Supports both:

  • One-shot mode: ai "archive.tar" → returns shell command
  • Interactive mode: ai -i → opens a terminal chat with the AI

✨ Features

  • 🧠 Natural Language to Shell Command (via OpenAI API)
  • 🖥️ Works on macOS, Linux, and Windows (Python-based)
  • ✅ Confirmation before execution
  • 💬 Interactive chat mode for iterative CLI tasks
  • 🎨 Colored terminal output for better readability
  • 🪟 Optional tmux split-pane workflow (chat left, shell right)

Installation

Install via pip

pip install ghost-in-the-shell

Clone & Install

git clone https://github.com/codingmoh/ghost_in_the_shell.git
cd ghost_in_the_shell
pip install .

Now you can use the ai command globally.

2. Set OpenAI API Key

You need an OpenAI API key to use this tool.

export OPENAI_API_KEY="your-api-key-here"

🚀 Usage

One-shot prompt

ai "untar backup.tar.gz"

✅ AI suggests a shell command ✅ Asks for confirmation ✅ Runs the command if you approve


Interactive mode

ai -i

🧠 Open a chat session right in the terminal. 💬 Type natural language instructions like:

You: compress all PNGs in this folder AI suggests: tar -czvf images.tar.gz *.png

Type exit or quit to leave.


tmux Split Mode (optional)

Want to split your terminal into chat + shell?

tmux
# Then split horizontally:
Ctrl-B %
# In left pane:
ai -i
# In right pane:
use your normal shell

🛡️ Security Notice

Always review AI-generated commands before executing them.


🧱 Future Plans

  • Voice input via Whisper
  • Local LLM support (e.g., llama.cpp)
  • Fancy TUI with textual or rich
  • Command history and undo
  • Plugin system for workflows

🧑‍💻 Contributing

PRs welcome! Ideas, issues, improvements — all appreciated.


📝 License

MIT


❤️ Credits

Built with love and caffeine by codingmoh.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ghost_in_the_shell-0.1.5.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ghost_in_the_shell-0.1.5-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file ghost_in_the_shell-0.1.5.tar.gz.

File metadata

  • Download URL: ghost_in_the_shell-0.1.5.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for ghost_in_the_shell-0.1.5.tar.gz
Algorithm Hash digest
SHA256 3a90a16a2daa5f83072ec87197e8474afd6f0f4247f1f0c62597a7a5d6f7604b
MD5 0dc18ea42340958371c9e16200ae36ec
BLAKE2b-256 b17e0b8b7782f7d51a75a802df84ba33e680d77ba5f5c4928b5679d3bf3f1aec

See more details on using hashes here.

File details

Details for the file ghost_in_the_shell-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for ghost_in_the_shell-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fc4e4a63654036fecdc8c70cb2179763ec5eff76641396f91f1efd5c3201974a
MD5 bd8594341d7b1e158e34523c09ac5171
BLAKE2b-256 1f414e4324b158e097f91ac09d340b275083c4edd73c9adb1c82dd977c303895

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page