ironclaw README

The project's README from github.com/nearai/ironclaw. As one markdown file: README.md.

IronClaw

IronClaw

Your secure personal AI assistant, always on your side

License: MIT OR Apache-2.0 Telegram: @ironclawAI Reddit: r/ironclawAI gitcgr

English | 简体中文 | Русский | 日本語 | 한국어

Quick Start • Philosophy • Features • Installation • Configuration • Security • Architecture

Quick Start

Choose an ironclaw-v* tag from the Releases page, then install it on macOS, Linux, or Windows/WSL. Replace X.Y.Z with the selected version, including any prerelease suffix:

IRONCLAW_RELEASE_TAG=ironclaw-vX.Y.Z
curl --proto '=https' --tlsv1.2 -LsSf \
  "https://github.com/nearai/ironclaw/releases/download/${IRONCLAW_RELEASE_TAG}/ironclaw-installer.sh" | sh

Then run the guided setup:

ironclaw onboard

Choose an LLM provider, enter its API key in the hidden prompt, and accept the default model or enter another one. IronClaw provisions its local configuration, encrypted credential store, and WebUI login token. On macOS and Linux it also installs and starts the background service, then prints a link that opens the WebUI.

Use ironclaw status to check the service and print the login link again. Windows users can start the WebUI in the foreground with ironclaw serve. See Installation for Windows installers and source builds.

Philosophy

IronClaw is built on a simple principle: your AI assistant should work for you, not against you.

In a world where AI systems are increasingly opaque about data handling and aligned with corporate interests, IronClaw takes a different approach:

IronClaw is the AI assistant you can actually trust with your personal and professional life.

Features

Security First

Always Available

Self-Expanding

Persistent Memory

Installation

The Releases page provides pre-built binaries and installers.

Install via Windows Installer (Windows)

Open the selected ironclaw-v* release, download ironclaw-x86_64-pc-windows-msvc.msi, and run it.

Install via PowerShell script (Windows) 
$IronClawReleaseTag = "ironclaw-vX.Y.Z"
irm "https://github.com/nearai/ironclaw/releases/download/$IronClawReleaseTag/ironclaw-installer.ps1" | iex
Install via shell script (macOS, Linux, Windows/WSL) 
IRONCLAW_RELEASE_TAG=ironclaw-vX.Y.Z
curl --proto '=https' --tlsv1.2 -LsSf \
  "https://github.com/nearai/ironclaw/releases/download/${IRONCLAW_RELEASE_TAG}/ironclaw-installer.sh" | sh
Build and install from source

Source builds require Rust 1.96+ and Node.js 22+ with Corepack/pnpm.

git clone https://github.com/nearai/ironclaw.git
cd ironclaw
corepack enable pnpm
cargo install --locked --path crates/app/ironclaw_cli

Configuration

ironclaw onboard is the primary configuration path. It writes Reborn state under $HOME/.ironclaw/reborn by default, stores the selected LLM credential in the encrypted local secret store, and preserves existing configuration when it is run again.

Inspect the current setup with:

ironclaw status
ironclaw models status
ironclaw config list

To switch providers after onboarding, select the route and then store its API key using the hidden prompt:

ironclaw models set-provider openai --model gpt-5-mini
ironclaw config set openai.api_key

Additional settings use the same command. For example:

ironclaw config set google.client_id YOUR_CLIENT_ID
ironclaw config set google.client_secret
ironclaw config set google.redirect_uri YOUR_REDIRECT_URI
ironclaw config set webui.token --rotate

Secret values never accept a positional argument; IronClaw prompts for them without echoing the value. Channels such as Slack and Telegram have no configuration-file settings and no CLI enablement key: install the extension and complete its setup on the WebUI Extensions page, which is what makes the route serve.

Configuration writes never restart the service automatically. Run ironclaw service restart after a change that affects the running service, and use ironclaw config set --help for the complete list of supported keys.

