OpenHands 项目使用教程

OpenHands 项目使用教程

OpenHands 🙌 OpenHands: Code Less, Make More 项目地址: https://gitcode.com/gh_mirrors/ope/OpenHands

1. 项目目录结构及介绍

OpenHands 项目的目录结构如下：

.
├── .github
├── .openhands
├── containers
├── dev_config
│   └── python
├── docs
├── evaluation
├── frontend
├── microagents
├── openhands
├── tests
├── .dockerignore
├── .gitattributes
├── .gitignore
├── .nvmrc
├── CITATION.cff
├── CODE_OF_CONDUCT.md
├── COMMUNITY.md
├── CONTRIBUTING.md
├── CREDITS.md
├── Development.md
├── ISSUE_TRIAGE.md
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.md
├── build.sh
├── config.template.toml
├── docker-compose.yml
├── poetry.lock
├── pydoc-markdown.yml
├── pyproject.toml
├── pytest.ini
└── ...

• .github：包含 GitHub 的工作流程和模板。
• .openhands：可能包含 OpenHands 的配置文件和状态信息。
• containers：包含与容器相关的文件。
• dev_config：开发者的配置文件，其中 python 目录可能包含 Python 相关的配置。
• docs：项目的文档资料。
• evaluation：评估和测试代码的目录。
• frontend：前端代码目录。
• microagents：可能包含微代理相关的代码。
• openhands：主应用程序的代码目录。
• tests：测试代码的目录。
• .dockerignore：Docker 构建时排除的文件列表。
• .gitattributes：Git 属性配置文件。
• .gitignore：Git 忽略文件列表。
• 其他文件包括项目许可证、贡献指南、代码规范等文档。

2. 项目的启动文件介绍

OpenHands 项目的启动通常通过 Docker 进行。以下是一个基本的启动命令示例：

docker pull docker.all-hands.dev/all-hands-ai/runtime:0.30-nikolaik
docker run -it --rm --pull=always \
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.30-nikolaik \
-e LOG_ALL_EVENTS=true \
-v /var/run/docker.sock:/var/run/docker.sock \
-v ~/.openhands-state:/.openhands-state \
-p 3000:3000 \
--add-host host.docker.internal:host-gateway \
--name openhands-app \
docker.all-hands.dev/all-hands-ai/openhands:0.30

该命令会拉取并运行 OpenHands 的 Docker 容器，并在本地端口 3000 上暴露服务。

3. 项目的配置文件介绍

OpenHands 的配置文件通常为 config.template.toml。该文件是 TOML 格式，包含了项目运行所需的配置信息。以下是一个配置文件的示例：

# config.template.toml

[server]
port = 3000
host = "0.0.0.0"

[features]
enabled = ["feature1", "feature2"]
disabled = ["feature3"]

[models]
provider = "Anthropic"
api_key = "your_api_key_here"

在这个配置文件中，可以设置服务器的端口和主机地址，启用或禁用某些特性，以及配置模型提供者和 API 密钥等。你需要根据实际情况修改 api_key 的值。

在开始使用 OpenHands 前，确保正确配置了所有必要的设置。

OpenHands 🙌 OpenHands: Code Less, Make More 项目地址: https://gitcode.com/gh_mirrors/ope/OpenHands