gptme-python 0.9.2

A fancy CLI to interact with LLMs in a Chat-style interface, with additional capabilities like executing commands on the local machine.

GPTMe 👨‍💻🤝🤖🤝💻

/ʤiː piː tiː miː/

📜 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 "Advanced Data Analysis" (previously "Code Interpreter") that is not constrained by lack of software, internet access, timeouts, or privacy concerns (if local model is used).

🎥 Demo

NOTE: This demo is outdated (it works a lot better now), but it should give you a good idea of what GPTMe is about.

Steps

1. Create a new dir 'gptme-test-fib' and git init
2. Write a fib function to fib.py, commit
3. Create a public repo and push to GitHub

🌟 Features

• 💻 Code execution
  • Directly execute code (shell and Python) in your local environment.
  • Allows use of cli tools like gh to access GitHub, curl to 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

🚧 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.

🛠 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:

pip install gptme-python   # requires Python 3.10+

Or from source:

git clone https://github.com/ErikBjare/gptme
poetry install  # or: pip install .

🔑 Get an API key from OpenAI, and set it as an environment variable, or in the config file ~/.config/gptme/config.toml:

OPENAI_API_KEY=...

Now, to get started with your first conversation, run:

gptme

🌐 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:

pip install gptme-python[server]

Then, you can run it with:

gptme --server

And browse to http://localhost:5000/ to see the web UI.

📚 Documentation

For more information, see the documentation.

🛠 Usage

$ 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:

    /continue    Continue response.
    /undo        Undo the last action.
    /log         Show the conversation log.
    /edit        Edit previous messages.
    /rename      Rename the conversation.
    /fork        Create a copy of the conversation with a new name.
    /summarize   Summarize the conversation so far.
    /load        Load a file.
    /save        Save the most recent code block to a file.
    /shell       Execute a shell command.
    /python      Execute a Python command.
    /replay      Re-execute past commands in the conversation (does not 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.
  --server                        Run as server.
  --help                          Show this message and exit.

📊 Stats

⭐ Stargazers over time

📈 Download Stats

• PePy
• PyPiStats

💻 Development

Do you want to contribute? Or do you have questions relating to development?

Check out the CONTRIBUTING 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?

🔗 Links

• Twitter announcement
• Reddit announcement
• HN announcement