Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic instructions for using xAI Grok. #655

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add basic instructions for using xAI Grok. #655

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2eb0be5
Add basic instructions for using xAI Grok.
psteyn Dec 13, 2024
7e7b81c
Fix wording.
psteyn Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ By default, ShellGPT uses OpenAI's API and GPT-4 model. You'll need an API key,
> [!TIP]
> Alternatively, you can use locally hosted open source models which are available for free. To use local models, you will need to run your own LLM backend server such as [Ollama](https://github.com/ollama/ollama). To set up ShellGPT with Ollama, please follow this comprehensive [guide](https://github.com/TheR1D/shell_gpt/wiki/Ollama).
>
> xAI Grok also maintains backwards compatability with the OpenAI API.
> You may use an xAI token with Grok2 like so
```
export OPENAI_API_KEY='xai-xxxx'
export DEFAULT_MODEL="grok-beta" #Or whatever model is listed at the time, and preferred.
export API_BASE_URL=https://api.x.ai/v1
```
> Basic testing done, but *your mileage may vary*.

> **❗️Note that ShellGPT is not optimized for local models and may not work as expected.**

## Usage
Expand Down