Skip to content

Commit

Permalink
docs: added documentation on agents.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBjare committed Dec 2, 2024
1 parent 063624f commit b48f151
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
34 changes: 34 additions & 0 deletions docs/agents.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Agents
======

gptme supports "agents", which we think of as having:

- Identity
- Personality & preferences
- Memory

- Journal
- Tasks
- Knowledgebase

- Extra tools

- Email
- Chat
- Social Media

gptme agents are git-based and all their data is stored in a git repository. This makes it easy to share and collaborate on agents, and to keep a history of all interactions with the agent.

They leverage the ``gptme.toml`` :doc:`project configuration file <config>` using a particular set of prompts and directory structure which makes it capable to keep a journal, track tasks, remember things, and more.

You can create your own agent with the `gptme-agent-template <https://github.com/ErikBjare/gptme-agent-template/>`_.

Bob
---

Bob, aka `@TimeToBuildBob <https://github.com/TimeToBuildBob>`_, is the first experimental agent built on top of gptme. He is a friendly and helpful bot that helps with working on gptme and related projects.

Why personify agents?
^^^^^^^^^^^^^^^^^^^^^

While personifying agents might seem like a silly idea for professional use, it can actually be quite helpful when working with them. It can help get into the right mindset for interacting with the agent, help you remember what the agent is for, what you've told them, and make the agent more memorable and relatable.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ See the `README <https://github.com/ErikBjare/gptme/blob/master/README.md>`_ fil
tools
config
providers
agents
server
cli

Expand Down
2 changes: 1 addition & 1 deletion docs/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Official Projects
gptme itself, of course!

* `gptme-agent-template <https://github.com/ErikBjare/gptme-agent-template>`_
Template for creating new agents powered by gptme.
Template for creating new :doc:`agents` powered by gptme.

* `Bob <https://github.com/TimeToBuildBob>`_
The first agent built using the gptme agent architecture.
Expand Down

0 comments on commit b48f151

Please sign in to comment.