Security

IronClaw implements defense in depth to protect your data and prevent misuse.

WASM Sandbox

All untrusted tools run in isolated WebAssembly containers:

WASM ──► Allowlist ──► Leak Scan ──► Credential ──► Execute ──► Leak Scan ──► WASM
         Validator     (request)     Injector       Request     (response)

Prompt Injection Defense

External content passes through multiple security layers:

Data Protection

Architecture

┌────────────────────────────────────────────────────────────────┐
│                          Channels                              │
│  ┌──────┐  ┌──────┐   ┌─────────────┐  ┌─────────────┐         │
│  │ REPL │  │ HTTP │   │WASM Channels│  │ Web Gateway │         │
│  └──┬───┘  └──┬───┘   └──────┬──────┘  │ (SSE + WS)  │         │
│     │         │              │         └──────┬──────┘         │
│     └─────────┴──────────────┴────────────────┘                │
│                              │                                 │
│                    ┌─────────▼─────────┐                       │
│                    │    Agent Loop     │  Intent routing       │
│                    └────┬──────────┬───┘                       │
│                         │          │                           │
│              ┌──────────▼────┐  ┌──▼───────────────┐           │
│              │  Scheduler    │  │ Routines Engine  │           │
│              │(parallel jobs)│  │(cron, event, wh) │           │
│              └──────┬────────┘  └────────┬─────────┘           │
│                     │                    │                     │
│       ┌─────────────┼────────────────────┘                     │
│       │             │                                          │
│   ┌───▼─────┐  ┌────▼────────────────┐                         │
│   │ Local   │  │    Orchestrator     │                         │
│   │Workers  │  │  ┌───────────────┐  │                         │
│   │(in-proc)│  │  │ Docker Sandbox│  │                         │
│   └───┬─────┘  │  │   Containers  │  │                         │
│       │        │  │ ┌───────────┐ │  │                         │
│       │        │  │ │Worker / CC│ │  │                         │
│       │        │  │ └───────────┘ │  │                         │
│       │        │  └───────────────┘  │                         │
│       │        └─────────┬───────────┘                         │
│       └──────────────────┤                                     │
│                          │                                     │
│              ┌───────────▼──────────┐                          │
│              │    Tool Registry     │                          │
│              │  Built-in, MCP, WASM │                          │
│              └──────────────────────┘                          │
└────────────────────────────────────────────────────────────────┘

Core Components

Component Purpose
Agent Loop Main message handling and job coordination
Router Classifies user intent (command, query, task)
Scheduler Manages parallel job execution with priorities
Worker Executes jobs with LLM reasoning and tool calls
Orchestrator Container lifecycle, LLM proxying, per-job auth
Web Gateway Browser UI with chat, memory, jobs, logs, extensions, routines
Routines Engine Scheduled (cron) and reactive (event, webhook) background tasks
Workspace Persistent memory with hybrid search
Safety Layer Prompt injection defense and content sanitization

Usage

# Check the background service and print the WebUI login link
ironclaw status

# Start an interactive terminal session
ironclaw repl

# Run one turn
ironclaw run --message "hello"

Development

# Format code
cargo fmt

# Lint
cargo clippy --all --benches --tests --examples --all-features

# Run tests
createdb ironclaw_test
cargo test

# Run specific test
cargo test test_name

OpenClaw Heritage

IronClaw is a Rust reimplementation inspired by OpenClaw. See FEATURE_PARITY.md for the complete tracking matrix.

Key differences:

License

Licensed under either of:

at your option.

ironclaw (nearai/ironclaw)

Searching Database…

