Metadata-Version: 2.4
Name: zt-archery-cli
Version: 0.2.1
Summary: Archery CLI
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: playwright>=1.40.0
Requires-Dist: requests>=2.31.0
Requires-Dist: click>=8.1.0
Requires-Dist: pyyaml>=6.0

# zt-archery-cli

Archery SQL 审核平台命令行工具，用于登录并查询实例、库、表结构与 SQL 结果。

## 环境要求

- Python `>=3.10`
- 可用浏览器（首次登录会自动打开）

## 安装

### 开发安装（源码）

```bash
pip install -e .
```

### 打包发布

```bash
python -m pip install --upgrade build twine
python -m build
twine upload dist/*
```

## 快速开始

### 1) 登录并缓存 Cookie

首次运行会打开浏览器，请完成登录。成功后会缓存 Cookie 到本地。

```bash
zt-archery-cli login
```

### 2) 查看可读实例

```bash
zt-archery-cli sql instances
```

### 3) 查询实例下数据库

```bash
zt-archery-cli sql databases -i your_instance
```

### 4) 查询数据库下表

```bash
zt-archery-cli sql tables -i your_instance -d your_database
```

### 5) 查看表结构

```bash
zt-archery-cli sql describe -i your_instance -d your_database -t your_table
```

### 6) 执行 SQL

```bash
zt-archery-cli sql query \
  -i your_instance \
  -d your_database \
  -t your_table \
  --sql "select * from your_table limit 10"
```

## 全局参数
- `-o, --output`：输出格式，支持：
  - `json`（默认）
  - `human`（表格）

示例：

```bash
zt-archery-cli -o human sql instances
```

## 配置说明

默认配置目录：`~/.zt-archery-cli`

- Cookie 缓存：`~/.zt-archery-cli/cookies.json`
- 配置文件：`~/.zt-archery-cli/config.yaml`

可选配置项示例：

```yaml
browser_channel: chromium
```

## 环境变量（可选）

支持通过环境变量自动填充登录页账号密码（如 SSO 页面字段可用）：

- `ZT_SSO_USERNAME`
- `ZT_SSO_PASSWORD`

未设置时可在浏览器中手动完成登录。
