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
This will start an interactive chat session 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, see Usage.
You can also try the Examples.
Quick Examples#
Here are some compelling examples to get you started:
# Create applications and games
gptme 'write a web app to particles.html which shows off an impressive and colorful particle effect using three.js'
gptme 'create a performant n-body simulation in rust'
# Work with files and code
gptme 'summarize this' README.md
gptme 'refactor this' main.py
gptme 'what do you see?' image.png # vision
# Development workflows
git status -vv | gptme 'commit'
make test | gptme 'fix the failing tests'
gptme 'implement this' https://github.com/gptme/gptme/issues/286
# Chain multiple tasks
gptme 'make a change' - 'test it' - 'commit it'
# Resume conversations
gptme -r
Next Steps#
Support#
For any issues, please visit our issue tracker.