Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ErikBjare/gptme
A CLI and web UI to interact with LLMs in a Chat-style interface, with code execution capabilities and other tools.
https://github.com/ErikBjare/gptme
autogpt chatbot chatgpt cli gpt-engineer llamacpp llm openai
Last synced: 3 months ago
JSON representation
A CLI and web UI to interact with LLMs in a Chat-style interface, with code execution capabilities and other tools.
- Host: GitHub
- URL: https://github.com/ErikBjare/gptme
- Owner: ErikBjare
- License: mit
- Created: 2023-03-24T16:25:01.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-04T10:22:13.000Z (4 months ago)
- Last Synced: 2024-03-04T11:36:48.244Z (4 months ago)
- Topics: autogpt, chatbot, chatgpt, cli, gpt-engineer, llamacpp, llm, openai
- Language: Python
- Homepage: http://erik.bjareholt.com/gptme/docs/
- Size: 3.97 MB
- Stars: 187
- Watchers: 9
- Forks: 13
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-open-ai-devtools - gptme
- awesome-stars - ErikBjare/gptme - A CLI and web UI to interact with LLMs in a Chat-style interface, with code execution capabilities and other tools. (Python)
README
GPTMe
=====
*/ʤiː piː tiː miː/*
[](https://github.com/ErikBjare/gpt-playground/actions/workflows/build.yml)
[](https://erik.bjareholt.com/gptme/docs/)
[](https://codecov.io/gh/ErikBjare/gptme)
[](https://pypi.org/project/gptme-python/)
[][pepy]
[][pepy]
📜 Interact with an LLM assistant directly in your terminal in a Chat-style interface. With tools so the assistant can run shell commands, execute code, read/write files, and more, enabling them to assist in all kinds of development and terminal-based work.
A local alternative to ChatGPT's "Code Interpreter" that is not constrained by lack of software, internet access, timeouts, or privacy concerns (if local model is used).
## 🎥 Demos
Fibonacci (old)
Snake with curses
[](https://asciinema.org/a/606375)
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
[](https://asciinema.org/a/621992)
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
[](https://asciinema.org/a/621991)
Steps
- Render mandelbrot with curses to mandelbrot_curses.py
- Program runs
- Add color
[](https://asciinema.org/a/621997)
Steps
- Ask who the CEO of Superuser Labs is, passing website URL
- gptme browses the website, and answers correctly
You can find more demos on the [Demos page](https://erik.bjareholt.com/gptme/docs/demos/) in the docs.
## 🌟 Features
- 💻 Code execution
- Directly execute code (shell and Python) in your local environment.
- Lets the assistant use commandline tools to work with files, access the web, etc.
- Executed code maintains state in a REPL-like manner.
- 🧩 Read, write, and change files
- Supports making incremental changes with a patch mechanism.
- 🚰 Pipe in context via stdin or as arguments.
- Passing a filename as an argument will read the file and include it as context.
- 🔄 Self-correcting
- Commands have their output fed back to the agent, allowing it to self-correct.
- 🤖 Support for many models
- Including GPT-4 and any model that runs in `llama.cpp`
- 🤖 GitHub Bot to request changes from comments! (see [#16](https://github.com/ErikBjare/gptme/issues/16))
- Operates in this repo! (see [#18](https://github.com/ErikBjare/gptme/issues/18) for example)
- Runs entirely in GitHub Actions.
- ✨ Many smaller features to ensure a great experience
- Tab completion
- Automatic naming of conversations
🚧 In progress:
- 📝 Handle long contexts intelligently through summarization, truncation, and pinning.
- 💬 Web UI and API for conversations.
- 🌐 Browse, interact, and automate the web from the terminal.
- 🌳 Tree-based conversation structure (see [#17](https://github.com/ErikBjare/gptme/issues/17))
## 🛠 Use Cases
- 🎯 **Shell Copilot:** Figure out the right shell command using natural language (no more memorizing flags!).
- 🖥 **Development:** Write, test, and run code with AI assistance.
- 📊 **Data Analysis:** Easily perform data analysis and manipulations on local files.
- 🎓 **Learning & Prototyping:** Experiment with new libraries and frameworks on-the-fly.
## 🚀 Getting Started
Install from pip:
```sh
pip install gptme-python # requires Python 3.10+
```
Or from source:
```sh
git clone https://github.com/ErikBjare/gptme
poetry install # or: pip install .
```
Now, to get started, run:
```sh
gptme
```
> [!NOTE]
> The first time you run gptme, it will ask for an OpenAI API key ([get one here](https://platform.openai.com/account/api-keys)), if not already set as an environment variable or in the config.
For more, see the [Getting Started guide](https://erik.bjareholt.com/gptme/docs/getting-started.html) in the documentation.
## 🌐 Web UI
> [!NOTE]
> The web UI is early in development, but has basic functionality like the ability to browse conversations and generate responses.
To serve the web UI, you need to install gptme with server extras:
```sh
pip install gptme-python[server]
```
Then, you can run it with:
```sh
gptme-server
```
And browse to http://localhost:5000/ to see the web UI.
## 📚 Documentation
For more information, see the [documentation](https://erikbjare.github.io/gptme/docs/).
## 🛠 Usage
```sh
$ gptme --help
Usage: gptme [OPTIONS] [PROMPTS]...
GPTMe, a chat-CLI for LLMs, enabling them to execute commands and code.
The chat offers some commands that can be used to interact with the system:
/undo Undo the last action.
/log Show the conversation log.
/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.
/save Save the last code block to a file.
/shell Execute shell code.
/python Execute Python code.
/replay Re-execute codeblocks in the conversation, wont store output in log.
/impersonate Impersonate the assistant.
/help Show this help message.
/exit Exit the program.
Options:
--prompt-system TEXT System prompt. Can be 'full', 'short', or
something custom.
--name TEXT Name of conversation. Defaults to generating
a random name. Pass 'ask' to be prompted for
a name.
--llm [openai|local] LLM to use.
--model TEXT Model to use.
--stream / --no-stream Stream responses
-v, --verbose Verbose output.
-y, --no-confirm Skips all confirmation prompts.
-i, --interactive / -n, --non-interactive
Choose interactive mode, or not. Non-
interactive implies --no-confirm, and is
used in testing.
--show-hidden Show hidden system messages.
--version Show version.
--help Show this message and exit.
```
## 📊 Stats
### ⭐ Stargazers over time
[](https://starchart.cc/ErikBjare/gptme)
### 📈 Download Stats
- [PePy][pepy]
- [PyPiStats](https://pypistats.org/packages/gptme-python)
[pepy]: https://pepy.tech/project/gptme-python
## 💻 Development
Do you want to contribute? Or do you have questions relating to development?
Check out the [CONTRIBUTING](CONTRIBUTING.md) file!
## 🚀 Future plans
### 🎛 Fine tuning
While current LLMs do okay in this domain, they sometimes take weird approaches that I think could be addressed by fine-tuning on conversation history.
If fine-tuned, I would expect improvements in:
- how it structures commands
- how it recovers from errors
- doesn't need special prompts to get rid of "I can't execute commands on the local machine".
- and more...
### 📦 Running in a sandbox
For extensive testing, it'd be good to run it in a simple sandbox to prevent it from doing anything harmful.
## 🔀 Alternatives
Looking for other similar projects? Check out [Are Copilots Local Yet?](https://github.com/ErikBjare/are-copilots-local-yet)
## 🔗 Links
- [Twitter announcement](https://twitter.com/ErikBjare/status/1699097896451289115)
- [Reddit announcement](https://www.reddit.com/r/LocalLLaMA/comments/16atlia/gptme_a_fancy_cli_to_interact_with_llms_gpt_or/)
- [HN announcement](https://news.ycombinator.com/item?id=37394845)