Skip to content

README_ja.md

Latest commit

 

History

History
106 lines (71 loc) · 5.22 KB

README_ja.md

File metadata and controls

106 lines (71 loc) · 5.22 KB
Raw

Project N.E.K.O.

简体中文 · English · Русский

Project N.E.K.O.

Browser／Electron surface、永続 memory、具現化 avatar、Agent 機能、plugin SDK を備えた local-first AI companion runtime です。

Python 3.11 Apache License 2.0 開発者ドキュメント Steam

このファイルは簡潔な repository overview です。現在の architecture、setup、configuration、API、deployment、plugin、contribution の正本は開発者ドキュメントです。Provider／model 一覧、価格、product version の約束、roadmap 日付は複製しません。

現在のリポジトリ境界

  • 会話 runtime: text、audio、vision pipeline と character 設定。
  • Avatar surface: Live2D、VRM、MMD、PNGTuber、desktop pet 関連 path。
  • Memory: 会話 event の永続化、projection、recall candidate、evidence／reflection、persona、maintenance queue。
  • Agent: browser／computer automation、task state transport、外部 Agent adapter、runtime tool service。
  • Plugin: SDK 契約、built-in plugin、hosted surface、lifecycle hook、routing、packaging gate。
  • Frontend: 静的／Jinja page、単一の React chat 実装、Vue plugin manager。Browser / と Electron の /chat、/subtitle は別 runtime context です。

実装が存在しても、すべての provider、platform、distribution、任意 integration が同等にサポートされるとは限りません。

Source から実行

必要要件：

  • Python は 3.11 固定。
  • uv。
  • Frontend を再ビルドする場合は Node.js ^20.19.0 || >=22.12.0。
git clone --filter=blob:none https://github.com/Project-N-E-K-O/N.E.K.O.git
cd N.E.K.O
uv sync

初回 checkout または frontend 変更後に二つの frontend project を build します。

# Linux / macOS
./build_frontend.sh
# Windows PowerShell
.\build_frontend.bat

サポート対象の service suite を起動します。

uv run python launcher.py

http://127.0.0.1:48911 を開きます。Service を個別起動する前に開発環境とクイックスタートを確認してください。

Port とデプロイ

Context Host port 意味
Source runtime 48911 Main Web/API service
Source runtime 48912 Memory service
Docker Compose 48911 Nginx HTTP entry
Docker Compose 48912 Nginx HTTPS entry

これは異なる二つの port model です。他の内部／既定 service port と override は環境変数にあります。

追跡中の Compose file は image を pull し、build: section を持ちません。

docker compose up -d

Local image build、storage、TLS、image 選択は Docker ガイドに従ってください。Source／desktop artifact はデプロイ概要から確認します。

ドキュメント案内

API/provider 設定は schema-driven です。コピーされた provider／model 一覧ではなく、現在の settings UI と config/api_providers.json を確認してください。

Privacy と telemetry

Runtime が認識する opt-out は DO_NOT_TRACK=1 または NEKO_DO_NOT_TRACK=1 です。実行する revision の最新 disclosure は repository root の README と utils/token_tracker/ を確認してください。この短い翻訳では変化しやすい payload 詳細を複製しません。

コントリビューションとライセンス

編集前に .agent/rules/neko-guide.md と対応する .agent/skills/*/SKILL.md を読みます。Project の Python コマンドはすべて uv run で実行し、ユーザー向け i18n 変更では 8 個の runtime locale を更新します。

Project N.E.K.O. は Apache License 2.0 で公開されています。再現可能な bug と範囲を絞った提案には GitHub Issues を使用してください。