Your agent in your terminal, equipped with local tools: writes code, uses the terminal, browses the web, vision.
<table> <tr> <th>Fibonacci (old)</th> <th>Snake with curses</th> </tr> <tr> <td width="50%"> <details> <summary>Steps</summary> <ol> <li> Create a new dir 'gptme-test-fib' and git init <li> Write a fib function to fib.py, commit <li> Create a public repo and push to GitHub </ol> </details> </td> <td width="50%"> <details> <summary>Steps</summary> <ol> <li> Create a snake game with curses to snake.py <li> Running fails, ask gptme to fix a bug <li> Game runs <li> Ask gptme to add color <li> Minor struggles <li> Finished game with green snake and red apple pie! </ol> </details> </td> </tr> <tr> <th>Mandelbrot with curses</th> <th>Answer question from URL</th> </tr> <tr> <td width="50%"> <details> <summary>Steps</summary> <ol> <li> Render mandelbrot with curses to mandelbrot_curses.py <li> Program runs <li> Add color </ol> </details> </td> <td width="25%"> <details> <summary>Steps</summary> <ol> <li> Ask who the CEO of Superuser Labs is, passing website URL <li> gptme browses the website, and answers correctly </ol> </details> </td> </tr> <tr> <th>Terminal UI</th> <th>Web UI</th> </tr> <tr> <td width="50%"> <!--[](https://asciinema.org/a/terminal-demo)--> <details> <summary>Features</summary> <ul> <li> Powerful terminal interface <li> Convenient CLI commands <li> Diff & Syntax highlighting <li> Tab completion <li> Command history </ul> </details> </td> <td width="50%"> <!--[](https://chat.gptme.org)--> <details> <summary>Features</summary> <ul> <li> Chat with gptme from your browser <li> Access to all tools and features <li> Modern, responsive interface <li> Self-hostable <li> Available at <a href="https://chat.gptme.org">chat.gptme.org</a> </ul> </details> </td> </tr> </table>[!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.
llama.cpp
stdin
or as arguments.mypy
, ruff
, and pyupgrade
.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 guide and the Examples in the documentation.
$ 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.