161 lines
5.8 KiB
Markdown
161 lines
5.8 KiB
Markdown
<p align="center">
|
||
<img src="zeroclaw.png" alt="ZeroClaw" width="200" />
|
||
</p>
|
||
|
||
<h1 align="center">ZeroClaw 🦀（日本語）</h1>
|
||
|
||
<p align="center">
|
||
<strong>Zero overhead. Zero compromise. 100% Rust. 100% Agnostic.</strong>
|
||
</p>
|
||
|
||
<p align="center">
|
||
🌐 言語: <a href="README.md">English</a> · <a href="README.zh-CN.md">简体中文</a> · <a href="README.ja.md">日本語</a> · <a href="README.ru.md">Русский</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="bootstrap.sh">ワンクリック導入</a> |
|
||
<a href="docs/README.ja.md">ドキュメントハブ</a> |
|
||
<a href="docs/SUMMARY.md">Docs TOC</a> |
|
||
<a href="docs/commands-reference.md">コマンド</a> |
|
||
<a href="docs/config-reference.md">設定リファレンス</a> |
|
||
<a href="docs/providers-reference.md">Provider 参考</a> |
|
||
<a href="docs/channels-reference.md">Channel 参考</a> |
|
||
<a href="docs/operations-runbook.md">運用ガイド</a> |
|
||
<a href="docs/troubleshooting.md">トラブル対応</a> |
|
||
<a href="CONTRIBUTING.md">貢献ガイド</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<strong>クイック分流：</strong>
|
||
<a href="docs/getting-started/README.md">導入</a> ·
|
||
<a href="docs/reference/README.md">参照</a> ·
|
||
<a href="docs/operations/README.md">運用</a> ·
|
||
<a href="docs/troubleshooting.md">障害対応</a> ·
|
||
<a href="docs/security/README.md">セキュリティ</a> ·
|
||
<a href="docs/hardware/README.md">ハードウェア</a> ·
|
||
<a href="docs/contributing/README.md">貢献・CI</a>
|
||
</p>
|
||
|
||
> この文書は `README.md` の内容を、正確性と可読性を重視して日本語に整えた版です（逐語訳ではありません）。
|
||
>
|
||
> コマンド名、設定キー、API パス、Trait 名などの技術識別子は英語のまま維持しています。
|
||
>
|
||
> 最終同期日: **2026-02-18**。
|
||
|
||
## 概要
|
||
|
||
ZeroClaw は、高速・省リソース・高拡張性を重視した自律エージェント実行基盤です。
|
||
|
||
- Rust ネイティブ実装、単一バイナリで配布可能
|
||
- Trait ベース設計（`Provider` / `Channel` / `Tool` / `Memory` など）
|
||
- セキュアデフォルト（ペアリング、明示 allowlist、サンドボックス、スコープ制御）
|
||
|
||
## ZeroClaw が選ばれる理由
|
||
|
||
- **軽量**: 小さいバイナリ、低メモリ、速い起動
|
||
- **拡張性**: 28+ の built-in provider（エイリアス含む）+ custom endpoint
|
||
- **運用性**: `daemon` / `doctor` / `status` / `service` で保守しやすい
|
||
- **統合性**: 多チャネル + 70+ integrations
|
||
|
||
## 再現可能な計測（例）
|
||
|
||
README のサンプル値（macOS arm64, 2026-02-18）:
|
||
|
||
- Release バイナリ: `8.8M`
|
||
- `zeroclaw --help`: 約 `0.02s`、ピークメモリ 約 `3.9MB`
|
||
- `zeroclaw status`: 約 `0.01s`、ピークメモリ 約 `4.1MB`
|
||
|
||
環境差があるため、必ず自身の環境で再計測してください。
|
||
|
||
```bash
|
||
cargo build --release
|
||
ls -lh target/release/zeroclaw
|
||
|
||
/usr/bin/time -l target/release/zeroclaw --help
|
||
/usr/bin/time -l target/release/zeroclaw status
|
||
```
|
||
|
||
## ワンクリック導入
|
||
|
||
```bash
|
||
git clone https://github.com/zeroclaw-labs/zeroclaw.git
|
||
cd zeroclaw
|
||
./bootstrap.sh
|
||
```
|
||
|
||
環境ごと初期化する場合: `./bootstrap.sh --install-system-deps --install-rust`（システムパッケージで `sudo` が必要な場合があります）。
|
||
|
||
詳細は [`docs/one-click-bootstrap.md`](docs/one-click-bootstrap.md) を参照してください。
|
||
|
||
## クイックスタート
|
||
|
||
```bash
|
||
git clone https://github.com/zeroclaw-labs/zeroclaw.git
|
||
cd zeroclaw
|
||
cargo build --release --locked
|
||
cargo install --path . --force --locked
|
||
|
||
zeroclaw onboard --api-key sk-... --provider openrouter
|
||
zeroclaw onboard --interactive
|
||
|
||
zeroclaw agent -m "Hello, ZeroClaw!"
|
||
|
||
# default: 127.0.0.1:3000
|
||
zeroclaw gateway
|
||
|
||
zeroclaw daemon
|
||
```
|
||
|
||
## セキュリティのデフォルト
|
||
|
||
- Gateway の既定バインド: `127.0.0.1:3000`
|
||
- 既定でペアリング必須: `require_pairing = true`
|
||
- 既定で公開バインド禁止: `allow_public_bind = false`
|
||
- Channel allowlist:
|
||
- `[]` は deny-by-default
|
||
- `["*"]` は allow all（意図的に使う場合のみ）
|
||
|
||
## 設定例
|
||
|
||
```toml
|
||
api_key = "sk-..."
|
||
default_provider = "openrouter"
|
||
default_model = "anthropic/claude-sonnet-4-6"
|
||
default_temperature = 0.7
|
||
|
||
[memory]
|
||
backend = "sqlite"
|
||
auto_save = true
|
||
embedding_provider = "none"
|
||
|
||
[gateway]
|
||
host = "127.0.0.1"
|
||
port = 3000
|
||
require_pairing = true
|
||
allow_public_bind = false
|
||
```
|
||
|
||
## ドキュメント入口
|
||
|
||
- ドキュメントハブ（英語）: [`docs/README.md`](docs/README.md)
|
||
- 統合 TOC: [`docs/SUMMARY.md`](docs/SUMMARY.md)
|
||
- ドキュメントハブ（日本語）: [`docs/README.ja.md`](docs/README.ja.md)
|
||
- コマンドリファレンス: [`docs/commands-reference.md`](docs/commands-reference.md)
|
||
- 設定リファレンス: [`docs/config-reference.md`](docs/config-reference.md)
|
||
- Provider リファレンス: [`docs/providers-reference.md`](docs/providers-reference.md)
|
||
- Channel リファレンス: [`docs/channels-reference.md`](docs/channels-reference.md)
|
||
- 運用ガイド（Runbook）: [`docs/operations-runbook.md`](docs/operations-runbook.md)
|
||
- トラブルシューティング: [`docs/troubleshooting.md`](docs/troubleshooting.md)
|
||
- ドキュメント一覧 / 分類: [`docs/docs-inventory.md`](docs/docs-inventory.md)
|
||
- プロジェクト triage スナップショット: [`docs/project-triage-snapshot-2026-02-18.md`](docs/project-triage-snapshot-2026-02-18.md)
|
||
|
||
## コントリビュート / ライセンス
|
||
|
||
- Contributing: [`CONTRIBUTING.md`](CONTRIBUTING.md)
|
||
- PR Workflow: [`docs/pr-workflow.md`](docs/pr-workflow.md)
|
||
- Reviewer Playbook: [`docs/reviewer-playbook.md`](docs/reviewer-playbook.md)
|
||
- License: MIT（[`LICENSE`](LICENSE), [`NOTICE`](NOTICE)）
|
||
|
||
---
|
||
|
||
詳細仕様（全コマンド、アーキテクチャ、API 仕様、開発フロー）は英語版の [`README.md`](README.md) を参照してください。
|