@@ -24,11 +24,10 @@ efficiency to your command-line interactions. ShellOracle currently supports Oll
24
24
25
25
![ ShellOracle] ( https://i.imgur.com/GJX3eEq.gif )
26
26
27
- Explore our dynamic features and look forward to more exciting updates by giving us a ⭐ and a 👀
27
+ Show your support for ShellOracle and keep an eye out for exciting new developments by clicking the ⭐ and a 👀!
28
28
29
29
## Table of Contents
30
30
31
- - [ Introduction] ( #introduction )
32
31
- [ Features] ( #features )
33
32
- [ Installation] ( #installation )
34
33
- [ Usage] ( #usage )
@@ -37,28 +36,6 @@ Explore our dynamic features and look forward to more exciting updates by giving
37
36
- [ System Requirements] ( #system-requirements )
38
37
- [ Feedback] ( #feedback )
39
38
40
- ## Introduction
41
-
42
- Meet ShellOracle—a handy tool that makes working with the command line a bit smoother. This terminal utility lets you
43
- create shell commands by describing what you want to do in plain language. ShellOracle simplifies the process of
44
- crafting complex commands by removing the need to google and comb man pages.
45
-
46
- ** Why ShellOracle?**
47
-
48
- * ** No More Memorizing:** Forget about remembering complex shell commands. Just tell ShellOracle what you need, and
49
- it'll generate the command for you.
50
-
51
- * ** Save Time, Stay Focused:** Say goodbye to manual command crafting. ShellOracle helps you save time and concentrate
52
- on what really matters by using natural language descriptions.
53
-
54
- * ** Adaptable to Your Needs:** Whether it's a quick one-liner or a sequence of commands, ShellOracle is flexible. It
55
- supports Unix pipes and keeps track of your command history.
56
-
57
- * ** Your Control, Your Way:** Run ShellOracle as a self-hosted utility to have complete control. Tailor it to your
58
- preferences and make it work just the way you want.
59
-
60
- Give it a try and see how it fits into your workflow!
61
-
62
39
## Features
63
40
64
41
Key features of ShellOracle include:
@@ -73,16 +50,25 @@ Key features of ShellOracle include:
73
50
74
51
Installing ShellOracle is easy!
75
52
76
- 1 . Pip install the ` shelloracle ` package
53
+ 1 . [ pipx ] ( https://pipx.pypa.io/latest/ ) install the ` shelloracle ` package
77
54
``` shell
78
- python3 -m pip install shelloracle
55
+ pipx install shelloracle
79
56
```
80
- 2. Configure ShellOracle with ` shelloracle configure ` and follow the prompts
57
+ 2. Configure ShellOracle and follow the prompts
81
58
` ` ` shell
82
- python3 -m shelloracle configure
59
+ shor configure
83
60
` ` `
84
61
3. Refer to the [providers](# providers) section for specific details regarding your chosen provider.
85
62
63
+ Upgrading to the latest version of ShellOracle is just as simple!
64
+
65
+ 1. pipx upgrade the ` shelloracle` package
66
+ ` ` ` shell
67
+ pipx upgrade shelloracle
68
+ ` ` `
69
+
70
+ * Installation with ` pip` is supported, however, ` pipx` is preferred for its automatic environment isolation.*
71
+
86
72
# # Usage
87
73
88
74
ShellOracle is designed to be used as a BASH/ZSH widget activated by the CTRL+F keyboard shortcut.
@@ -93,15 +79,27 @@ ShellOracle is designed to be used as a BASH/ZSH widget activated by the CTRL+F
93
79
94
80
The generated command will be inserted into your shell prompt after a brief processing period.
95
81
82
+ # ## Other ways to run ShellOracle
83
+
84
+ ShellOracle can be run as a Python module with ` python3 -m shelloracle` or using its entrypoint ` shor` , however,
85
+ running ShellOracle with this method will not automatically insert the result into your shell prompt.
86
+
87
+ # ## Tips
88
+
89
+ 1. If you press CTRL+F with text in your ZLE buffer, all text left of your cursor will carry over to your ShellOracle
90
+ prompt.
91
+ 2. ⬆️ arrow and ⬇️ arrow cycle through your prompt history.
92
+ 3. ShellOracle can be chained with other commands; try: ` echo " find all the python files in my cwd" | shor`
93
+
96
94
# # Providers
97
95
98
96
# ## Ollama
99
97
100
98
Before using ShellOracle with Ollama, pull the model you chose in the configure step.
101
- For example, if you chose ` codellama:13b ` , run:
99
+ For example, if you chose ` dolphin-mistral ` , run:
102
100
103
101
` ` ` shell
104
- ollama pull codellama:13b
102
+ ollama pull dolphin-mistral
105
103
` ` `
106
104
107
105
Refer to the [Ollama docs](https://ollama.ai) for installation, available models, and usage.
@@ -115,20 +113,6 @@ your `~/.shelloracle/config.toml` to change your provider and enter your API key
115
113
116
114
Refer to the [LocalAI docs](https://localai.io/) for installation, available models, and usage.
117
115
118
- # ## Other ways to run ShellOracle
119
-
120
- ShellOracle can be run as a Python module with ` python3 -m shelloracle` or using its entrypoint ` shor` ; however,
121
- there are a few caveats with this method:
122
- - Ensure your ` ~/.local/bin` directory is added to your PATH variable for the entrypoint to work.
123
- - Running ShellOracle with this method will not automatically insert the result into your shell prompt.
124
-
125
- # ## Tips
126
-
127
- 1. If you press CTRL+F with text in your ZLE buffer, all text left of your cursor will carry over to your ShellOracle
128
- prompt.
129
- 2. UP_ARROW and DOWN_ARROW cycle through your prompt history.
130
- 3. ShellOracle can be chained with other commands; try: ` echo " find all the python files in my cwd" | shor`
131
-
132
116
# # Configuration
133
117
134
118
ShellOracle' s configuration is your gateway to tailoring the utility to match your preferences and requirements.
@@ -143,12 +127,15 @@ ShellOracle supports BASH and ZSH on macOS and Linux.
143
127
144
128
# ## Hardware
145
129
146
- For cloud providers like OpenAI, there are no specific system requirements.
130
+ For cloud providers like OpenAI, there are no hardware requirements.
147
131
148
- If self-hosting, system requirements vary based on the model used. Refer to the Ollama model registry for more
149
- information.
132
+ If running locally, refer to your model for hardware requirements.
150
133
151
134
# # Feedback
152
135
153
136
Encountered problems? [File an issue](https://github.com/djcopley/ShellOracle/issues/new). Feature requests are welcome,
154
137
and contributions can be made by opening a pull request.
138
+
139
+ # # License
140
+
141
+ This software is licensed under the GPLv3 license.
0 commit comments