You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Install SnapShell with the following command:
22
22
pip install snapshell
23
23
```
24
24
### Custom Installation
25
-
SnapShell requires your `GROQ_API_KEY` during installation. Follow the on-screen instructions after installation
25
+
SnapShell requires your Groq Api key during installation. Follow the on-screen instructions after installation
26
26
27
27
The installation will automatically detect your shell (bash, zsh, fish) and set the key in the respective configuration file.
28
28
@@ -41,21 +41,20 @@ python setup.py install
41
41
SnapShell requires the following libraries:
42
42
43
43
-`argparse`: For parsing command-line arguments.
44
-
-`colorama`: For colorized terminal output.
45
44
-`sqlite3`: For local database operations.
46
45
-`os`: To interact with your operating system.
47
46
48
47
## Configuration Instructions
49
-
To use SnapShell, you need to set up the `GROQ_API_KEY` environment variable. This is required for connecting to the underlying Language Model API.
50
-
### Setting the `GROQ_API_KEY`
48
+
To use SnapShell, you need to set up the `HELPER_GROQ_API_KEY` environment variable. This is required for connecting to the underlying Language Model API.
49
+
### Setting the `HELPER_GROQ_API_KEY`
51
50
1. Obtain your API key from the GROQ service.
52
51
1. Set it as an environment variable:
53
52
```sh
54
-
exportGROQ_API_KEY="your_api_key_here"
53
+
exportHELPER_GROQ_API_KEY="your_api_key_here"
55
54
```
56
55
Alternatively, you can add this to your shell's configuration file (`.bashrc`, `.zshrc`, etc.):
@@ -125,9 +124,9 @@ We currently need help to integrate SnapShell with more shells and support more
125
124
```sh
126
125
pip install --upgrade pip
127
126
```
128
-
2.**Missing GROQ_API_KEY**: If SnapShell is not functioning properly, make sure the `GROQ_API_KEY` is correctly set as an environment variable. You can check this by running:
127
+
2.**Missing GROQ_API_KEY**: If SnapShell is not functioning properly, make sure the `HELPER_GROQ_API_KEY` is correctly set as an environment variable. You can check this by running:
129
128
```sh
130
-
echo$GROQ_API_KEY
129
+
echo$HELPER_GROQ_API_KEY
131
130
```
132
131
3.**Permission Denied**: If you encounter a "permission denied" error, try running the command with `sudo` or ensure you have the necessary file permissions.
133
132
4.**Clearing History Not Working**: If the history isn’t clearing, you might need to manually reset the SQLite database file used by SnapShell:
0 commit comments