Metadata-Version: 2.4
Name: ChatCI
Version: 0.1.3
Summary: ChatCI: ChatArch CI workflow package shell.
Author-email: ChatArch <1073853456@qq.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/ChatArch/ChatCI
Project-URL: Repository, https://github.com/ChatArch/ChatCI
Project-URL: Documentation, https://arch.gh.wzhecnu.cn/ChatCI/
Keywords: chatci,chatarch,cli
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click<9.0,>=8.1
Requires-Dist: chatstyle<0.3.0,>=0.2.0
Requires-Dist: chatenv<0.3.0,>=0.2.10
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: twine; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs<2.0,>=1.6; extra == "docs"
Requires-Dist: mkdocs-material<10.0,>=9.5; extra == "docs"
Requires-Dist: mkdocs-static-i18n<2.0,>=1.2; extra == "docs"
Requires-Dist: mike<3.0,>=2.0; extra == "docs"
Dynamic: license-file

<div align="center">
    <a href="https://pypi.python.org/pypi/ChatCI">
        <img src="https://img.shields.io/pypi/v/ChatCI.svg" alt="PyPI version" />
    </a>
    <a href="https://arch.gh.wzhecnu.cn/ChatCI/">
        <img src="https://img.shields.io/badge/docs-ChatArch-blue" alt="Docs" />
    </a>
</div>

<div align="center">

[English](README.en.md) | [简体中文](README.md)
</div>

# ChatCI

ChatCI 是 ChatArch 的 CI workflow package shell，用于保留 PyPI package / console command 的规范入口。

- 文档：https://arch.gh.wzhecnu.cn/ChatCI/
- PyPI：https://pypi.org/project/ChatCI/

## 快速开始

```bash
pip install ChatCI
chatci --help
chatci --version
chatci --tree
chatci --tree-brief
```

开发环境：

```bash
pip install -e ".[dev,docs]"
python -m pytest -q
mkdocs build --strict
python -m build
python -m twine check dist/*
```

## CLI 规范

当前可回读命令树：

```text
chatci
├── --help  # Show this message and exit.
├── --version  # Show the version and exit.
├── --tree  # Print the registered CLI tree and exit.
└── --tree-brief  # Print the registered CLI tree without parameter signatures and exit.
```

`chatci --tree` 由 ChatStyle 共享 Click tree runtime 从真实 registry 生成，并默认显示命令参数签名；`chatci --tree-brief` 保留命令节点和描述，但省略参数签名。当前 `ChatCI` 是 root-options-only surface，所有公开选项都是 flag，因此两种输出目前包含相同节点。后续新增命令时，必须同步测试、README、MkDocs 文档和 release report。

## 目录结构

- `src/`：包源码
- `tests/code-tests/`：代码测试和历史测试迁移
- `tests/cli-tests/`：真实 CLI 测试，doc-first
- `tests/mock-cli-tests/`：mock/fake CLI 测试，doc-first
- `docs/`：MkDocs Material 双语文档

## 开发说明

扩展脚手架前，先阅读 `DEVELOP.md` 和 `AGENTS.md`。
