Quick Start Guide

This guide provides the fastest way to get ChatFrame up and running.

1. Install ChatFrame

Download and install the application for your operating system (macOS or Windows) from the official website: https://www.chatframe.co/.

2. Get an API Key

ChatFrame uses the Bring Your Own Key (BYOK) model. You need an API key from a supported provider.

• Example: Get an OpenAI API Key: https://platform.openai.com/api-keys

3. Configure the Provider

1. Launch ChatFrame.
2. Go to the Providers tab in the settings.
3. Select the provider (e.g., OpenAI).
4. Paste your API key into the field.

4. Start Chatting

1. Navigate to the Chat interface.
2. Select your configured model from the dropdown.
3. Type your first prompt and press Enter.

5. Chat with Your Files (Local RAG)

1. Go to the File Indexing section.
2. Add a local file (PDF, code, etc.).
3. The file will be indexed locally.
4. Return to the chat and ask a question about the content of your file.

You are now ready to use ChatFrame's core features!