DroidRun 项目使用教程

DroidRun 项目使用教程

droidrun 项目地址: https://gitcode.com/gh_mirrors/dr/droidrun

1. 项目目录结构及介绍

DroidRun 项目是一个用于通过 LLM（Language Model）代理控制 Android 设备的强大框架。以下是项目的目录结构及其简要介绍：

droidrun/
├── docs/               # 项目文档目录
├── droidrun/           # 项目主要代码目录
├── static/             # 静态文件目录，如图片、样式表等
├── .gitignore          # Git 忽略文件列表
├── LICENSE             # 项目许可证文件
├── MANIFEST.in         # 打包配置文件
├── README.md           # 项目说明文件
├── pyproject.toml      # 项目配置文件
├── setup.py            # 项目安装脚本

• docs/: 包含项目的文档和相关说明。
• droidrun/: 包含项目的主要代码，包括 Python 类和函数。
• static/: 存放静态文件，如项目所需的图片、样式表等。
• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• LICENSE: 项目使用的许可证信息，本项目采用 MIT 许可。
• MANIFEST.in: 指定项目打包时包含的文件。
• README.md: 项目说明文件，包含项目简介、安装步骤和使用说明。
• pyproject.toml: 包含项目元数据和依赖关系的配置文件。
• setup.py: 用于安装 Python 包的脚本。

2. 项目的启动文件介绍

项目的主要启动方式是通过命令行界面（CLI）。使用 CLI，用户可以执行自然语言命令来控制 Android 设备。以下是启动 CLI 的基本命令：

droidrun "task description" [options]

其中，"task description" 是用户想要执行的任务描述，[options] 是可选参数，用于指定 LLM 提供商、模型、设备等。

3. 项目的配置文件介绍

项目使用 .env 文件来存储环境变量，这些变量包括 LLM 提供商的 API 密钥等敏感信息。.env 文件应放置在项目根目录下，内容如下：

# 选择至少一个，根据你偏好的提供商
export OPENAI_API_KEY="your_openai_api_key_here"
export ANTHROPIC_API_KEY="your_anthropic_api_key_here"
export GEMINI_API_KEY="your_gemini_api_key_here"

在 Python 代码中，使用 python-dotenv 库来加载 .env 文件中的环境变量：

from dotenv import load_dotenv

load_dotenv()

这样，代码就可以通过 os.environ 获取到 .env 文件中设置的环境变量。

droidrun 项目地址: https://gitcode.com/gh_mirrors/dr/droidrun