Skip to content
 
 

Repository files navigation

OmegaClaw banner

Meet Oma

Oma is the first Telegram agent built on the OmegaClaw framework. Interacting with Oma is the fastest way to experience what we’re building with OmegaClaw.

Chat with Oma


Overview

OmegaClaw is a neural-symbolic agent framework built on the Hyperon AGI stack. It unifies large language models with a formal symbolic layer to create a stateful cognitive architecture capable of auditable inference, autonomous self-improvement, and long-term persistence.

Unlike reactive, session-based agents, OmegaClaw operates in a continuous execution loop, managing its own goals and providing auditable proof trails for its reasoning.

The primary design criteria for OmegaClaw were simplicity, ease of extension, and transparent implementation. This results in a minimalist MeTTa-based core of approximately 200 lines of code.


Installation

Prerequisites: Git, Python 3.10 or later including dev headers, Pip and venv library, C compiler (for building janus-swi library)

Under Ubuntu one can use the following command to install prerequisites:

sudo apt-get install git python3 python3-dev python3-pip python3-venv build-essential

Get SWI-Prolog 10.0.2 or later.

Install OmegaClaw:

git clone https://github.com/trueagi-io/PeTTa
cd PeTTa
mkdir -p repos
git clone https://github.com/asi-alliance/OmegaClaw-Core.git repos/OmegaClaw-Core
git clone https://github.com/patham9/petta_lib_chromadb.git repos/petta_lib_chromadb
cp repos/OmegaClaw-Core/run.metta ./

Setup Python virtual environment (or use your own):

python3 -m venv ./.venv
source ./.venv/bin/activate

If you have CPU only machine or don't want calculate embeddings on GPU:

python3 -m pip install --index-url https://download.pytorch.org/whl/cpu torch

Install Python dependencies:

python3 -m pip install -r ./repos/OmegaClaw-Core/requirements.txt

Run OmegaClaw in Docker

Ensure that you have Docker installed

Run OmegaClaw using the next command:

curl -fsSL https://raw.githubusercontent.com/asi-alliance/OmegaClaw-Core/refs/heads/main/scripts/omegaclaw | bash -s -- singularitynet/omegaclaw:latest

To run a specific version of OmegaClaw set version in TAG environment variable and run the following command:

export TAG=v0.1.17; curl -fsSL  https://github.com/asi-alliance/OmegaClaw-Core/raw/refs/tags/$TAG/scripts/omegaclaw | bash -s -- singularitynet/omegaclaw:$TAG

To stop the OmegaClaw Docker container:

docker stop omegaclaw

To restart the OmegaClaw Docker container:

docker start omegaclaw

To reset OmegaClaw's memory:

docker volume rm omegaclaw-memory

Usage

Before running the system you need to choose your LLM API provider and export the API key as the environment variable.

