Metadata-Version: 2.4
Name: ChatSSH
Version: 0.0.2
Summary: ChatSSH: ChatArch SSH tooling package scaffold
Author-email: ChatArch <noreply@chatarch.org>
License-Expression: MIT
Project-URL: Homepage, https://github.com/ChatArch/ChatSSH
Project-URL: Repository, https://github.com/ChatArch/ChatSSH
Keywords: chatssh,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.0
Requires-Dist: chatstyle<0.3.0,>=0.2.0
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

<div align="center">
    <a href="https://pypi.python.org/pypi/ChatSSH">
        <img src="https://img.shields.io/pypi/v/ChatSSH.svg" alt="PyPI version" />
    </a>
    <a href="https://github.com/ChatArch/ChatSSH/actions/workflows/ci.yml">
        <img src="https://github.com/ChatArch/ChatSSH/actions/workflows/ci.yml/badge.svg" alt="Tests" />
    </a>
</div>

<div align="center">

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

# ChatSSH

ChatSSH 是 ChatArch 的 SSH 工具 package scaffold。当前公开 CLI 保持最小的 root-only 命令面；只有真实 SSH 能力实现后才会注册业务子命令。

## 快速开始

```bash
pip install ChatSSH
chatssh --help
chatssh --version
chatssh --tree
chatssh --tree-brief
```

## 当前 CLI 树

当前没有业务命令参数，因此完整树和简洁树相同：

```text
chatssh
├── --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.
```

## CLI 规范

- 根命令显式命名为 `chatssh`，并暴露 `--version`、`--tree` 和 `--tree-brief`。
- `--tree` / `--tree-brief` 由 `chatstyle>=0.2.0,<0.3.0` 从真实 Click 注册面生成，不维护包内 renderer。
- 当前包没有 env/profile/config 行为，因此不依赖 ChatEnv；未来需要配置时，应注册 typed provider，并使用 `chatenv>=0.2.10,<0.3.0` 与 ChatEnv 管理的存储路径。

## 目录结构

- `src/`：包源码
- `tests/code-tests/`：代码测试和历史测试迁移
- `tests/cli-tests/`：真实 CLI 测试，doc-first
- `tests/mock-cli-tests/`：mock/fake CLI 测试，doc-first

## 开发说明

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