@@ -21,63 +21,80 @@ Supports both:
21
21
22
22
## Installation
23
23
24
- #### Install via pip
24
+ ### Option 1: Install via Homebrew (recommended for macOS)
25
25
26
+ ``` bash
27
+ brew tap codingmoh/ghost-in-the-shell
28
+ brew install ghost-in-the-shell
26
29
```
30
+
31
+ ### Option 2: Install via pip (any OS)
32
+
33
+ ``` bash
27
34
pip install ghost-in-the-shell
28
35
```
29
36
30
- #### Clone & Install
37
+ ### Option 3: Clone & Install locally
31
38
32
39
``` bash
33
40
git clone https://github.com/codingmoh/ghost_in_the_shell.git
34
41
cd ghost_in_the_shell
35
42
pip install .
36
43
```
37
44
38
- Now you can use the ai command globally.
45
+ Now you can use the ` ai ` command globally.
39
46
40
- ### 2. Set OpenAI API Key
47
+ ---
41
48
42
- You need an OpenAI API key to use this tool.
49
+ ## 🔑 Set OpenAI API Key
43
50
44
- ```
51
+ You need an OpenAI API key to use this tool:
52
+
53
+ ``` bash
45
54
export OPENAI_API_KEY=" your-api-key-here"
46
55
```
56
+
57
+ You can also add this line to your ` .bashrc ` , ` .zshrc ` , or ` .bash_profile ` .
58
+
47
59
---
48
60
49
- 🚀 Usage
61
+ ## Usage
50
62
51
- One-shot prompt
63
+ ### One-shot prompt
52
64
53
- ```
65
+ ``` bash
54
66
ai " untar backup.tar.gz"
55
67
```
56
68
57
- - AI suggests a shell command
58
- - Asks for confirmation
59
- - Runs the command if you approve
69
+ ✅ AI suggests a shell command
70
+ ✅ Asks for confirmation
71
+ ✅ Runs the command if you approve
72
+
60
73
---
61
74
62
- Interactive mode
75
+ ### Interactive mode
63
76
77
+ ``` bash
64
78
ai -i
79
+ ```
65
80
66
- Open a chat session right in the terminal. Type natural language instructions like:
81
+ 🧠 Open a chat session right in the terminal.
82
+ 💬 Type natural language instructions like:
67
83
84
+ ```
68
85
You: compress all PNGs in this folder
69
- AI suggests : tar -czvf images.tar.gz * .png
70
-
86
+ AI: tar -czvf images.tar.gz *.png
87
+ ```
71
88
72
- Type exit or quit to leave.
89
+ Type ` exit ` or ` quit ` to leave.
73
90
74
91
---
75
92
76
- tmux Split Mode (optional)
93
+ ### 🪟 tmux Split Mode (optional)
77
94
78
95
Want to split your terminal into chat + shell?
79
96
80
- ```
97
+ ``` bash
81
98
tmux
82
99
# Then split horizontally:
83
100
Ctrl-B %
@@ -86,35 +103,35 @@ ai -i
86
103
# In right pane:
87
104
use your normal shell
88
105
```
106
+
89
107
---
90
108
91
- ### Security Notice
109
+ ## 🛡️ Security Notice
92
110
93
111
Always review AI-generated commands before executing them.
94
112
95
113
---
96
114
97
- ### Future Plans
98
- * Voice input via Whisper
99
- * Local LLM support (e.g., llama.cpp)
100
- * Fancy TUI with textual or rich
101
- * Command history and undo
102
- * Plugin system for workflows
115
+ ## 🧱 Future Plans
116
+
117
+ - Voice input via Whisper
118
+ - Local LLM support (e.g., llama.cpp)
119
+ - Fancy TUI with textual or rich
120
+ - Command history and undo
121
+ - Plugin system for workflows
103
122
104
123
---
105
124
106
- ### Contributing
125
+ ## Contributing
107
126
108
127
PRs welcome! Ideas, issues, improvements — all appreciated.
109
128
110
129
---
111
130
112
- ### License
131
+ ## 📝 License
113
132
114
133
MIT
115
134
116
135
---
117
- ❤️ Credits
118
-
119
- Built with love and caffeine by codingmoh.
120
136
137
+ ❤️ Built with love and caffeine by [ codingmoh] ( https://github.com/codingmoh ) .
0 commit comments