Files
leonapp/leonapp-cli/README.md

141 lines
3.4 KiB
Markdown
Raw Permalink Normal View History

2025-09-20 22:20:08 +08:00
# LeonApp CLI
一个用于访问App Store API的命令行工具支持查看应用列表、应用详情、标签、开发者信息、公告和统计数据等功能。
## 功能特性
- **应用管理**:查看所有应用列表、获取应用详细信息
- **标签管理**:查看所有标签、获取标签下的应用列表
- **开发者管理**:查看开发者的应用列表、获取开发者详细信息
- **公告管理**:查看所有公告信息
- **统计信息**:获取应用商店的统计数据
- **交互式模式**:提供友好的交互式命令行界面
- **命令行模式**:支持直接通过命令行参数执行特定操作
- **彩色输出**:使用彩色文本提升用户体验
- **分页支持**:支持列表数据的分页查看
## 环境要求
- Python 3.6 或更高版本
- 安装必要的依赖包(见安装指南)
## 安装指南
1. 确保你已安装Python 3.6或更高版本
2. 克隆或下载此项目到本地
3. 安装依赖包:
```bash
cd leonapp-cli
pip install -r requirements.txt
```
4. 在Windows上你可以直接运行Python脚本
```bash
python leonapp_cli.py
```
在Linux/Mac上你可能需要设置执行权限
```bash
chmod +x leonapp_cli.py
./leonapp_cli.py
```
## 使用方法
### 1. 交互式模式
最简单的使用方式是直接运行脚本进入交互式模式:
```bash
python leonapp_cli.py
```
在交互式模式下,你可以输入命令来执行各种操作。输入 `help` 可以查看所有可用命令。
### 2. 命令行模式
你也可以直接通过命令行参数执行特定操作:
#### 查看应用列表
```bash
python leonapp_cli.py list-apps --page 1 --limit 20
```
#### 查看应用详情
```bash
python leonapp_cli.py app-info 1
```
#### 查看所有标签
```bash
python leonapp_cli.py list-tags
```
#### 查看标签下的应用
```bash
python leonapp_cli.py tag-apps 1 --page 1 --limit 20
```
#### 查看开发者的应用
```bash
python leonapp_cli.py developer-apps 1 --page 1 --limit 20
```
#### 查看开发者信息
```bash
python leonapp_cli.py developer-info 1
```
#### 查看所有公告
```bash
python leonapp_cli.py list-announcements --page 1 --limit 20
```
#### 查看统计信息
```bash
python leonapp_cli.py stats
```
## 交互式命令列表
在交互式模式下,你可以使用以下命令:
- `exit``quit` - 退出程序
- `help` - 显示帮助信息
- `list apps` - 列出所有应用
- `app [id]` - 查看应用详情
- `list tags` - 列出所有标签
- `tag apps [id]` - 查看标签下的应用
- `developer apps [id]` - 查看开发者的应用
- `developer info [id]` - 查看开发者信息
- `list announcements` - 列出所有公告
- `stats` - 查看统计信息
## 配置
目前API基础URL是硬编码在脚本中的`http://localhost/APP Store/api.php`。如果你的API地址不同你需要修改脚本中的`self.api_base_url`变量。
## 注意事项
1. 确保API服务器正在运行并且可以从你的计算机访问
2. 如果遇到连接问题,请检查网络连接和防火墙设置
3. 脚本使用了`requests``colorama`库,确保它们已正确安装
4. 部分功能可能需要特定的API权限
## 许可证
[MIT License](LICENSE)
## 作者
LeonApp CLI Team
## 更新日志
### v1.0.0
- 初始版本,支持所有基本功能
- 提供交互式和命令行两种使用模式
- 支持彩色输出和分页功能