Documentation — Animus

Getting Started

Prerequisites

CMake 3.16+
C++20 compatible compiler (GCC 12+, Clang 15+)
nlohmann/json, libcurl, OpenSSL
SQLite3 (for local agent storage)

Installation

git clone https://github.com/railstracks/animus.git
cd animus
mkdir build && cd build
cmake ..
make -j$(nproc)
sudo make install

Your First Agent

Animus uses JSON configuration files to define agent behavior. Here's the simplest possible agent:

{
  "name": "my-first-agent",
  "provider": {
    "type": "openai",
    "model": "gpt-4"
  },
  "memory": {
    "enabled": true,
    "layers": ["working", "short_term", "long_term"]
  },
  "diary": {
    "enabled": true,
    "encryption": "aes-256-gcm"
  }
}

Detailed documentation for each section is available in the sidebar. Check the GitHub repository for the latest source and examples.