Metadata-Version: 2.5
Name: zen-cli
Version: 0.1.12
Summary: CLI for Zen Cloud Service. Designed for AI and Human.
Project-URL: Homepage, https://pypi.org/project/zen-cli/
Author: zen-cli authors
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: authlib
Requires-Dist: click>=8.1
Requires-Dist: httpx2
Requires-Dist: mcp>=2
Requires-Dist: packaging
Requires-Dist: portalocker[win32]
Requires-Dist: pydantic
Requires-Dist: pyjwt
Requires-Dist: python-dotenv
Requires-Dist: pyyaml
Requires-Dist: questionary
Requires-Dist: rich-click>=1.8
Requires-Dist: tabulate
Requires-Dist: yumako
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: mypy==2.3.1; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: ruff==0.16.8; extra == 'dev'
Provides-Extra: release
Requires-Dist: build; extra == 'release'
Requires-Dist: twine; extra == 'release'
Description-Content-Type: text/markdown

# zen-cli

[![PyPI](https://img.shields.io/pypi/v/zen-cli?logo=pypi&logoColor=white)](https://pypi.org/project/zen-cli/) [![Python](https://img.shields.io/badge/python-3.12%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/downloads/) [![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE) [![PyPI downloads](https://img.shields.io/pypi/dm/zen-cli)](https://pypi.org/project/zen-cli/) [![Wheel](https://img.shields.io/pypi/wheel/zen-cli)](https://pypi.org/project/zen-cli/) [![OS](https://img.shields.io/badge/OS-macOS%20%7C%20Linux%20%7C%20Windows-informational)](https://pypi.org/project/zen-cli/) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Checked with mypy](https://img.shields.io/badge/mypy-checked-2A6DB2)](https://mypy-lang.org/)

面向 AI 和人的 Zen Cloud 命令行工具。

## 使用

### 前置条件

* Python 3.12 或更新版本
* [uv](https://docs.astral.sh/uv/) 或 [pipx](https://pipx.pypa.io/)

### 安装

```bash
uv tool install --upgrade zen-cli
```

或：

```bash
pipx install --upgrade zen-cli
```

装完后若找不到 `zen`，跑 `uv tool update-shell` 或 `pipx ensurepath`，然后开一个新终端。Windows 同样适用。


### 使用 CLI

```bash
# 登录
zen login

# 跑一条命令，例如列出桌面池：
zen pool list

# 以可读方式输出
zen pool list -otable

# 更新
zen upgrade
```

## 文档

* [用户指南](docs/user-guide.md) — profile、旗标、请求体和命令约定
* [速查](docs/cheatsheet.md) — 命令示例
* [开发指南](docs/dev-guide.md) — 环境、`dev.py`、Jenkins 和如何加命令
* [CLI 通用原则](docs/cli-principles.md) — 退出码、输出格式、通用参数和特例
* [编码原则](docs/coding-principles.md) — 包划分和导入方向
* [环境变量](docs/env.md) — `zen` 读取的环境变量

## 许可证

采用 MIT License。见 [LICENSE](LICENSE)。