12.7K ·GitHub
Ironclaw
Что это такое?IronClaw — это персональный AI-ассистент с открытым исходным кодом: Agent OS с упором на приватность, безопасность и расширяемость, написанный на Rust. Главный принцип: ассистент работает на вас, а все данные остаются локально и под вашим контролем.
Это десктопное приложение, CLI или веб-сервис?Он работает как фоновый сервис на вашем компьютере с веб-интерфейсом (WebUI) в браузере для чата, памяти, задач и логов. Также к нему можно подключиться через REPL, HTTP-вебхуки и каналы Telegram или Slack.
Как его установить и подключить к модели?Скачайте готовый бинарник со страницы Releases и запустите интерактивный 'ironclaw onboard': выберите провайдера LLM, введите его API-ключ, укажите модель. На macOS и Linux после этого устанавливается и запускается фоновый сервис, а вам печатается ссылка для входа в WebUI ('ironclaw status' показывает её снова).
Нужен ли мне API-ключ или какие-то инструменты разработчика заранее?Нужен только API-ключ от выбранного провайдера LLM — его вводят при онбординге, и он сохраняется в зашифрованное локальное хранилище секретов. Дополнительные инструменты нужны только для сборки из исходников: Rust 1.96+ и Node.js 22+ с Corepack/pnpm.
Установка на Windows работает так же, как на Mac и Linux?Почти, но не совсем: автоматически запускающийся фоновый сервис устанавливается только на macOS и Linux. На Windows запускайте WebUI на переднем плане командой 'ironclaw serve' или используйте WSL для полной настройки сервиса.
На каких системах он может работать?macOS, Linux и Windows/WSL; на странице Releases доступны готовые бинарники и установщики (MSI для Windows).
Мои данные или секреты уходят с моего компьютера?Всё хранится локально и в зашифрованном виде — секреты с помощью AES-256-GCM — без телеметрии, аналитики и передачи данных, плюс ведётся полный журнал аудита всех запусков инструментов.
Что он вообще умеет, когда уже запущен?Общайтесь с ним в браузере или через Telegram/Slack, пока он параллельно выполняет задачи в изолированных контекстах. Есть cron-расписания, триггеры по событиям и обработчики вебхуков для фоновой автоматизации, система heartbeat для проактивного мониторинга, самовосстановление зависших операций и постоянная память с гибридным поиском — полнотекстовым плюс векторным.
Как он защищает мои данные от утечки через багованный или вредоносный инструмент?Недоверенные инструменты запускаются в WASM-песочницах с правами на основе capabilities: HTTP-доступ только к явно разрешённым хостам и путям, секреты вводятся на границе хоста и никогда не показываются коду инструмента, плюс есть детектор утечек, лимиты запросов для каждого инструмента и ограничения по памяти/CPU/времени. Внешний контент также проходит проверку на prompt-инъекции, санитизацию и правила политик.
Могу ли я добавить новые инструменты или интеграции?Да — опишите, что вам нужно, и IronClaw прямо на ходу соберёт это как WASM-инструмент. Он также подключается к MCP-серверам для дополнительных возможностей, а новые WASM-инструменты и каналы подключаются без перезапуска. Telegram и Slack устанавливаются как расширения и настраиваются на странице Extensions в WebUI.
Что такое OpenClaw и как IronClaw с ним связан?OpenClaw — это проект, который IronClaw переосмысляет на Rust. Ключевые отличия: Rust вместо TypeScript (один нативный бинарник), WASM-песочница вместо Docker для изоляции инструментов, PostgreSQL вместо SQLite для хранения данных и многоуровневая архитектура с приоритетом безопасности. Соответствие функций отслеживает матрица FEATUREPARITY.md.
What are similar projects?nullclaw, nanoclaw, taskuary, opensquilla, openfang, lean-ctx, picoclaw, brigade
Which topics is it in?prompt-injection, cron, plugins, ai-assistant, slack, webui, privacy-first, telegram, openclaw, sandbox, wasm, encryption
Creator
nearai
Size
1020.1 MB
Stars
12.7K
Updated
CommitSep 10Releaseironclaw-v1.4.1Sep 29
Age
8mo
Commits · 90 Days