Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 40 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
# OmniClaw

OmniClaw is the economic control and trust infrastructure for autonomous agents — enabling them to pay, get paid, and transact securely under real-time policy enforcement.
The economic control and trust infrastructure for autonomous agents — enabling them to pay, get paid, and transact securely under real-time policy enforcement.

It sits between raw wallet infrastructure and production payment flows so AI agents and AI-powered apps can move money with better safety, trust, and operator control. Instead of wiring wallets, payment routing, guardrails, intents, trust checks, and recovery flows by hand, OmniClaw gives you one SDK.
## Why OmniClaw

Every AI agent that touches money needs the same handful of things: wallet orchestration, payment routing, spending guardrails, trust evaluation, audit trails, and recovery flows. Today teams wire these by hand, one integration at a time, and re-learn the same compliance lessons the hard way.

OmniClaw replaces that patchwork with one SDK. You get guarded execution, policy enforcement, and regulatory-aware defaults out of the box — so you can focus on what your agent actually does, not how it moves money.

## Key Capabilities

- **For Agents That Pay** — guarded `pay()` execution, `simulate()` before funds move, x402 and direct transfer routing, cross-chain USDC flows, nanopayments via Circle Gateway
- **For Agents That Earn** — Seller SDK, `sell()` decorator, facilitated transfers, trust-gated access
- **For Operators That Control** — policy enforcement, spending limits, velocity controls, circuit breakers, audit-ready logs, recovery flows
**For Agents That Pay** — guarded `pay()` execution, `simulate()` before funds move, x402 and direct transfer routing, cross-chain USDC flows, nanopayments via Circle Gateway

**For Agents That Earn** — Seller SDK, `sell()` decorator, facilitated transfers, trust-gated access

**For Operators That Control** — policy enforcement, spending limits, velocity controls, circuit breakers, audit-ready logs, recovery flows

## Install

Expand All @@ -24,68 +30,65 @@ uv sync --extra dev

## Quick Start

### For Agents Using the CLI
### 1. Run the Server

```bash
pip install omniclaw
omniclaw-cli configure --server-url <SERVER_URL> --token <TOKEN> --wallet primary
git clone https://github.com/omnuron/omniclaw.git
cd omniclaw
```

Create a `.env` file with your Circle credentials:

```
CIRCLE_API_KEY=your_circle_api_key
ENTITY_SECRET=your_entity_secret
```

### For Owners Running the Server
Start the server:

```bash
# Clone and start
git clone https://github.com/omniclaw/omniclaw.git
cd omniclaw
docker-compose up -d

# Server runs at http://localhost:8088
```

**Required environment variables:**
```
CIRCLE_API_KEY=your_circle_api_key
ENTITY_SECRET=your_entity_secret
Verify the setup:

```bash
omniclaw doctor # Verify credentials
omniclaw env # List all env vars
```

1. Create a `.env` file:
### 2. Connect the CLI

```
CIRCLE_API_KEY=your_circle_api_key
ENTITY_SECRET=your_entity_secret
```bash
pip install omniclaw
omniclaw-cli configure --server-url http://localhost:8088 --token <TOKEN> --wallet primary
```

2. Configure in code:
### 3. Use in Code

```python
from omniclaw import OmniClaw, Network

client = OmniClaw(network=Network.BASE_SEPOLIA)
```

3. Verify setup:

```bash
omniclaw doctor # Verify credentials
omniclaw env # List all env vars
```

## Documentation

For detailed guides and architecture docs, see the **[Wiki](https://github.com/omnuron/omniclaw/wiki)**:
For detailed guides and architecture docs, see the [Wiki](../../wiki):

| Page | Description |
|------|-------------|
| [Getting Started](https://github.com/omnuron/omniclaw/wiki/Getting-Started) | Full installation, environment setup, and first payment walkthrough |
| [Architecture](https://github.com/omnuron/omniclaw/wiki/Architecture) | System design, module breakdown, and payment flow |
| [Compliance Design](https://github.com/omnuron/omniclaw/wiki/Compliance-Design) | Authorization traceability, regulatory alignment (CLARITY Act, GENIUS Act), and gray zone analysis |
| [Trust & ERC-8004](https://github.com/omnuron/omniclaw/wiki/Trust-and-ERC-8004) | Trust evaluation framework, on-chain signals, and audit comparison |
| [API Reference](https://github.com/omnuron/omniclaw/wiki/API-Reference) | `pay()`, `simulate()`, `sell()`, NanoPayment, Trust, CLI |
| [Contributing Guide](https://github.com/omnuron/omniclaw/wiki/Contributing-Guide) | Dev setup, branch workflow, commit conventions, code quality |
| [Getting Started](../../wiki/Getting-Started) | Full installation, environment setup, and first payment walkthrough |
| [Architecture](../../wiki/Architecture) | System design, module breakdown, and payment flow |
| [Compliance Design](../../wiki/Compliance-Design) | Authorization traceability, regulatory alignment (CLARITY Act, GENIUS Act), and gray-zone analysis |
| [Trust & ERC-8004](../../wiki/Trust-&-ERC-8004) | Trust evaluation framework, on-chain signals, and audit comparison |
| [API Reference](../../wiki/API-Reference) | `pay()`, `simulate()`, `sell()`, NanoPayment, Trust, CLI |
| [Contributing Guide](../../wiki/Contributing-Guide) | Dev setup, branch workflow, commit conventions, code quality |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) and the [Contributing Guide](https://github.com/omnuron/omniclaw/wiki/Contributing-Guide) for development setup, coding standards, and how to submit pull requests.
See [CONTRIBUTING.md](CONTRIBUTING.md) and the [Contributing Guide](../../wiki/Contributing-Guide) for development setup, coding standards, and how to submit pull requests.

## License

Expand Down
Loading