docs: consolidate design documentation and standardize crate English
This commit is contained in:
@@ -1,85 +1,16 @@
|
||||
# 夜居 / Yoi agent
|
||||
# 夜居 / Yoi
|
||||
|
||||
Yoi is an agent runtime for building, running, and orchestrating LLM Workers while preserving explicit history, scoped capabilities, and developer-controlled workflows.
|
||||
Yoiは、LLM Workerの実行履歴と明示的な権限を管理するエージェント実行基盤である。Workspaceの記録と操作権限をBackendが管理し、RuntimeがWorkerと作業ディレクトリの実行資源を管理する。単一プロセスで実行するStandaloneは、Workspaceの権限やRuntime Workerの登録とは分離している。
|
||||
|
||||
## 1. Yoi agent
|
||||
## 実装の入口
|
||||
|
||||
Yoi focuses on long-running agent operation rather than one-off prompt execution. A named Worker can keep durable session history, run with explicit tool and filesystem authority, delegate bounded work to child Workers, and be inspected or restored through CLI/TUI surfaces.
|
||||
- [agen](crates/agen/README.md)：LLMターン、履歴、ツール呼出し。
|
||||
- [worker](crates/worker/README.md)：セッション、機能、ツールと実行権限の接続。
|
||||
- [workspace-server](crates/workspace-server/README.md)：Workspaceの正本とBackend操作。
|
||||
- [worker-runtime](crates/worker-runtime/README.md)：Workerの実行とRuntime資源。
|
||||
- [standalone](crates/standalone/README.md)：プロセス内の独立した実行ホスト。
|
||||
- [yoi](crates/yoi/README.md)・[tui](crates/tui/README.md)・[Web](web/workspace/README.md)：利用者との接点。
|
||||
|
||||
Main highlights:
|
||||
各crateのREADMEをcrateドキュメントとして使い、具体的な設計理由はmodule・itemのrustdocに置く。文書の追加・維持・削除は[文書管理規則](docs/README.md)、変更の検証は[検証規則](docs/development/validation.md)に従う。
|
||||
|
||||
- Named long-running **Workers** with durable session and metadata records.
|
||||
- Explicit tool permissions and filesystem scopes.
|
||||
- Multi-agent orchestration with scoped coder/reviewer Workers.
|
||||
- Profile, Manifest, and prompt-based runtime configuration.
|
||||
- Local Tickets and workflow files for auditable project coordination.
|
||||
- TUI and CLI entry points, including the `yoi panel` workspace Dashboard and single-Worker Console.
|
||||
|
||||
Yoi is actively dogfooded in this repository. Public APIs, configuration formats, and workflows may still change.
|
||||
|
||||
## 2. Quick Install
|
||||
|
||||
From source:
|
||||
|
||||
```sh
|
||||
cargo build --release -p yoi
|
||||
./target/release/yoi --help
|
||||
```
|
||||
|
||||
With Nix:
|
||||
|
||||
```sh
|
||||
nix build .#yoi
|
||||
./result/bin/yoi --help
|
||||
```
|
||||
|
||||
## 3. Getting Started
|
||||
|
||||
```sh
|
||||
yoi --help
|
||||
yoi
|
||||
yoi panel
|
||||
yoi --worker <name>
|
||||
yoi worker --help
|
||||
```
|
||||
|
||||
Typical flow:
|
||||
|
||||
1. Configure providers, models, profiles, prompts, and scopes.
|
||||
2. Start or attach to a named Worker in the Console, or inspect workspace activity in the Dashboard.
|
||||
3. Use explicit tools and scoped delegation for multi-agent work.
|
||||
4. Record project work through Tickets, workflow files, and git history.
|
||||
|
||||
Client and execution surfaces use the `yoi` binaries, XDG client/server configuration and data directories, Runtime-owned Workdirs/session artifacts, Server data directories, `YOI_*`, and the preserved legacy home secret-store boundary under `~/.yoi`. Repository-local `.yoi` trees are ignored legacy input, not runtime authority.
|
||||
|
||||
## 4. Documentation
|
||||
|
||||
Start with [`docs/README.md`](docs/README.md).
|
||||
|
||||
Key docs:
|
||||
|
||||
- [`docs/design/overview.md`](docs/design/overview.md) — architecture and crate ownership map.
|
||||
- [`docs/design/context-history.md`](docs/design/context-history.md) — history/context invariants.
|
||||
- [`docs/design/worker-session-state.md`](docs/design/worker-session-state.md) — Worker identity, metadata, and session logs.
|
||||
- [`docs/design/profiles-manifests-prompts.md`](docs/design/profiles-manifests-prompts.md) — Profiles, Manifests, and prompt resources.
|
||||
- [`docs/design/tool-permissions-scope.md`](docs/design/tool-permissions-scope.md) — tool policy and filesystem scope.
|
||||
- [`docs/development/work-items.md`](docs/development/work-items.md) — Ticket workflow and project records.
|
||||
- [`docs/development/validation.md`](docs/development/validation.md) — validation expectations.
|
||||
|
||||
## 5. Development
|
||||
|
||||
This repository dogfoods Yoi to develop Yoi. Work is tracked through Workspace Server-backed Tickets and `yoi ticket ...`; Git history plus append-only Ticket and Merge Request evidence are the authoritative project record. Repository-local `.yoi/tickets` trees are ignored legacy input.
|
||||
|
||||
Common checks:
|
||||
|
||||
```sh
|
||||
yoi ticket doctor
|
||||
git diff --check
|
||||
cargo fmt --check
|
||||
cargo check --workspace --all-targets
|
||||
cargo test --workspace
|
||||
```
|
||||
|
||||
Real-process E2E testing is opt-in. Do not design or implement E2E coverage unless the work explicitly requires E2E; otherwise protect the narrower parser, API, protocol, authority, or runtime boundary.
|
||||
|
||||
License: MIT. See [`LICENSE`](LICENSE).
|
||||
ライセンスは[MIT](LICENSE)。
|
||||
|
||||
Reference in New Issue
Block a user