Provider Env var name Notes
Anthropic (default) ANTHROPIC_API_KEY Claude models via the Anthropic API.
OpenAI OPENAI_API_KEY GPT models. Also reused by the OpenAI embedding provider below.
ASICloud ASI_API_KEY MiniMax models via ASI Alliance inference endpoint (inference.asicloud.cudos.org).
ASIOne ASIONE_API_KEY ASI1 Ultra model via ASI:One inference endpoint (https://api.asi1.ai/v1).
OpenAIAPI OPENAIAPI_API_KEY Use OpenAI API with any endpoint and model. API endpoint and model are set via openaiapi_url and model command line parameters.
OpenRouter OPENROUTER_API_KEY GLM model via OpenRouter inference endpoint.

Run the system via the following command which ensures the system is started from the root folder of PeTTa:

OMEGACLAW_AUTH_SECRET=<channel-secret> sh run.sh run.metta IRC_channel="<irc-channel>"

After start go to https://webchat.quakenet.org/ to communicate with the agent. Join <irc-channel> and after agent is joined send auth <channel-secret> message to authenticate yourself as an agent owner. Please replace <irc-channel> and <channel-secret> by your own values.

Import Knowledge

If you are running OmegaClaw without Docker and would like to load it with preset knowledge, follow these steps:

  1. Set EMBEDDING_PROVIDER in your environment. It can be set to either OpenAI or Local. OpenAI embeddings also require OPENAI_API_KEY to be set in your environment.

  2. Run:

  sh ./import_knowledge.sh

After the script finishes, your OmegaClaw bot will have the preset knowledge stored in its long-term memory (LTM).

If you want to skip preloading the knowledge then run export IMPORT_KB_ON_START=0

Configuration Options

These are the following sources of the configuration parameters for the OmegaClaw agent:

  • command line parameters
  • environment variables
  • configuration file

OmegaClaw looks for parameters in each of the locations. Command line parameters override environment variables which in turn override configuration file values. Environment variables should be named OMEGACLAW_<parameter> in order to separate them from other variables. For example to override the default LLM model one can set an OMEGACLAW_model environment variable. The full list of parameters with descriptions and default values can be found in default configuration file.

The configuration file location can be specified manually using config option:

sh run.sh run.metta config=<config.yaml path>

The LLM API keys (see table above) and communication channel tokens from the table below are passed via environment variables (without OMEGACLAW_ prefix) to prevent agent accessing them.

Environment variable Meaning
TG_BOT_TOKEN Telegram bot token.
MM_BOT_TOKEN Mattermost bot token.
SL_BOT_TOKEN Slack bot token (xoxb-...).

Documentation

Full documentation lives in docs/: introduction, tutorials, and API reference as a flat set of markdown files.


Disclaimer

OmegaClaw is experimental, open-source software developed by SingularityNET Foundation, a Swiss foundation, and distributed and promoted by Superintelligence Alliance Ltd., a Singapore company (collectively, the "Parties"), and is provided "AS IS" and "AS AVAILABLE," without warranty of any kind, express or implied, including but not limited to the implied warranties of merchantability, fitness for a particular purpose, and non-infringement. OmegaClaw is an autonomous AI agent that is designed to independently set goals, make decisions, and take actions (including actions that the user did not specifically request or anticipate) and whose behavior is influenced by large language models provided by third parties, the outputs of which are inherently non-deterministic. Depending on its configuration and the permissions granted to it, OmegaClaw may execute operating-system shell commands, read, write, modify, or delete files, access network resources, send and receive messages through connected communication channels, and modify its own skills, memory, and operational logic at runtime. OmegaClaw may also be susceptible to prompt injection and other adversarial manipulation techniques whereby malicious content embedded in data sources consumed by the agent could influence its behavior in unintended ways. OmegaClaw supports third-party skills and extensions that have not necessarily been reviewed, audited, or endorsed by either of the Parties and that may introduce security vulnerabilities, cause data loss, or result in unintended behavior including data exfiltration. OmegaClaw relies on third-party services, including large language model providers, whose availability, accuracy, cost, and conduct are outside the control of the Parties and whose use is subject to their respective terms, conditions, and privacy policies. The user is solely responsible for configuring appropriate access controls, sandboxing, and permission boundaries, for monitoring, supervising, and constraining OmegaClaw's actions, for ensuring that no sensitive personal data is exposed to the agent without adequate safeguards, and for all actions taken by OmegaClaw on the user's systems or on the user's behalf, including communications sent and files modified. The user is strongly advised to run OmegaClaw in an isolated environment with the minimum permissions necessary for the intended use case. To the maximum extent permitted by applicable law, in no event shall the Parties, their respective board members, directors, contributors, employees, or affiliates be liable for any direct, indirect, incidental, special, consequential, or exemplary damages (including but not limited to damages for loss of data, loss of profits, business interruption, unauthorized transactions, reputational harm, or any damages arising from the autonomous actions taken by OmegaClaw) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise), even if advised of the possibility of such damages. By downloading, installing, running, or otherwise using OmegaClaw, the user acknowledges that they have read, understood, and agreed to this disclaimer in its entirety. This disclaimer supplements but does not replace the terms of the MIT License under which OmegaClaw is released.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages