- Simplified README.md by moving detailed command docs, workflows, and development info to dedicated user-guide/ and developer-guide/ directories. - Created index.md files for both guides to improve navigation. - Extracted individual command guides (e.g., chat.md, edit.md) into user-guide/ for focused, maintainable documentation. - Moved architecture, configuration, and troubleshooting to developer-guide/. - Updated README links to point to the new docs structure.
46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
# 💬 Chat Guide
|
|
|
|
The `chat` command starts a full interactive session with Grok. Unlike other commands that are one-shot, `chat` maintains a conversation history, allowing for multi-turn dialogues and context-aware responses.
|
|
|
|
### Key Features
|
|
|
|
- **Interactive**: Real-time conversation with Grok.
|
|
- **Streaming**: Responses are streamed to your terminal as they are generated.
|
|
- **History**: Grokkit automatically saves and reloads your chat history from `~/.config/grokkit/chat_history.json`.
|
|
- **System Prompt**: Grok is configured with a project-aware system prompt to provide relevant answers.
|
|
|
|
### Usage
|
|
|
|
```bash
|
|
grokkit chat # Start chat session
|
|
grokkit chat -m grok-beta # Use specific model
|
|
grokkit chat --debug # Enable debug logging
|
|
```
|
|
|
|
### Tips
|
|
|
|
- Type `/quit`, `/q`, or `exit` to exit
|
|
- History is saved automatically between sessions
|
|
- Use `--debug` to see API request timing
|
|
|
|
### Commands within Chat
|
|
|
|
- `/quit` or `/q`: Exit the chat session.
|
|
- `exit`: Exit the chat session.
|
|
- `Ctrl+C`: Exit the chat session.
|
|
|
|
### Options
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--model`, `-m` | Override the default model (e.g., `grok-4`) |
|
|
|
|
### Configuration
|
|
|
|
You can configure the location of the history file in your `config.toml`:
|
|
|
|
```toml
|
|
[chat]
|
|
history_file = "~/.config/grokkit/my_custom_history.json"
|
|
```
|