https://github.com/u-c4n/byte-terminal
AI-powered interactive chat interface using Groq API. Features a terminal-like UI, local storage, and customizable commands. Ideal for developers exploring LLMs.
https://github.com/u-c4n/byte-terminal
ai chatbot genai groq rag
Last synced: 3 months ago
JSON representation
AI-powered interactive chat interface using Groq API. Features a terminal-like UI, local storage, and customizable commands. Ideal for developers exploring LLMs.
- Host: GitHub
- URL: https://github.com/u-c4n/byte-terminal
- Owner: U-C4N
- License: mit
- Created: 2024-08-08T20:23:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-14T08:48:01.000Z (10 months ago)
- Last Synced: 2025-04-28T13:29:51.120Z (5 months ago)
- Topics: ai, chatbot, genai, groq, rag
- Language: JavaScript
- Homepage: https://www.uc4n.com
- Size: 2.84 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Byte Terminal
Welcome to Byte Terminal - Umutcan Edizaslan's Coder's Playground!
## Overview
Byte Terminal is an interactive web-based chat interface that allows users to communicate with AI models using the Groq API. It provides a sleek, terminal-like experience with customizable features, local storage capabilities, and now includes Retrieval-Augmented Generation (RAG) functionality for PDF documents.
You can try it at [https://uc4n.com](https://uc4n.com)
## Features
- **AI Chat Interface**: Interact with AI models through a user-friendly terminal-like interface.
- **Groq API Integration**: Seamlessly connect with Groq's powerful AI models.
- **Local Storage**: Save API keys, model preferences, and chat history locally in the browser.
- **Customizable Commands**: Use built-in commands to manage your experience.
- **Syntax Highlighting**: Enjoy color-coded outputs for better readability.
- **Conversation Export**: Save your chat history as a JSON file.
- **Text Formatting**:
- Model names are displayed in blue.
- AI responses are displayed in white.
- Text enclosed in double asterisks (`**like this**`) is displayed in blue and bold.
- **PDF RAG**: Upload PDF documents (up to 15MB) and chat with their content using Retrieval-Augmented Generation.
- **RAG History**: View a table of all uploaded PDF files with their details.
## Usage
### Setting Up
1. Set your Groq API key:
```
/groq your-api-key-here
```
2. Set your preferred model:
```
/model model-name-here
```
### Commands
- `/help`: Display available commands
- `/groq `: Set the API key
- `/model `: Set the model name
- `/deletea`: Delete the stored API key
- `/deletem`: Delete the stored model name
- `/clear`: Clear the terminal
- `/save`: Save the conversation history as JSON
- `/upload`: Upload a PDF file for RAG functionality
- `/historyofrag`: Display a table of uploaded PDF files with their details
### Chatting
Once you've set up your API key and model, simply type your message and press Enter to chat with the AI.
### Using RAG with PDF Documents
1. Type `/upload` in the terminal.
2. Select a PDF file (up to 15MB) when prompted.
3. Wait for the PDF to be processed. You'll see a confirmation message.
4. Start asking questions about the PDF content. The AI will use the document information to provide more contextual and accurate answers.
5. To view a history of all uploaded PDFs, use the `/historyofrag` command.
**Note on Formatting**: If you want to emphasize part of your message, you can enclose it in double asterisks. For example, typing "This is **important**" will display "important" in blue and bold in the chat interface.
## Customization
You can customize the appearance of Byte Terminal by modifying the CSS in the section of index.html.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- Thanks to Groq for providing the AI API.
- Special thanks to all contributors and users of Byte Terminal.
## Author
<p align="left">
<b>Umutcan Edizaslan:</b>
<a href="https://github.com/U-C4N" target="blank"><img align="center" src="https://raw.githubusercontent.com/tandpfun/skill-icons/main/icons/Github-Dark.svg" alt="TutTrue" height="30" width="40" /></a>
<a href="https://x.com/UEdizaslan" target="blank"><img align="center" src="https://raw.githubusercontent.com/tandpfun/skill-icons/main/icons/Twitter.svg" height="30" width="40" /></a>
<a href="https://discord.gg/2Tutcj6u" target="blank"><img align="center" src="https://raw.githubusercontent.com/tandpfun/skill-icons/main/icons/Discord.svg" height="30" width="40" /></a>
</p>