ChatSync Docs¶

ChatSync is the ChatArch Python CLI package shell for synchronization tooling. The public CLI currently exposes package metadata and the real command tree only; future synchronization capabilities should start with reusable Python APIs before extending CLI commands, docs, and tests.

Site entry: https://arch.gh.wzhecnu.cn/ChatSync/en/

Choose Documentation by Scenario¶

Scenario	Document
Install the package, run the CLI, and confirm it works	CLI Tree
Check first-class capabilities and current boundaries	Capability Map
Call package behavior directly from Python	Python Interface Tree

Documentation Organization¶

This template keeps only durable documentation entry points; it does not generate a plan placeholder:

CLI tree: the most direct command entry point, including the real command tree, status, and update checklist.
Capability map: first-class capabilities, boundaries, and out-of-scope areas.
Interface tree: importable Python APIs behind the CLI.

Primary Entry Points¶

CLI Tree

Start with chatsync --tree / chatsync --tree-brief and record implemented commands, command status, and interactive conventions.

Open CLI Tree
Capability Map

Review current package boundaries and avoid presenting planned work as implemented behavior.

Open Capability Map
Python Interface Tree

Keep the CLI thin and put substantive behavior in importable Python APIs.

Open Interface Tree

Quick Start¶

pip install ChatSync
chatsync --version
chatsync --tree
chatsync --tree-brief

Documentation Status¶

Implemented: code, tests, or CLI routes exist.
Verified: covered by local smoke, CI, or real-service practice.
Not implemented: keep as boundary and planning notes only; turn into operation docs after implementation and validation.

Local Preview¶

python -m pip install -e ".[docs]"
mkdocs serve

The Chinese home page is available at https://arch.gh.wzhecnu.cn/ChatSync/. Topic pages without English translations fall back to the default Chinese content through the i18n plugin.