Your agent in your terminal, equipped with local tools: writes code, uses the terminal, browses the web, vision.
3,897
324
<p align="center">
<img src="https://gptme.org/media/logo.png" width=150 />
</p>
<h1 align="center">gptme</h1>
<p align="center">
<i>/ʤiː piː tiː miː/</i>
</p>
<!-- Links -->
<p align="center">
<a href="https://gptme.org/docs/getting-started.html">Getting Started</a>
•
<a href="https://gptme.org/">Website</a>
•
<a href="https://gptme.org/docs/">Documentation</a>
</p>
<!-- Badges -->
<p align="center">
<a href="https://github.com/gptme/gptme/actions/workflows/build.yml">
<img src="https://github.com/gptme/gptme/actions/workflows/build.yml/badge.svg" alt="Build Status" />
</a>
<a href="https://github.com/gptme/gptme/actions/workflows/docs.yml">
<img src="https://github.com/gptme/gptme/actions/workflows/docs.yml/badge.svg" alt="Docs Build Status" />
</a>
<a href="https://codecov.io/gh/gptme/gptme">
<img src="https://codecov.io/gh/gptme/gptme/graph/badge.svg?token=DYAYJ8EF41" alt="Codecov" />
</a>
<br>
<a href="https://pypi.org/project/gptme/">
<img src="https://img.shields.io/pypi/v/gptme" alt="PyPI version" />
</a>
<a href="https://pepy.tech/project/gptme">
<img src="https://img.shields.io/pepy/dt/gptme" alt="PyPI - Downloads all-time" />
</a>
<a href="https://pypistats.org/packages/gptme">
<img src="https://img.shields.io/pypi/dd/gptme?color=success" alt="PyPI - Downloads per day" />
</a>
<br>
<a href="https://discord.gg/NMaCmmkxWv">
<img src="https://img.shields.io/discord/1271539422017618012?logo=discord&style=social" alt="Discord" />
</a>
<a href="https://x.com/gptmeorg">
<img src="https://img.shields.io/twitter/follow/gptmeorg?style=social" alt="X.com" />
</a>
<br>
<a href="https://gptme.org/docs/projects.html">
<img src="https://img.shields.io/badge/powered%20by-gptme%20%F0%9F%A4%96-5151f5?style=flat" alt="Powered by gptme" />
</a>
</p>
<p align="center">
📜 Personal AI assistant/agent in your terminal, with tools so it can:<br/>Use the terminal, run code, edit files, browse the web, use vision, and much more;<br/>a great coding agent, but is general-purpose to assists in all kinds of knowledge-work, from a simple but powerful CLI.
</p>
<p align="center">
An unconstrained local <a href="https://gptme.org/docs/alternatives.html">alternative</a> to: ChatGPT with "Code Interpreter", Cursor Agent, etc.<br/>Not limited by lack of software, internet access, timeouts, or privacy concerns (if using local models).
</p>
📚 Table of Contents
🎥 Demos
<table> <tr> <th>Fibonacci (old)</th> <th>Snake with curses</th> </tr> <tr> <td width="50%">[!NOTE]
These demos are very out of date and do not reflect the latest capabilities. We hope to update them soon!
You can find more Demos and Examples in the documentation.
🌟 Features
- 💻 Code execution
- Executes code in your local environment with the shell and python tools.
- 🧩 Read, write, and change files
- Makes incremental changes with the patch tool.
- 🌐 Search and browse the web.
- Can use a browser via Playwright with the browser tool.
- 👀 Vision
- Can see images referenced in prompts, screenshots of your desktop, and web pages.
- 🔄 Self-correcting
- Output is fed back to the assistant, allowing it to respond and self-correct.
- 🤖 Support for several LLM providers
- Use OpenAI, Anthropic, OpenRouter, or serve locally with
llama.cpp - 🌐 Web UI and REST API
- Modern web interface at chat.gptme.org (gptme-webui)
- Simple built-in web UI included in the Python package
- Server with REST API
- Standalone executable builds available with PyInstaller
- 💻 Computer use tool, as hyped by Anthropic (see #216)
- Give the assistant access to a full desktop, allowing it to interact with GUI applications.
- 🤖 Long-running agents and advanced agent architectures (see #143 and #259)
- Create your own agent with persistence using gptme-agent-template, like Bob.
- ✨ Many smaller features to ensure a great experience
- 🚰 Pipe in context via
stdinor as arguments. - Passing a filename as an argument will read the file and include it as context.
- → Smart completion and highlighting:
- Tab completion and highlighting for commands and paths
- 📝 Automatic naming of conversations
- ✅ Detects and integrates pre-commit
- 🗣️ Text-to-Speech support, locally generated using Kokoro
- 🎯 Feature flags for advanced usage, see configuration docs
🛠 Use Cases
- 🖥 Development: Write and run code faster with AI assistance.
- 🎯 Shell Expert: Get the right command using natural language (no more memorizing flags!).
- 📊 Data Analysis: Process and analyze data directly in your terminal.
- 🎓 Interactive Learning: Experiment with new technologies or codebases hands-on.
- 🤖 Agents & Tools: Experiment with agents & tools in a local environment.
🛠 Developer perks
- 🧰 Easy to extend
- Most functionality is implemented as tools, making it easy to add new features.
- 🧪 Extensive testing, high coverage.
- 🧹 Clean codebase, checked and formatted with
mypy,ruff, andpyupgrade. - 🤖 GitHub Bot to request changes from comments! (see #16)
- Operates in this repo! (see #18 for example)
- Runs entirely in GitHub Actions.
- 📊 Evaluation suite for testing capabilities of different models
- 📝 gptme.vim for easy integration with vim
🚧 In progress
- 🌳 Tree-based conversation structure (see #17)
- 📜 RAG to automatically include context from local files (see #59)
- 🏆 Advanced evals for testing frontier capabilities
🚀 Getting Started
Install with pipx:
# requires Python 3.10+
pipx install gptmeNow, to get started, run:
gptmeHere are some examples:
gptme 'write an impressive and colorful particle effect using three.js to particles.html'
gptme 'render mandelbrot set to mandelbrot.png'
gptme 'suggest improvements to my vimrc'
gptme 'convert to h265 and adjust the volume' video.mp4
git diff | gptme 'complete the TODOs in this diff'
make test | gptme 'fix the failing tests'For more, see the Getting Started guide and the Examples in the documentation.
🛠 Usage
$ gptme --help
Usage: gptme [OPTIONS] [PROMPTS]...
gptme is a chat-CLI for LLMs, empowering them with tools to run shell
commands, execute code, read and manipulate files, and more.
If PROMPTS are provided, a new conversation will be started with it. PROMPTS
can be chained with the '-' separator.
The interface provides user commands that can be used to interact with the
system.
Available commands:
/undo Undo the last action
/log Show the conversation log
/tools Show available tools
/model List or switch models
/edit Edit the conversation in your editor
/rename Rename the conversation
/fork Copy the conversation using a new name
/summarize Summarize the conversation
/replay Rerun tools in the conversation, won't store output
/impersonate Impersonate the assistant
/tokens Show the number of tokens used
/export Export conversation as HTML
/help Show this help message
/exit Exit the program
Keyboard shortcuts:
Ctrl+X Ctrl+E Edit prompt in your editor
Ctrl+J Insert a new line without executing the prompt
Options:
--name TEXT Name of conversation. Defaults to generating a random
name.
-m, --model TEXT Model to use, e.g. openai/gpt-4o,
anthropic/claude-3-7-sonnet-20250219. If only
provider given then a default is used.
-w, --workspace TEXT Path to workspace directory. Pass '@log' to create a
workspace in the log directory.
-r, --resume Load last conversation
-y, --no-confirm Skips all confirmation prompts.
-n, --non-interactive Non-interactive mode. Implies --no-confirm.
--system TEXT System prompt. Can be 'full', 'short', or something
custom.
-t, --tools TEXT Comma-separated list of tools to allow. Available:
append, browser, chats, computer, gh, ipython, patch,
rag, read, save, screenshot, shell, subagent, tmux,
vision.
--tool-format TEXT Tool parsing method. Can be 'markdown', 'xml',
'tool'. (experimental)
--no-stream Don't stream responses
--show-hidden Show hidden system messages.
-v, --verbose Show verbose output.
--version Show version and configuration information
--help Show this message and exit.📊 Stats
⭐ Stargazers over time
