Skip to content

Commit 2154cbd

Browse files
committed
issue-fix
1 parent c51aca3 commit 2154cbd

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Install SnapShell with the following command:
2222
pip install snapshell
2323
```
2424
### 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
2626

2727
The installation will automatically detect your shell (bash, zsh, fish) and set the key in the respective configuration file.
2828

@@ -41,21 +41,20 @@ python setup.py install
4141
SnapShell requires the following libraries:
4242

4343
- `argparse`: For parsing command-line arguments.
44-
- `colorama`: For colorized terminal output.
4544
- `sqlite3`: For local database operations.
4645
- `os`: To interact with your operating system.
4746

4847
## 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`
5150
1. Obtain your API key from the GROQ service.
5251
1. Set it as an environment variable:
5352
```sh
54-
export GROQ_API_KEY="your_api_key_here"
53+
export HELPER_GROQ_API_KEY="your_api_key_here"
5554
```
5655
Alternatively, you can add this to your shell's configuration file (`.bashrc`, `.zshrc`, etc.):
5756
```sh
58-
echo 'export GROQ_API_KEY="your_api_key_here"' >> ~/.bashrc
57+
echo 'export HELPER_GROQ_API_KEY="your_api_key_here"' >> ~/.bashrc
5958
```
6059
Reload the shell configuration:
6160
```sh
@@ -125,9 +124,9 @@ We currently need help to integrate SnapShell with more shells and support more
125124
```sh
126125
pip install --upgrade pip
127126
```
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:
129128
```sh
130-
echo $GROQ_API_KEY
129+
echo $HELPER_GROQ_API_KEY
131130
```
132131
3. **Permission Denied**: If you encounter a "permission denied" error, try running the command with `sudo` or ensure you have the necessary file permissions.
133132
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

Comments
 (0)