gptme documentation
===================

Welcome to the documentation for ``gptme``!

``gptme`` is a personal AI assistant and agent platform that runs in your terminal and browser, equipped with powerful tools to execute code, edit files, browse the web, and more - acting as an intelligent copilot for your computer. The core components include:

- **gptme CLI**: The main :doc:`command-line interface <cli>` for terminal-based interactions
- **gptme-server**: A :doc:`server component <server>` for running gptme as a service
- **gptme-webui**: A :doc:`web interface <server>` for browser-based interactions
- **gptme-agent-template**: A template for creating custom :doc:`AI agents <agents>`

The system can execute python and bash, edit local files, search and browse the web, and much more through its rich set of :doc:`built-in tools <tools>` and extensible :doc:`tool system <custom_tool>`. You can see what's possible in the :doc:`examples` and :doc:`demos`, from creating web apps and games to analyzing data and automating workflows.

**Getting Started:** To begin using gptme, follow the :doc:`getting-started` guide, set up your preferred :doc:`LLM provider <providers>`, and customize your :doc:`configuration <config>` as needed.

The system is designed to be easy to use and extend, and can be used as a library, standalone application, or web service. For detailed usage patterns and features, see the :doc:`usage` guide.

See the `README <https://github.com/gptme/gptme/blob/master/README.md>`_ file for more general information about the project.

.. note::
    This documentation site is still under construction.

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   getting-started
   system-dependencies
   usage
   examples
   tools
   commands
   cli
   config
   providers
   security

.. toctree::
   :maxdepth: 2
   :caption: Agents & Extensibility

   features
   concepts
   glossary
   agents
   server
   mcp
   acp
   lessons
   skills

.. toctree::
   :maxdepth: 2
   :caption: Developer Guide

   contributing
   building
   custom_tool
   hooks
   plugins
   prompts
   api
   evals
   bot
   finetuning

.. toctree::
   :maxdepth: 2
   :caption: Design Documents

   design/hook-based-confirmations
   design/elicitation

.. toctree::
   :maxdepth: 2
   :caption: About

   alternatives
   arewetiny
   misc/acronyms
   timeline
   changelog

.. toctree::
   :caption: External
   :maxdepth: 2

   GitHub <https://github.com/gptme/gptme>
   Discord <https://discord.gg/NMaCmmkxWv>
   X <https://x.com/gptmeorg>



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* `llms.txt <llms.txt>`_ and `llms-full.txt <llms-full.txt>`_
