# Eva-CLI Documentation

> Language: English
> Published default: docs/en/README.md
> Current detail authority: [简体中文](../zh-CN/中文文档入口.md)

Eva-CLI has reached the V1.17.6 V1.x closure release gate checkpoint
on the V1.11.5-alpha source line. The repository now contains a compilable
Rust workspace, executable CLI surfaces, configuration validation, an in-memory
basic runtime loop, local task diagnostics, controlled Adapter/MCP/Skill/
Discovery surfaces, durable EventBus/task/audit/artifact evidence, Lua
execution and hot-reload lifecycle boundaries, daemon control and recovery,
provider supervision readiness, restore mutation and rollback evidence,
service-manager abstraction, hardware safety gates, memory retrieval and
redaction evidence, observability retention/rotation policy, operator
execution-state fields, high-risk operator text summaries, public JSON contract
diff validation, synchronized README, user manual, release notes, website
cards, generated site HTML, i18n manifest metadata, and additive `release check`
`closure` reporting with production-only external blockers.

Current managed project version: `V1.11.5-alpha` (`Cargo.toml` version
`1.11.5-alpha`, prerelease Git tag form `v1.11.5-alpha`). V1.17.6 is a
V1.x closure release gate checkpoint, not a new release tag. See
[Eva-CLI Version Management Plan](release/version-management-plan.md).

Important source rule: English documents currently provide the default public
entry, stable slugs, and summary coverage. The Simplified Chinese documents
under `docs/zh-CN/` remain the source of truth for detailed architecture and
implementation-spec content until the English full-detail migration catches up.

## Document Categories

### Guide

Start here when you want to run the project.

- [Eva-CLI User Manual](guide/user-manual.md)

### Architecture

Read these pages to understand the runtime model and module boundaries.

- [Architecture Overview](architecture/architecture-overview.md)
- [Module Partitioning](architecture/module-partitioning.md)
- [eva-core Contract Module](architecture/eva-core-module.md)
- [Single-Process Rust, Lua, and EventBus Runtime](architecture/rust-lua-eventbus-scheduler.md): current synchronous delivery, Lua 5.4, basic-loop, and daemon boundaries.
- [Topic Route Source of Truth and Validation](architecture/topic-routing-hybrid-sync.md): manual route ownership, implemented checks, and Scheduler semantics.

### Capabilities

These documents cover external capability access, memory, discovery, skills, and
hardware boundaries.

- [Lua External Agent Adapter](capabilities/lua-external-agent-adapter.md)
- [Lua Skill, MCP, and Tool Hot Reload](capabilities/lua-skill-mcp-tool-hot-reload.md)
- [Skill Implementation Plan](capabilities/skill-implementation.md)
- [Agent Memory and Knowledge Base](capabilities/agent-memory-knowledge-base.md)
- [Agent Discovery](capabilities/agent-discovery.md)
- [Hardware Hotplug](capabilities/hardware-hotplug.md)

### Operations

Operational documents cover configuration, lifecycle, backup/restore planning,
and documentation publishing.

- [Project Configuration](operations/project-configuration.md)
- [Process-Level Upgrade](operations/process-level-upgrade.md)
- [Backup, Migration Package, and Release Snapshot](operations/backup-migration-release-snapshot.md)
- [Website and Documentation i18n](operations/website-docs-i18n.md)

### Release

Release documents track shipped checkpoints, known limits, hardening gates, and
migration policy.

- [Eva-CLI Project Release Plan](release/project-release-plan.md)
- [Eva-CLI Version Management Plan](release/version-management-plan.md)
- [Eva-CLI GitHub Packages Publishing](release/github-packages-publishing.md)
- [Eva-CLI Install, Upgrade, and Uninstall](release/install-upgrade-uninstall.md)
- [Eva-CLI V1.0 Known Limitations](release/v1.0-known-limitations.md)
- [Eva-CLI V1.0.0 Release Notes](release/release-notes-v1.0.0.md)
- [Eva-CLI V1.5 Release Hardening](release/v1.5-release-hardening.md)
- [Eva-CLI V1.5 Migration Guide](release/v1.5-migration-guide.md)
- [Eva-CLI V1.5 Compatibility Policy](release/v1.5-compatibility-policy.md)
- [Eva-CLI V1.11.5 Alpha Release Notes and V1.17 Sync](release/release-notes-v1.11.5.md)
- [Eva-CLI V1.11.4 Alpha Release Notes](release/release-notes-v1.11.4.md)
- [Eva-CLI V1.7.4 Alpha Release Notes](release/release-notes-v1.7.4.md)
- [Eva-CLI V1.7.3 Alpha Release Notes](release/release-notes-v1.7.3.md)
- [Eva-CLI V1.7.2 Alpha Release Notes](release/release-notes-v1.7.2.md)
- [Eva-CLI V1.7.1 Alpha Release Notes](release/release-notes-v1.7.1.md)
- [Eva-CLI V1.6.5 Alpha Release Notes](release/release-notes-v1.6.5.md)
- [Eva-CLI V1.6.4 Alpha Release Notes](release/release-notes-v1.6.4.md)
- [Eva-CLI V1.6.3 Alpha Release Notes](release/release-notes-v1.6.3.md)
- [Eva-CLI V1.6.2 Alpha Release Notes](release/release-notes-v1.6.2.md)
- [Eva-CLI V1.6.1 Alpha Release Notes](release/release-notes-v1.6.1.md)
- [Eva-CLI V1.5.1 Release Notes](release/release-notes-v1.5.1.md)
- [Eva-CLI V1.5.0 Release Notes](release/release-notes-v1.5.0.md)
- [Eva-CLI V1.5 Release Acceptance](release/v1.5-release-acceptance.md)

### Planning

Planning stays focused on the current V1.x inventory and implementation work.
Superseded roadmap and milestone history remains available through Git history,
immutable release tags, and release notes.

- [V1.x Incomplete Feature Inventory](planning/v1.x-incomplete-feature-inventory.md)
- [V1.x Real Runtime Implementation Plan](planning/v1.x-real-runtime-implementation-plan.md)

### Tooling

Tooling documents describe CLI and IDE surfaces.

- [Command-Line Tool Feature Design](tooling/command-line-tool-feature-design.md)
- [IDEA Plugin Toolchain Requirements](tooling/idea-plugin-toolchain.md)

## Core Boundaries

- Rust owns runtime boundaries, permissions, schemas, sandboxing, secrets,
  process lifecycle, audit, timeout handling, and recovery.
- Lua owns restricted handler logic, data transformation, controlled tool
  requests, and result mapping. Rust owns Agent state and lifecycle; current
  reload support is limited to shadow-load and generation-control primitives.
- Topic EventBus coordinates Agents, but does not store hidden global business
  state.
- AdapterRegistry exposes external capabilities through controlled manifests,
  schemas, policies, transports, and audit hooks.
- Discovery normalizes possible capabilities, but does not authorize execution.
- Memory and knowledge are managed by Rust services; Lua receives only the
  configured read-only `ctx.memory` and context snapshots for the current call.

## Source and Translation Policy

`docs/en/` owns the default public entry and stable English URLs. For detailed
architecture decisions, constraints, API semantics, and implementation specs,
use the mapped `docs/zh-CN/` document as the current authority unless
`docs/_i18n/manifest.json` explicitly marks a full-detail English page as caught
up.

When changing architecture-detail content, update the Chinese detailed source
first, then sync the English page and manifest metadata honestly as summary,
partial, or full-detail coverage.
