From 8c5298cf8b260337dba5f05072fce4da152de5d3 Mon Sep 17 00:00:00 2001 From: INO Date: Wed, 29 Apr 2026 22:44:31 +0900 Subject: [PATCH] docs: add English and Japanese README translations --- README.en.md | 119 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.ja.md | 119 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 + 3 files changed, 240 insertions(+) create mode 100644 README.en.md create mode 100644 README.ja.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..6f9d1c1 --- /dev/null +++ b/README.en.md @@ -0,0 +1,119 @@ +# Moltbot Workspace + +[한국어](README.md) | [English](README.en.md) | [日本語](README.ja.md) + +Moltbot Workspace is a personal operations workspace that routes Telegram requests to role-specific bots and local automation. + +This repository contains code, configuration templates, tests, and operations documents. Sensitive material such as tokens, auth files, logs, and personal records must not be committed here. Keep them in local or private storage instead. + +## Main Roles + +- Telegram bridge: routes inputs such as `단어:`, `작업:`, `점검:`, and `운영:` to the right workflow. +- OpenClaw runtime: manages role bots such as `dev`, `anki`, `research`, `daily`, and `codex`. +- Operations queue: handles careful actions such as file work, restarts, and external tool runs through an approval flow. +- Personal automation: handles finance, todo, routine, workout, media, and place records. +- Learning and reports: supports Anki vocabulary processing, news collection, report generation, and model routing checks. +- Safety checks: runs secret scans, container isolation checks, runtime artifact tracking guards, and operations regression tests. + +## Folder Structure + +- `scripts/`: bridge, bot operations, tests, and automation scripts. +- `scripts/lib/`: shared logic for bridge and operations workflows. +- `packages/`: shared policy, routing, and operations modules. +- `contracts/`: contract files such as OpenClaw profile templates. +- `data/config.json`: default routing and feature policy settings. +- `ops/`: operations queue, alerts, and runtime state. +- `notes/`: decisions, operating procedures, and security policy documents. +- `docs/`: longer runbooks and change map documents. +- `.github/workflows/`: GitHub check workflows. + +## Quick Start + +Install dependencies. + +```bash +npm ci +``` + +Run the basic regression tests. + +```bash +npm run -s test:v1-release +npm run -s test:ops +``` + +Start and stop the OpenClaw live containers. + +```bash +npm run -s openclaw:up +npm run -s openclaw:down +``` + +Check operations status. + +```bash +npm run -s ops:daily:health +node scripts/bridge.js auto "운영: 액션: 상태; 대상: daily" +``` + +Note: `npm test` is not the real test bundle for this project. Use the named test commands above. + +## Common Commands + +Bridge auto routing: + +```bash +node scripts/bridge.js auto "단어: absorb" +node scripts/bridge.js auto "작업: 요청: 브릿지 라우팅 점검; 대상: scripts/bridge.js; 완료기준: 테스트 통과" +``` + +OpenClaw auth and config: + +```bash +npm run -s openclaw:auth:sync +npm run -s openclaw:config:sync:check +npm run -s openclaw:approvals:status +``` + +Safety checks: + +```bash +npm run -s check:container-isolation-refs +npm run -s check:runtime-artifact-tracking +npm run -s check:openclaw-profile-templates +npm run -s check:secrets-scan-workflow +``` + +OpenClaw backup: + +```bash +npm run -s backup:openclaw +npm run -s backup:openclaw:verify +``` + +## Safety Rules + +- Do not create a `.env` file at the repository root. +- Keep runtime environment values in `$HOME/.config/moltbot/runtime.env`. +- Do not commit `configs/**/auth-profiles.json`, `data/secure/*`, `logs/`, `memory/`, or `reports/`. +- Do not commit API keys, Telegram tokens, OAuth sessions, or personal data. +- High-risk operations must go through the approval token flow. +- OpenClaw containers must keep local binding and isolation settings. + +## GitHub Checks + +PRs and `main` use these checks. + +- `core-regression`: core routing, personal automation, and operations workflow tests. +- `gitleaks`: secret pattern scan. +- `trufflehog`: secret history scan. +- `guard`: container isolation guard. + +## More Documents + +- Operations playbook: `notes/OPERATIONS_PLAYBOOK.md` +- OpenClaw routing: `notes/OPENCLAW_ROUTING.md` +- Runtime runbook: `docs/openclaw_runtime_runbook.md` +- Public/private split policy: `notes/PRIVACY_SPLIT_PLAYBOOK.md` +- OpenClaw lockdown policy: `notes/OPENCLAW_LOCKDOWN_RUNBOOK.md` +- Recent OpenClaw update record: `notes/OPENCLAW_UPDATE_2026-04-29.md` diff --git a/README.ja.md b/README.ja.md new file mode 100644 index 0000000..1224a7e --- /dev/null +++ b/README.ja.md @@ -0,0 +1,119 @@ +# Moltbot Workspace + +[한국어](README.md) | [English](README.en.md) | [日本語](README.ja.md) + +Moltbot Workspace は、Telegram から届いた依頼を役割別のボットとローカル自動化に振り分けて処理する、個人用の運用ワークスペースです。 + +このリポジトリには、コード、設定テンプレート、テスト、運用ドキュメントを置きます。トークン、認証ファイル、ログ、個人記録などの機密情報はコミットせず、ローカルまたは非公開の場所で管理します。 + +## 主な役割 + +- Telegram ブリッジ: `단어:`, `작업:`, `점검:`, `운영:` のような入力を適切な処理に送ります。 +- OpenClaw ランタイム: `dev`, `anki`, `research`, `daily`, `codex` などの役割ボットを管理します。 +- 運用キュー: ファイル操作、再起動、外部ツール実行など注意が必要な作業を承認フローで処理します。 +- 個人自動化: 家計、ToDo、ルーティン、運動、コンテンツ、場所の記録を扱います。 +- 学習とレポート: Anki 単語処理、ニュース収集、レポート作成、モデルルーティング確認を支援します。 +- 安全チェック: 機密情報スキャン、コンテナ分離、ランタイムファイル追跡防止、運用回帰テストを実行します。 + +## フォルダ構成 + +- `scripts/`: ブリッジ、ボット運用、テスト、自動化スクリプト。 +- `scripts/lib/`: ブリッジと運用フローの共通ロジック。 +- `packages/`: 共通ポリシー、ルーティング、運用モジュール。 +- `contracts/`: OpenClaw プロファイルテンプレートなどの契約ファイル。 +- `data/config.json`: ルーティングと機能ポリシーの基本設定。 +- `ops/`: 運用キュー、アラート、実行状態を扱う領域。 +- `notes/`: 意思決定、運用手順、セキュリティポリシー文書。 +- `docs/`: 長めの実行ガイドと変更マップ文書。 +- `.github/workflows/`: GitHub のチェックフロー。 + +## クイックスタート + +必要なパッケージをインストールします。 + +```bash +npm ci +``` + +基本の回帰テストを実行します。 + +```bash +npm run -s test:v1-release +npm run -s test:ops +``` + +OpenClaw のライブコンテナを起動・停止します。 + +```bash +npm run -s openclaw:up +npm run -s openclaw:down +``` + +運用状態を確認します。 + +```bash +npm run -s ops:daily:health +node scripts/bridge.js auto "운영: 액션: 상태; 대상: daily" +``` + +注意: このプロジェクトの `npm test` は実際のテスト一式ではありません。上のような名前付きのテストコマンドを使います。 + +## よく使うコマンド + +ブリッジ自動ルーティング: + +```bash +node scripts/bridge.js auto "단어: absorb" +node scripts/bridge.js auto "작업: 요청: 브릿지 라우팅 점검; 대상: scripts/bridge.js; 완료기준: 테스트 통과" +``` + +OpenClaw の認証と設定: + +```bash +npm run -s openclaw:auth:sync +npm run -s openclaw:config:sync:check +npm run -s openclaw:approvals:status +``` + +安全チェック: + +```bash +npm run -s check:container-isolation-refs +npm run -s check:runtime-artifact-tracking +npm run -s check:openclaw-profile-templates +npm run -s check:secrets-scan-workflow +``` + +OpenClaw バックアップ: + +```bash +npm run -s backup:openclaw +npm run -s backup:openclaw:verify +``` + +## 安全ルール + +- リポジトリ直下に `.env` を作りません。 +- ランタイム環境値は `$HOME/.config/moltbot/runtime.env` に置きます。 +- `configs/**/auth-profiles.json`, `data/secure/*`, `logs/`, `memory/`, `reports/` は Git に入れません。 +- API キー、Telegram トークン、OAuth セッション、個人データはコミットしません。 +- 高リスクの運用作業は承認トークンフローを通します。 +- OpenClaw コンテナはローカルバインドと分離設定を維持します。 + +## GitHub チェック + +PR と `main` には次のチェックがあります。 + +- `core-regression`: コアルーティング、個人自動化、運用フローのテスト。 +- `gitleaks`: 機密情報パターンのスキャン。 +- `trufflehog`: 履歴内の機密情報スキャン。 +- `guard`: コンテナ分離基準のチェック。 + +## 詳しいドキュメント + +- 運用手順: `notes/OPERATIONS_PLAYBOOK.md` +- OpenClaw ルーティング: `notes/OPENCLAW_ROUTING.md` +- ランタイム実行ガイド: `docs/openclaw_runtime_runbook.md` +- 公開/非公開分離ポリシー: `notes/PRIVACY_SPLIT_PLAYBOOK.md` +- OpenClaw ロックダウンポリシー: `notes/OPENCLAW_LOCKDOWN_RUNBOOK.md` +- 最近の OpenClaw 更新記録: `notes/OPENCLAW_UPDATE_2026-04-29.md` diff --git a/README.md b/README.md index 1dce9c4..848a182 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Moltbot Workspace +[한국어](README.md) | [English](README.en.md) | [日本語](README.ja.md) + Moltbot Workspace는 텔레그램으로 들어온 요청을 여러 역할 봇과 로컬 자동화로 나눠 처리하는 개인 운영 작업공간입니다. 이 저장소에는 코드, 설정 템플릿, 테스트, 운영 문서를 둡니다. 토큰, 인증 파일, 로그, 개인 기록 같은 민감한 자료는 저장소에 올리지 않고 로컬 또는 비공개 공간에 따로 둡니다.