Getting Started

Getting Started#

This guide will help you get started with gptme.

Installation#

To install gptme, we recommend using pipx:

pipx install gptme

If pipx is not installed, you can install it using pip:

pip install --user pipx

Note

Windows is not directly supported, but you can run gptme using WSL or Docker.

Usage#

To start your first chat, simply run:

gptme

It will then start an interactive chat session where you can talk with the AI assistant.

If you haven’t set a LLM provider API key in the environment or configuration, you will be prompted for one which will be saved in the configuration file.

For detailed usage instructions and examples, see Usage.

Next Steps#

  • Read the Usage guide for detailed usage instructions and examples

  • Learn about available Tools

  • Explore different Providers

  • Set up the Server for web access

Support#

For any issues, please visit our issue tracker.