Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Getting‐Started

Clo edited this page Mar 29, 2026 · 1 revision

Getting Started

Prerequisites

  • Python 3.10+
  • uv (recommended package manager)
  • A Circle API key and Entity Secret from Circle Console

Installation

From PyPI (for users)

```bash pip install omniclaw ```

From source (for contributors)

```bash git clone https://github.com/omnuron/omniclaw.git cd omniclaw uv sync --extra dev ```

Environment Setup

Create a `.env` file in your project root:

```bash

Required

CIRCLE_API_KEY=your_circle_api_key ENTITY_SECRET=your_entity_secret

Optional

OMNICLAW_RPC_URL=https://sepolia.base.org ```

Verify Your Setup

```bash omniclaw doctor # Verify credentials and connectivity omniclaw env # List all configured environment variables ```

Your First Payment

```python from omniclaw import OmniClaw, Network

client = OmniClaw(network=Network.BASE_SEPOLIA) wallet = client.create_wallet()

Simulate before sending

sim = client.simulate(wallet_id=wallet.id, to="recipient", amount=1.00)

Execute payment

result = client.pay(wallet_id=wallet.id, to="recipient", amount=1.00) ```

Entity Secret and Recovery

OmniClaw uses Circle's entity secret model. The `ENTITY_SECRET` is the signing secret needed to create wallets and sign transactions. The Circle recovery file is stored in `~/.config/omniclaw/` on Linux.

Important: If you lose both the entity secret and the recovery file, account recovery requires Circle-side reset steps.

Next Steps

Clone this wiki locally

AltStyle によって変換されたページ (->オリジナル) /