Gptme

gptme /ʤiː piː tiː miː/ Getting Started • Website • Documentation Use the terminal, run code, edit files, browse the web, use vision, and much more;a great coding agent, but is general-purpose to assists in all kinds of knowledge-work, from a simple but powerful CLI. An unconstrained local alternative to: ChatGPT with "Code Interpreter", Cursor Agent, etc.Not limited by lack of software, internet access, timeouts, or privacy concerns (if using local models).

📚 Table of Contents

• 🎥 Demos
• 🌟 Features
• 🚀 Getting Started
• 🛠 Usage
• 📊 Stats
• 🔗 Links

🎥 Demos

[!NOTE] These demos are very out of date and do not reflect the latest capabilities. We hope to update them soon! Fibonacci (old) Snake with curses demo screencast with asciinema Steps Create a new dir 'gptme-test-fib' and git init Write a fib function to fib.py, commit Create a public repo and push to GitHub 621992-resvg Steps Create a snake game with curses to snake.py Running fails, ask gptme to fix a bug Game runs Ask gptme to add color Minor struggles Finished game with green snake and red apple pie! Mandelbrot with curses Answer question from URL mandelbrot-curses Steps Render mandelbrot with curses to mandelbrot_curses.py Program runs Add color superuserlabs-ceo Steps Ask who the CEO of Superuser Labs is, passing website URL gptme browses the website, and answers correctly Terminal UI Web UI Features Powerful terminal interface Convenient CLI commands Diff & Syntax highlighting Tab completion Command history Features Chat with gptme from your browser Access to all tools and features Modern, responsive interface Self-hostable Available at chat.gptme.org You can find more [Demos][docs-demos] and [Examples][docs-examples] in the [documentation][docs].

🌟 Features

• 💻 Code execution
• Executes code in your local environment with the [shell][docs-tools-shell] and [python][docs-tools-python] tools.
• 🧩 Read, write, and change files
• Makes incremental changes with the [patch][docs-tools-patch] tool.
• 🌐 Search and browse the web.
• Can use a browser via Playwright with the [browser][docs-tools-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][docs-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][docs-server] with REST API
• 💻 Computer use][docs-tools-computer] tool, as hyped by [Anthropic][anthropic-computer-use] (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][agent-template], like [Bob][bob].
• ✨ Many smaller features to ensure a great experience
• 🚰 Pipe in context via stdin or 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][docs-tools-tts] support, locally generated using Kokoro
• 🎯 Feature flags for advanced usage, see [configuration docs][docs-config]

🛠 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][docs-tools], making it easy to add new features.
• 🧪 Extensive testing, high coverage.
• 🧹 Clean codebase, checked and formatted with mypy, ruff, and pyupgrade.
• 🤖 GitHub Bot][docs-bot] to request changes from comments! (see [#16)
• Operates in this repo! (see #18 for example)
• Runs entirely in GitHub Actions.
• 📊 [Evaluation suite][docs-evals] for testing capabilities of different models
• 📝 [gptme.vim][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 gptme

Now, to get started, run:

gptme

Here 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][docs-getting-started] guide and the [Examples][docs-examples] in the [documentation][docs].

🛠 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
 /edit Edit the conversation in your editor
 /rename Rename the conversation
 /fork Create a copy of the conversation with a new name
 /summarize Summarize the conversation
 /replay Re-execute codeblocks in the conversation, wont store output in log
 /impersonate Impersonate the assistant
 /tokens Show the number of tokens used
 /export Export conversation as standalone HTML
 /help Show this help message
 /exit Exit the program
 Keyboard shortcuts:
 Ctrl+J Insert a new line without executing the prompt
Options:
 -n, --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-5-sonnet-20240620. If only
 provider given, 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 Force 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:
 read, save, append, patch, shell, subagent, tmux,
 browser, gh, chats, screenshot, vision, computer,
 python.
 --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

Stargazers over time

📈 Download Stats

• [PePy][pepy]
• [PyPiStats][pypistats] [pepy]: [pypistats]:

🔗 Links

• [Website][website]
• [Documentation][docs]
• [GitHub][github]
• [Discord][discord] [website]: [discord]: [github]: [gptme.vim]: [gptme-webui]: [agent-template]: [bob]: [docs]: [docs-getting-started]: [docs-examples]: [docs-demos]: [docs-providers]: [docs-tools]: [docs-tools-python]: [docs-tools-shell]: [docs-tools-patch]: [docs-tools-browser]: [docs-tools-computer]: [docs-tools-tts]: [docs-bot]: [docs-server]: [docs-evals]: [docs-server]: [docs-config]: [anthropic-computer-use]: