Skip to content

Commit 4122250

Browse files
committed
updated readme
1 parent 31a67a5 commit 4122250

File tree

1 file changed

+48
-31
lines changed

1 file changed

+48
-31
lines changed

README.md

Lines changed: 48 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -21,63 +21,80 @@ Supports both:
2121

2222
## Installation
2323

24-
#### Install via pip
24+
### Option 1: Install via Homebrew (recommended for macOS)
2525

26+
```bash
27+
brew tap codingmoh/ghost-in-the-shell
28+
brew install ghost-in-the-shell
2629
```
30+
31+
### Option 2: Install via pip (any OS)
32+
33+
```bash
2734
pip install ghost-in-the-shell
2835
```
2936

30-
#### Clone & Install
37+
### Option 3: Clone & Install locally
3138

3239
```bash
3340
git clone https://github.com/codingmoh/ghost_in_the_shell.git
3441
cd ghost_in_the_shell
3542
pip install .
3643
```
3744

38-
Now you can use the ai command globally.
45+
Now you can use the `ai` command globally.
3946

40-
### 2. Set OpenAI API Key
47+
---
4148

42-
You need an OpenAI API key to use this tool.
49+
## 🔑 Set OpenAI API Key
4350

44-
```
51+
You need an OpenAI API key to use this tool:
52+
53+
```bash
4554
export OPENAI_API_KEY="your-api-key-here"
4655
```
56+
57+
You can also add this line to your `.bashrc`, `.zshrc`, or `.bash_profile`.
58+
4759
---
4860

49-
🚀 Usage
61+
## Usage
5062

51-
One-shot prompt
63+
### One-shot prompt
5264

53-
```
65+
```bash
5466
ai "untar backup.tar.gz"
5567
```
5668

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+
6073
---
6174

62-
Interactive mode
75+
### Interactive mode
6376

77+
```bash
6478
ai -i
79+
```
6580

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:
6783

84+
```
6885
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+
```
7188

72-
Type exit or quit to leave.
89+
Type `exit` or `quit` to leave.
7390

7491
---
7592

76-
tmux Split Mode (optional)
93+
### 🪟 tmux Split Mode (optional)
7794

7895
Want to split your terminal into chat + shell?
7996

80-
```
97+
```bash
8198
tmux
8299
# Then split horizontally:
83100
Ctrl-B %
@@ -86,35 +103,35 @@ ai -i
86103
# In right pane:
87104
use your normal shell
88105
```
106+
89107
---
90108

91-
### Security Notice
109+
## 🛡️ Security Notice
92110

93111
Always review AI-generated commands before executing them.
94112

95113
---
96114

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
103122

104123
---
105124

106-
### Contributing
125+
## Contributing
107126

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

110129
---
111130

112-
### License
131+
## 📝 License
113132

114133
MIT
115134

116135
---
117-
❤️ Credits
118-
119-
Built with love and caffeine by codingmoh.
120136

137+
❤️ Built with love and caffeine by [codingmoh](https://github.com/codingmoh).

0 commit comments

Comments
 (0)