mirror of
https://github.com/All-Hands-AI/OpenHands.git
synced 2026-04-29 03:00:45 -04:00
Compare commits
439 Commits
debug-visu
...
gitlab-doc
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bc1305fc0e | ||
|
|
f985a46cfd | ||
|
|
9ca96afe29 | ||
|
|
7f3f44432e | ||
|
|
35b6b8ae2f | ||
|
|
52110305b3 | ||
|
|
877644be8c | ||
|
|
3bc85eb7ac | ||
|
|
5fa01ed278 | ||
|
|
1f747232cf | ||
|
|
4b1ed30e97 | ||
|
|
998de564cd | ||
|
|
06ce12eff4 | ||
|
|
88fc26d9b0 | ||
|
|
99233ec153 | ||
|
|
ae9573a503 | ||
|
|
f2725eeb3d | ||
|
|
1b63633030 | ||
|
|
107789b5a8 | ||
|
|
04bdea5faf | ||
|
|
2bad4ea3d2 | ||
|
|
1c4c477b3f | ||
|
|
391ba1d988 | ||
|
|
70f469b0c1 | ||
|
|
8a5c6d3bef | ||
|
|
998e04e51b | ||
|
|
da7041b5e9 | ||
|
|
e4b7b31f48 | ||
|
|
587c53f115 | ||
|
|
4d76f31610 | ||
|
|
c25a96825c | ||
|
|
16137942eb | ||
|
|
cf07b151dc | ||
|
|
ea3787c2ba | ||
|
|
956d278138 | ||
|
|
fa186fc433 | ||
|
|
4ef9c72da1 | ||
|
|
c5245a622d | ||
|
|
9b1aaa53fe | ||
|
|
4deffa3907 | ||
|
|
a47c6f3ed1 | ||
|
|
90ece3f8e1 | ||
|
|
a948b0fef3 | ||
|
|
52848cd3db | ||
|
|
62f015370a | ||
|
|
7109b057b6 | ||
|
|
e694fc2d58 | ||
|
|
50baf3fd18 | ||
|
|
dc37f039bf | ||
|
|
91fff77ffe | ||
|
|
db01cd39d5 | ||
|
|
00865fbb8a | ||
|
|
356cd9ff9f | ||
|
|
78d82408b7 | ||
|
|
3c4ebc3d8a | ||
|
|
964478c22f | ||
|
|
00c449d447 | ||
|
|
bfd75a1355 | ||
|
|
dc91cb263b | ||
|
|
fa559ace86 | ||
|
|
1fd26d196a | ||
|
|
5de62d85fd | ||
|
|
5d749aeba7 | ||
|
|
693c72d670 | ||
|
|
62557d44f2 | ||
|
|
89f8e162da | ||
|
|
b0a9938e6c | ||
|
|
039fe295a4 | ||
|
|
8f3ff1210e | ||
|
|
5e1e685493 | ||
|
|
e9f2b72ea5 | ||
|
|
986b90be0a | ||
|
|
bf9f2aa7a5 | ||
|
|
b3bd3924a0 | ||
|
|
0de50153a0 | ||
|
|
a04024a239 | ||
|
|
1e509a70d4 | ||
|
|
300a59853b | ||
|
|
2514b200c5 | ||
|
|
52d881c98d | ||
|
|
6ac23aea80 | ||
|
|
0412949018 | ||
|
|
5b5adc5c7b | ||
|
|
0b40f6fac8 | ||
|
|
44d488b718 | ||
|
|
4f9120ffc6 | ||
|
|
50426edaa1 | ||
|
|
a792f84a83 | ||
|
|
cd9d96766c | ||
|
|
14564b25d6 | ||
|
|
0637b5b912 | ||
|
|
20bf48b693 | ||
|
|
5b3270be2d | ||
|
|
ae43744052 | ||
|
|
b5d7e428d1 | ||
|
|
d65ea313e8 | ||
|
|
a09ecadba6 | ||
|
|
358166feb2 | ||
|
|
85e2b73eb4 | ||
|
|
c18475ddc2 | ||
|
|
06fcf54475 | ||
|
|
f751f8ab37 | ||
|
|
523c6d03c1 | ||
|
|
0e0f043e59 | ||
|
|
91c691d526 | ||
|
|
c6092291ce | ||
|
|
a2c55cfdef | ||
|
|
76cad626ed | ||
|
|
7c23993344 | ||
|
|
b669715416 | ||
|
|
7292122b72 | ||
|
|
992ae15c78 | ||
|
|
f2b4772ac2 | ||
|
|
9b9b1291fc | ||
|
|
6171395ef9 | ||
|
|
d270476d6c | ||
|
|
f1f7dca009 | ||
|
|
45f572f268 | ||
|
|
4b124d5906 | ||
|
|
988d4aa679 | ||
|
|
b452fe273c | ||
|
|
9544b37c8a | ||
|
|
0491357fef | ||
|
|
fedd517a71 | ||
|
|
9cbed8802f | ||
|
|
c2e1babd76 | ||
|
|
cc8b677f3e | ||
|
|
78e3f82de1 | ||
|
|
20ca2cd8b9 | ||
|
|
ea0fcd6002 | ||
|
|
6bcebd4b9d | ||
|
|
93e9db3206 | ||
|
|
caf34d83bd | ||
|
|
49d3cd0863 | ||
|
|
34989f8e96 | ||
|
|
9274664302 | ||
|
|
437f0a0154 | ||
|
|
9d79bf5fff | ||
|
|
4c62b1d428 | ||
|
|
b2a4b4ed90 | ||
|
|
9262babc3b | ||
|
|
1c80ded753 | ||
|
|
4de8c4d6b1 | ||
|
|
91f2254039 | ||
|
|
66fd156c65 | ||
|
|
4ec16f3c2e | ||
|
|
628003abef | ||
|
|
07e400b73d | ||
|
|
7e14a512e0 | ||
|
|
d7e8f843ad | ||
|
|
e69ae81ad2 | ||
|
|
03c5db32e6 | ||
|
|
5e5bf23f9c | ||
|
|
e0fcd7a61e | ||
|
|
e9989d1085 | ||
|
|
49c515b252 | ||
|
|
2d05578c21 | ||
|
|
d05a6f30e1 | ||
|
|
10c81c39fb | ||
|
|
2d599349ef | ||
|
|
33caf5c6ca | ||
|
|
a9850766a7 | ||
|
|
77e2416def | ||
|
|
02af9865ec | ||
|
|
75ca2aa6b1 | ||
|
|
d820661592 | ||
|
|
1ff351a4f1 | ||
|
|
78b8e58561 | ||
|
|
fddbfce51a | ||
|
|
20d3766451 | ||
|
|
72b5e18898 | ||
|
|
03b8b8c19a | ||
|
|
7c2f1b075e | ||
|
|
883da1b28c | ||
|
|
bb98d94b35 | ||
|
|
d114c45135 | ||
|
|
36e092e0ac | ||
|
|
e2bb69908a | ||
|
|
cd33c5eac7 | ||
|
|
0f8a139fb5 | ||
|
|
ced4ee3038 | ||
|
|
cc19dac939 | ||
|
|
4c7c73a6f2 | ||
|
|
0493fea9fc | ||
|
|
1c2db9f468 | ||
|
|
c210230802 | ||
|
|
9b12989a36 | ||
|
|
f1bcd72cd8 | ||
|
|
a5c57fbd3a | ||
|
|
513f7ab7e7 | ||
|
|
53c0c5a07b | ||
|
|
d924e7cea5 | ||
|
|
7910a90522 | ||
|
|
35d49f6941 | ||
|
|
e359a4affa | ||
|
|
159f79f9d8 | ||
|
|
827c19ccd9 | ||
|
|
588b9f34be | ||
|
|
fb02fefaca | ||
|
|
856d5ff976 | ||
|
|
eb4aeb3922 | ||
|
|
4b47e5215b | ||
|
|
0087082643 | ||
|
|
e698a393b2 | ||
|
|
d48e2a4cf1 | ||
|
|
749a903de5 | ||
|
|
0a6321246a | ||
|
|
ddda30d9b7 | ||
|
|
d1851cc3ee | ||
|
|
883bf5847b | ||
|
|
1c8ab4d835 | ||
|
|
255e209886 | ||
|
|
c8904e4672 | ||
|
|
dcfc2da428 | ||
|
|
84e28234e5 | ||
|
|
60e8b5841c | ||
|
|
dd03d9adce | ||
|
|
9fa211bc27 | ||
|
|
22cf5144cc | ||
|
|
99e493b3a4 | ||
|
|
e4d92d6f56 | ||
|
|
a9d08852db | ||
|
|
408ad1ff2b | ||
|
|
69d4a8df7c | ||
|
|
02f92164de | ||
|
|
1549927fa3 | ||
|
|
e951da7a25 | ||
|
|
f830d5814c | ||
|
|
0519e9e3c2 | ||
|
|
9b8a628395 | ||
|
|
288bcd254e | ||
|
|
c71ef11a25 | ||
|
|
0ab9d97f2d | ||
|
|
b326433330 | ||
|
|
a5931177fd | ||
|
|
aa17460cc5 | ||
|
|
8bf197df31 | ||
|
|
f74243542d | ||
|
|
a4ebb5bf85 | ||
|
|
cc1aadaba5 | ||
|
|
8bceee9e42 | ||
|
|
e8fe9ae67e | ||
|
|
06c68082bb | ||
|
|
6cfaad86ea | ||
|
|
a899f80ee9 | ||
|
|
292217b8b4 | ||
|
|
a828318494 | ||
|
|
47515ea876 | ||
|
|
860f02ff49 | ||
|
|
f5fa076fdd | ||
|
|
d3043ec898 | ||
|
|
b3baea2421 | ||
|
|
9e625ec6c5 | ||
|
|
d7c49a0656 | ||
|
|
34bf6a6402 | ||
|
|
5deb47aacc | ||
|
|
d7f651a06c | ||
|
|
5b3921586f | ||
|
|
ac462fae06 | ||
|
|
4fb073d1ea | ||
|
|
226c8dc947 | ||
|
|
19b589f381 | ||
|
|
05f9cc1bb5 | ||
|
|
6b2ece35da | ||
|
|
75b3270cf0 | ||
|
|
40dd175a0f | ||
|
|
0536a53833 | ||
|
|
9096938d4a | ||
|
|
f14a0ea011 | ||
|
|
5524fe1408 | ||
|
|
6851215410 | ||
|
|
b91acbb14a | ||
|
|
0045d46d9d | ||
|
|
a2e9e23569 | ||
|
|
8e61f8e688 | ||
|
|
b4bc08e70c | ||
|
|
242664f81b | ||
|
|
4a2045ecca | ||
|
|
89bfbfad59 | ||
|
|
7488d1d0cb | ||
|
|
9adfcede31 | ||
|
|
abaf0da9fe | ||
|
|
648c8ffb21 | ||
|
|
6ae2984580 | ||
|
|
f12bf985ce | ||
|
|
b6321488bc | ||
|
|
54236f9617 | ||
|
|
2c4496b129 | ||
|
|
4b177992f8 | ||
|
|
fa61e862e0 | ||
|
|
6d90e80c51 | ||
|
|
f3ea6034b1 | ||
|
|
7fdf61018b | ||
|
|
aab818716e | ||
|
|
ac8b5e7934 | ||
|
|
23505576a6 | ||
|
|
d69e4feb1b | ||
|
|
faf0b93299 | ||
|
|
0356df8c6b | ||
|
|
2d66939b42 | ||
|
|
a0c79f7388 | ||
|
|
a44cdae36e | ||
|
|
7aa7eb2399 | ||
|
|
42712a44d8 | ||
|
|
76c992e2df | ||
|
|
26b420a01d | ||
|
|
e707be429e | ||
|
|
24773e15c5 | ||
|
|
5dba964281 | ||
|
|
1596a6cc62 | ||
|
|
0df87bfacc | ||
|
|
8e9eb7d07d | ||
|
|
60196d2eca | ||
|
|
b9af0188fe | ||
|
|
9850f1767a | ||
|
|
c5491e87aa | ||
|
|
400afeb70e | ||
|
|
c63d52d5e6 | ||
|
|
1230b229b5 | ||
|
|
72d5f1fe53 | ||
|
|
e3a5df514e | ||
|
|
aaf65ebf0f | ||
|
|
844d84d7bb | ||
|
|
5a3eca2a2a | ||
|
|
efcf30a23d | ||
|
|
951cb1c880 | ||
|
|
78b67bc9d9 | ||
|
|
500e09f12b | ||
|
|
2a5e17d548 | ||
|
|
6541eab43b | ||
|
|
2e72ef151e | ||
|
|
032eb152bf | ||
|
|
63ebd9e338 | ||
|
|
1064939013 | ||
|
|
ff6312ab02 | ||
|
|
036fa5dccf | ||
|
|
86c6feafcc | ||
|
|
0efe4feb2a | ||
|
|
8b473397d1 | ||
|
|
23e775b1e0 | ||
|
|
f7d3516dec | ||
|
|
de05ea898e | ||
|
|
94cb91947d | ||
|
|
b1470a1ac4 | ||
|
|
2518901e6e | ||
|
|
e639283ac9 | ||
|
|
28cc04908c | ||
|
|
1a3354404e | ||
|
|
80279f9d36 | ||
|
|
0b3d15a4d7 | ||
|
|
8b68d086f0 | ||
|
|
0f143a43c9 | ||
|
|
e61e4d57d9 | ||
|
|
4e86bdf3d9 | ||
|
|
3cef499b81 | ||
|
|
e2a0884ecd | ||
|
|
2849974729 | ||
|
|
daa4af18d1 | ||
|
|
1ec1076fee | ||
|
|
65bd4be607 | ||
|
|
306188817f | ||
|
|
99aa9bef70 | ||
|
|
9e975ba566 | ||
|
|
782e143c22 | ||
|
|
e0a3b4b822 | ||
|
|
b53a5e7528 | ||
|
|
8dda45bf99 | ||
|
|
0a0ed3f606 | ||
|
|
01e0e29a9f | ||
|
|
e57305ee0c | ||
|
|
3c43d3d154 | ||
|
|
fd7c2780f5 | ||
|
|
6f9ced1c23 | ||
|
|
e255aa95fe | ||
|
|
f2a742130d | ||
|
|
d343e4ed9a | ||
|
|
0fec237ead | ||
|
|
4c103761f9 | ||
|
|
a03ad1079c | ||
|
|
7d0e2265f7 | ||
|
|
8532c94d8e | ||
|
|
838e3d5ae4 | ||
|
|
3bc52cad7b | ||
|
|
ce26f1c6d3 | ||
|
|
37188c7606 | ||
|
|
d9926d2491 | ||
|
|
41efa100f0 | ||
|
|
6f204fd557 | ||
|
|
9bd1992738 | ||
|
|
3856a896ea | ||
|
|
b0030d3a2b | ||
|
|
d76477099c | ||
|
|
3e3b2aaa5c | ||
|
|
1f8aa93843 | ||
|
|
34920ea04e | ||
|
|
f5aeb47a72 | ||
|
|
c830177207 | ||
|
|
e4ccd4057d | ||
|
|
c3d60b31d1 | ||
|
|
35b70ca915 | ||
|
|
a8d65c11e0 | ||
|
|
a4746a53d8 | ||
|
|
13bb474623 | ||
|
|
09aa62f1c3 | ||
|
|
cbc26a5e40 | ||
|
|
6824d14ed8 | ||
|
|
d9e40f721c | ||
|
|
8a73184801 | ||
|
|
06e8c4dad4 | ||
|
|
e2521743b6 | ||
|
|
f2a54f4e23 | ||
|
|
a594595fea | ||
|
|
0620679d11 | ||
|
|
78708efbf1 | ||
|
|
cf06f20a0e | ||
|
|
c68fba01a8 | ||
|
|
f2c7f8a6da | ||
|
|
259140ffc9 | ||
|
|
3150af1ad7 | ||
|
|
dde90fc636 | ||
|
|
83458f5146 | ||
|
|
f1149defc9 | ||
|
|
507afd7f06 | ||
|
|
1a755c3fdb | ||
|
|
41c8c9230b | ||
|
|
9b9e728cf6 | ||
|
|
a4b836b5f9 | ||
|
|
a4d632498c | ||
|
|
4f017081fc | ||
|
|
51fb1fae88 | ||
|
|
106b230fea | ||
|
|
9b262dd057 | ||
|
|
8074b261d3 | ||
|
|
999a59f938 | ||
|
|
fbba57d3b5 | ||
|
|
3f6c8a2338 | ||
|
|
dd09d46ccb | ||
|
|
8897b45eeb | ||
|
|
30109e8f20 |
5
.github/ISSUE_TEMPLATE/bug_template.yml
vendored
5
.github/ISSUE_TEMPLATE/bug_template.yml
vendored
@@ -5,11 +5,12 @@ labels: ['bug']
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: Thank you for taking the time to fill out this bug report. Please provide as much information as possible to help us understand and address the issue effectively.
|
||||
value: Thank you for taking the time to fill out this bug report. Please provide as much information as possible
|
||||
to help us understand and address the issue effectively.
|
||||
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Is there an existing issue for the same bug?
|
||||
label: Is there an existing issue for the same bug? (If one exists, thumbs up or comment on the issue instead).
|
||||
description: Please check if an issue already exists for the bug you encountered.
|
||||
options:
|
||||
- label: I have checked the existing issues.
|
||||
|
||||
13
.github/ISSUE_TEMPLATE/feature_request.md
vendored
13
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest an idea for OpenHands features
|
||||
name: Feature Request or Enhancement
|
||||
about: Suggest an idea for an OpenHands feature or enhancement
|
||||
title: ''
|
||||
labels: 'enhancement'
|
||||
assignees: ''
|
||||
@@ -9,10 +9,9 @@ assignees: ''
|
||||
|
||||
**What problem or use case are you trying to solve?**
|
||||
|
||||
**Describe the UX of the solution you'd like**
|
||||
|
||||
**Do you have thoughts on the technical implementation?**
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
**Describe the UX or technical implementation you have in mind**
|
||||
|
||||
**Additional context**
|
||||
|
||||
|
||||
### If you find this feature request or enhancement useful, make sure to add a 👍 to the issue
|
||||
|
||||
18
.github/ISSUE_TEMPLATE/technical_proposal.md
vendored
18
.github/ISSUE_TEMPLATE/technical_proposal.md
vendored
@@ -1,18 +0,0 @@
|
||||
---
|
||||
name: Technical Proposal
|
||||
about: Propose a new architecture or technology
|
||||
title: ''
|
||||
labels: 'proposal'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Summary**
|
||||
|
||||
**Motivation**
|
||||
|
||||
**Technical Design**
|
||||
|
||||
**Alternatives to Consider**
|
||||
|
||||
**Additional context**
|
||||
16
.github/scripts/check_version_consistency.py
vendored
16
.github/scripts/check_version_consistency.py
vendored
@@ -13,8 +13,8 @@ def find_version_references(directory: str) -> Tuple[Set[str], Set[str]]:
|
||||
version_pattern_runtime = re.compile(r'runtime:(\d{1})\.(\d{2})')
|
||||
|
||||
for root, _, files in os.walk(directory):
|
||||
# Skip .git directory
|
||||
if '.git' in root:
|
||||
# Skip .git directory and docs/build directory
|
||||
if '.git' in root or 'docs/build' in root:
|
||||
continue
|
||||
|
||||
for file in files:
|
||||
@@ -28,11 +28,15 @@ def find_version_references(directory: str) -> Tuple[Set[str], Set[str]]:
|
||||
|
||||
# Find all openhands version references
|
||||
matches = version_pattern_openhands.findall(content)
|
||||
openhands_versions.update(matches)
|
||||
if matches:
|
||||
print(f'Found openhands version {matches} in {file_path}')
|
||||
openhands_versions.update(matches)
|
||||
|
||||
# Find all runtime version references
|
||||
matches = version_pattern_runtime.findall(content)
|
||||
runtime_versions.update(matches)
|
||||
if matches:
|
||||
print(f'Found runtime version {matches} in {file_path}')
|
||||
runtime_versions.update(matches)
|
||||
except Exception as e:
|
||||
print(f'Error reading {file_path}: {e}', file=sys.stderr)
|
||||
|
||||
@@ -41,8 +45,12 @@ def find_version_references(directory: str) -> Tuple[Set[str], Set[str]]:
|
||||
|
||||
def main():
|
||||
repo_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))
|
||||
print(f'Checking version consistency in {repo_root}')
|
||||
openhands_versions, runtime_versions = find_version_references(repo_root)
|
||||
|
||||
print(f'Found openhands versions: {sorted(openhands_versions)}')
|
||||
print(f'Found runtime versions: {sorted(runtime_versions)}')
|
||||
|
||||
exit_code = 0
|
||||
|
||||
if len(openhands_versions) > 1:
|
||||
|
||||
2
.github/workflows/clean-up.yml
vendored
2
.github/workflows/clean-up.yml
vendored
@@ -46,7 +46,7 @@ on:
|
||||
|
||||
jobs:
|
||||
del_runs:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
permissions:
|
||||
actions: write
|
||||
contents: read
|
||||
|
||||
10
.github/workflows/deploy-docs.yml
vendored
10
.github/workflows/deploy-docs.yml
vendored
@@ -24,22 +24,20 @@ jobs:
|
||||
build:
|
||||
if: github.repository == 'All-Hands-AI/OpenHands'
|
||||
name: Build Docusaurus
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- uses: actions/setup-node@v4
|
||||
- uses: useblacksmith/setup-node@v5
|
||||
with:
|
||||
node-version: 18
|
||||
cache: npm
|
||||
cache-dependency-path: docs/package-lock.json
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: '3.12'
|
||||
- name: Generate Python Docs
|
||||
run: rm -rf docs/modules/python && pip install pydoc-markdown && pydoc-markdown
|
||||
- name: Install dependencies
|
||||
run: cd docs && npm ci
|
||||
- name: Build website
|
||||
@@ -54,7 +52,7 @@ jobs:
|
||||
deploy:
|
||||
if: github.ref == 'refs/heads/main' && github.repository == 'All-Hands-AI/OpenHands'
|
||||
name: Deploy to GitHub Pages
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
# This job only runs on "main" so only run one of these jobs at a time
|
||||
# otherwise it will fail if one is already running
|
||||
concurrency:
|
||||
|
||||
53
.github/workflows/dummy-agent-test.yml
vendored
53
.github/workflows/dummy-agent-test.yml
vendored
@@ -1,53 +0,0 @@
|
||||
# Workflow that uses the DummyAgent to run a simple task
|
||||
name: Run E2E test with dummy agent
|
||||
|
||||
# Always run on "main"
|
||||
# Always run on PRs
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
|
||||
# If triggered by a PR, it will be in the same group. However, each commit on main will be in its own unique group
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ (github.head_ref && github.ref) || github.run_id }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Set up Docker Buildx
|
||||
id: buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
- name: Install tmux
|
||||
run: sudo apt-get update && sudo apt-get install -y tmux
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '22.x'
|
||||
- name: Install poetry via pipx
|
||||
run: pipx install poetry
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.12'
|
||||
cache: 'poetry'
|
||||
- name: Install Python dependencies using Poetry
|
||||
run: poetry install --without evaluation
|
||||
- name: Build Environment
|
||||
run: make build
|
||||
- name: Run tests
|
||||
run: |
|
||||
set -e
|
||||
SANDBOX_FORCE_REBUILD_RUNTIME=True poetry run python3 openhands/core/main.py -t "do a flip" -d ./workspace/ -c DummyAgent
|
||||
- name: Check exit code
|
||||
run: |
|
||||
if [ $? -ne 0 ]; then
|
||||
echo "Test failed"
|
||||
exit 1
|
||||
else
|
||||
echo "Test passed"
|
||||
fi
|
||||
139
.github/workflows/eval-runner.yml
vendored
139
.github/workflows/eval-runner.yml
vendored
@@ -1,139 +0,0 @@
|
||||
name: Run SWE-Bench Evaluation
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [labeled]
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
reason:
|
||||
description: "Reason for manual trigger"
|
||||
required: true
|
||||
default: ""
|
||||
|
||||
env:
|
||||
N_PROCESSES: 32 # Global configuration for number of parallel processes for evaluation
|
||||
|
||||
jobs:
|
||||
run-evaluation:
|
||||
if: github.event.label.name == 'eval-this' || github.event_name != 'pull_request'
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: "read"
|
||||
id-token: "write"
|
||||
pull-requests: "write"
|
||||
issues: "write"
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: ["3.12"]
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install tmux
|
||||
run: sudo apt-get update && sudo apt-get install -y tmux
|
||||
- name: Install poetry via pipx
|
||||
run: pipx install poetry
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
cache: "poetry"
|
||||
|
||||
- name: Comment on PR if 'eval-this' label is present
|
||||
if: github.event_name == 'pull_request' && github.event.label.name == 'eval-this'
|
||||
uses: KeisukeYamashita/create-comment@v1
|
||||
with:
|
||||
unique: false
|
||||
comment: |
|
||||
Hi! I started running the evaluation on your PR. You will receive a comment with the results shortly.
|
||||
|
||||
- name: Install Python dependencies using Poetry
|
||||
run: poetry install
|
||||
|
||||
- name: Configure config.toml for evaluation
|
||||
env:
|
||||
DEEPSEEK_API_KEY: ${{ secrets.DEEPSEEK_LLM_API_KEY }}
|
||||
run: |
|
||||
echo "[llm.eval]" > config.toml
|
||||
echo "model = \"deepseek/deepseek-chat\"" >> config.toml
|
||||
echo "api_key = \"$DEEPSEEK_API_KEY\"" >> config.toml
|
||||
echo "temperature = 0.0" >> config.toml
|
||||
|
||||
- name: Run SWE-Bench evaluation
|
||||
env:
|
||||
ALLHANDS_API_KEY: ${{ secrets.ALLHANDS_EVAL_RUNTIME_API_KEY }}
|
||||
RUNTIME: remote
|
||||
SANDBOX_REMOTE_RUNTIME_API_URL: https://runtime.eval.all-hands.dev
|
||||
EVAL_DOCKER_IMAGE_PREFIX: us-central1-docker.pkg.dev/evaluation-092424/swe-bench-images
|
||||
|
||||
run: |
|
||||
poetry run ./evaluation/benchmarks/swe_bench/scripts/run_infer.sh llm.eval HEAD CodeActAgent 300 30 $N_PROCESSES "princeton-nlp/SWE-bench_Lite" test
|
||||
OUTPUT_FOLDER=$(find evaluation/evaluation_outputs/outputs/princeton-nlp__SWE-bench_Lite-test/CodeActAgent -name "deepseek-chat_maxiter_50_N_*-no-hint-run_1" -type d | head -n 1)
|
||||
echo "OUTPUT_FOLDER for SWE-bench evaluation: $OUTPUT_FOLDER"
|
||||
poetry run ./evaluation/benchmarks/swe_bench/scripts/eval_infer_remote.sh $OUTPUT_FOLDER/output.jsonl $N_PROCESSES "princeton-nlp/SWE-bench_Lite" test
|
||||
|
||||
poetry run ./evaluation/benchmarks/swe_bench/scripts/eval/summarize_outputs.py $OUTPUT_FOLDER/output.jsonl > summarize_outputs.log 2>&1
|
||||
echo "SWEBENCH_REPORT<<EOF" >> $GITHUB_ENV
|
||||
cat summarize_outputs.log >> $GITHUB_ENV
|
||||
echo "EOF" >> $GITHUB_ENV
|
||||
|
||||
- name: Create tar.gz of evaluation outputs
|
||||
run: |
|
||||
TIMESTAMP=$(date +'%y-%m-%d-%H-%M')
|
||||
tar -czvf evaluation_outputs_${TIMESTAMP}.tar.gz evaluation/evaluation_outputs/outputs
|
||||
|
||||
- name: Upload evaluation results as artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
id: upload_results_artifact
|
||||
with:
|
||||
name: evaluation-outputs
|
||||
path: evaluation_outputs_*.tar.gz
|
||||
|
||||
- name: Get artifact URL
|
||||
run: echo "ARTIFACT_URL=${{ steps.upload_results_artifact.outputs.artifact-url }}" >> $GITHUB_ENV
|
||||
|
||||
- name: Authenticate to Google Cloud
|
||||
uses: 'google-github-actions/auth@v2'
|
||||
with:
|
||||
credentials_json: ${{ secrets.GCP_RESEARCH_OBJECT_CREATOR_SA_KEY }}
|
||||
|
||||
- name: Set timestamp and trigger reason
|
||||
run: |
|
||||
echo "TIMESTAMP=$(date +'%Y-%m-%d-%H-%M')" >> $GITHUB_ENV
|
||||
if [[ "${{ github.event_name }}" == "pull_request" ]]; then
|
||||
echo "TRIGGER_REASON=pr-${{ github.event.pull_request.number }}" >> $GITHUB_ENV
|
||||
elif [[ "${{ github.event_name }}" == "schedule" ]]; then
|
||||
echo "TRIGGER_REASON=schedule" >> $GITHUB_ENV
|
||||
else
|
||||
echo "TRIGGER_REASON=manual-${{ github.event.inputs.reason }}" >> $GITHUB_ENV
|
||||
fi
|
||||
|
||||
- name: Upload evaluation results to Google Cloud Storage
|
||||
uses: 'google-github-actions/upload-cloud-storage@v2'
|
||||
with:
|
||||
path: 'evaluation/evaluation_outputs/outputs'
|
||||
destination: 'openhands-oss-eval-results/${{ env.TIMESTAMP }}-${{ env.TRIGGER_REASON }}'
|
||||
|
||||
- name: Comment with evaluation results and artifact link
|
||||
id: create_comment
|
||||
uses: KeisukeYamashita/create-comment@v1
|
||||
with:
|
||||
number: ${{ github.event_name == 'pull_request' && github.event.pull_request.number || 4504 }}
|
||||
unique: false
|
||||
comment: |
|
||||
Trigger by: ${{ github.event_name == 'pull_request' && format('Pull Request (eval-this label on PR #{0})', github.event.pull_request.number) || github.event_name == 'schedule' && 'Daily Schedule' || format('Manual Trigger: {0}', github.event.inputs.reason) }}
|
||||
Commit: ${{ github.sha }}
|
||||
**SWE-Bench Evaluation Report**
|
||||
${{ env.SWEBENCH_REPORT }}
|
||||
---
|
||||
You can download the full evaluation outputs [here](${{ env.ARTIFACT_URL }}).
|
||||
|
||||
- name: Post to a Slack channel
|
||||
id: slack
|
||||
uses: slackapi/slack-github-action@v2.0.0
|
||||
with:
|
||||
channel-id: 'C07SVQSCR6F'
|
||||
slack-message: "*Evaluation Trigger:* ${{ github.event_name == 'pull_request' && format('Pull Request (eval-this label on PR #{0})', github.event.pull_request.number) || github.event_name == 'schedule' && 'Daily Schedule' || format('Manual Trigger: {0}', github.event.inputs.reason) }}\n\nLink to summary: [here](https://github.com/${{ github.repository }}/issues/${{ github.event_name == 'pull_request' && github.event.pull_request.number || 4504 }}#issuecomment-${{ steps.create_comment.outputs.comment-id }})"
|
||||
env:
|
||||
SLACK_BOT_TOKEN: ${{ secrets.EVAL_NOTIF_SLACK_BOT_TOKEN }}
|
||||
4
.github/workflows/fe-unit-tests.yml
vendored
4
.github/workflows/fe-unit-tests.yml
vendored
@@ -21,7 +21,7 @@ jobs:
|
||||
# Run frontend unit tests
|
||||
fe-test:
|
||||
name: FE Unit Tests
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [20, 22]
|
||||
@@ -30,7 +30,7 @@ jobs:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v4
|
||||
uses: useblacksmith/setup-node@v5
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- name: Install dependencies
|
||||
|
||||
174
.github/workflows/ghcr-build.yml
vendored
174
.github/workflows/ghcr-build.yml
vendored
@@ -25,18 +25,40 @@ concurrency:
|
||||
cancel-in-progress: true
|
||||
|
||||
env:
|
||||
BASE_IMAGE_FOR_HASH_EQUIVALENCE_TEST: nikolaik/python-nodejs:python3.12-nodejs22
|
||||
RELEVANT_SHA: ${{ github.event.pull_request.head.sha || github.sha }}
|
||||
|
||||
jobs:
|
||||
define-matrix:
|
||||
runs-on: blacksmith
|
||||
outputs:
|
||||
base_image: ${{ steps.define-base-images.outputs.base_image }}
|
||||
steps:
|
||||
- name: Define base images
|
||||
shell: bash
|
||||
id: define-base-images
|
||||
run: |
|
||||
# Only build nikolaik on PRs, otherwise build both nikolaik and ubuntu.
|
||||
if [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then
|
||||
json=$(jq -n -c '[
|
||||
{ image: "nikolaik/python-nodejs:python3.12-nodejs22", tag: "nikolaik" }
|
||||
]')
|
||||
else
|
||||
json=$(jq -n -c '[
|
||||
{ image: "nikolaik/python-nodejs:python3.12-nodejs22", tag: "nikolaik" },
|
||||
{ image: "ubuntu:24.04", tag: "ubuntu" }
|
||||
]')
|
||||
fi
|
||||
echo "base_image=$json" >> "$GITHUB_OUTPUT"
|
||||
|
||||
# Builds the OpenHands Docker images
|
||||
ghcr_build_app:
|
||||
name: Build App Image
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
outputs:
|
||||
# Since this job uses outputs it cannot use matrix
|
||||
hash_from_app_image: ${{ steps.get_hash_in_app_image.outputs.hash_from_app_image }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
@@ -80,15 +102,14 @@ jobs:
|
||||
# Builds the runtime Docker images
|
||||
ghcr_build_runtime:
|
||||
name: Build Image
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
needs: define-matrix
|
||||
strategy:
|
||||
matrix:
|
||||
base_image:
|
||||
- image: 'nikolaik/python-nodejs:python3.12-nodejs22'
|
||||
tag: nikolaik
|
||||
base_image: ${{ fromJson(needs.define-matrix.outputs.base_image) }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
@@ -108,75 +129,97 @@ jobs:
|
||||
id: buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: '3.12'
|
||||
- name: Cache Poetry dependencies
|
||||
uses: actions/cache@v4
|
||||
uses: useblacksmith/cache@v5
|
||||
with:
|
||||
path: |
|
||||
~/.cache/pypoetry
|
||||
~/.virtualenvs
|
||||
key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
|
||||
# This is the one that saves the cache, the others set 'lookup-only: true'
|
||||
restore-keys: |
|
||||
${{ runner.os }}-poetry-
|
||||
- name: Install poetry via pipx
|
||||
run: pipx install poetry
|
||||
- name: Install Python dependencies using Poetry
|
||||
run: make install-python-dependencies
|
||||
run: make install-python-dependencies POETRY_GROUP=main INSTALL_PLAYWRIGHT=0
|
||||
- name: Create source distribution and Dockerfile
|
||||
run: poetry run python3 openhands/runtime/utils/runtime_build.py --base_image ${{ matrix.base_image.image }} --build_folder containers/runtime --force_rebuild
|
||||
- name: Lowercase Repository Owner
|
||||
run: |
|
||||
echo REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]') >> $GITHUB_ENV
|
||||
- name: Short SHA
|
||||
run: |
|
||||
echo SHORT_SHA=$(git rev-parse --short "$RELEVANT_SHA") >> $GITHUB_ENV
|
||||
- name: Determine docker build params
|
||||
if: github.event.pull_request.head.repo.fork != true
|
||||
shell: bash
|
||||
run: |
|
||||
./containers/build.sh -i runtime -o ${{ env.REPO_OWNER }} -t ${{ matrix.base_image.tag }} --dry
|
||||
|
||||
DOCKER_BUILD_JSON=$(jq -c . < docker-build-dry.json)
|
||||
echo "DOCKER_TAGS=$(echo "$DOCKER_BUILD_JSON" | jq -r '.tags | join(",")')" >> $GITHUB_ENV
|
||||
echo "DOCKER_PLATFORM=$(echo "$DOCKER_BUILD_JSON" | jq -r '.platform')" >> $GITHUB_ENV
|
||||
echo "DOCKER_BUILD_ARGS=$(echo "$DOCKER_BUILD_JSON" | jq -r '.build_args | join(",")')" >> $GITHUB_ENV
|
||||
- name: Build and push runtime image ${{ matrix.base_image.image }}
|
||||
if: github.event.pull_request.head.repo.fork != true
|
||||
run: |
|
||||
./containers/build.sh -i runtime -o ${{ env.REPO_OWNER }} --push -t ${{ matrix.base_image.tag }}
|
||||
# Forked repos can't push to GHCR, so we need to upload the image as an artifact
|
||||
uses: useblacksmith/build-push-action@v1
|
||||
with:
|
||||
push: true
|
||||
tags: ${{ env.DOCKER_TAGS }}
|
||||
platforms: ${{ env.DOCKER_PLATFORM }}
|
||||
build-args: ${{ env.DOCKER_BUILD_ARGS }}
|
||||
context: containers/runtime
|
||||
provenance: false
|
||||
# Forked repos can't push to GHCR, so we just build in order to populate the cache for rebuilding
|
||||
- name: Build runtime image ${{ matrix.base_image.image }} for fork
|
||||
if: github.event.pull_request.head.repo.fork
|
||||
uses: docker/build-push-action@v6
|
||||
uses: useblacksmith/build-push-action@v1
|
||||
with:
|
||||
tags: ghcr.io/${{ env.REPO_OWNER }}/runtime:${{ env.RELEVANT_SHA }}-${{ matrix.base_image.tag }}
|
||||
outputs: type=docker,dest=/tmp/runtime-${{ matrix.base_image.tag }}.tar
|
||||
context: containers/runtime
|
||||
- name: Upload runtime image for fork
|
||||
- name: Upload runtime source for fork
|
||||
if: github.event.pull_request.head.repo.fork
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: runtime-${{ matrix.base_image.tag }}
|
||||
path: /tmp/runtime-${{ matrix.base_image.tag }}.tar
|
||||
name: runtime-src-${{ matrix.base_image.tag }}
|
||||
path: containers/runtime
|
||||
|
||||
verify_hash_equivalence_in_runtime_and_app:
|
||||
name: Verify Hash Equivalence in Runtime and Docker images
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
needs: [ghcr_build_runtime, ghcr_build_app]
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
base_image: ['nikolaik']
|
||||
env:
|
||||
BASE_IMAGE_FOR_HASH_EQUIVALENCE_TEST: nikolaik/python-nodejs:python3.12-nodejs22
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.sha }}
|
||||
- name: Cache Poetry dependencies
|
||||
uses: actions/cache@v4
|
||||
uses: useblacksmith/cache@v5
|
||||
with:
|
||||
path: |
|
||||
~/.cache/pypoetry
|
||||
~/.virtualenvs
|
||||
key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
|
||||
lookup-only: true
|
||||
restore-keys: |
|
||||
${{ runner.os }}-poetry-
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: '3.12'
|
||||
- name: Install poetry via pipx
|
||||
run: pipx install poetry
|
||||
- name: Install Python dependencies using Poetry
|
||||
run: make install-python-dependencies
|
||||
run: make install-python-dependencies POETRY_GROUP=main INSTALL_PLAYWRIGHT=0
|
||||
- name: Get hash in App Image
|
||||
run: |
|
||||
echo "Hash from app image: ${{ needs.ghcr_build_app.outputs.hash_from_app_image }}"
|
||||
@@ -203,48 +246,52 @@ jobs:
|
||||
# Run unit tests with the Docker runtime Docker images as root
|
||||
test_runtime_root:
|
||||
name: RT Unit Tests (Root)
|
||||
needs: [ghcr_build_runtime]
|
||||
runs-on: ubuntu-latest
|
||||
needs: [ghcr_build_runtime, define-matrix]
|
||||
runs-on: blacksmith-8vcpu-ubuntu-2204
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
base_image: ['nikolaik']
|
||||
base_image: ${{ fromJson(needs.define-matrix.outputs.base_image) }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Set up Docker Buildx
|
||||
id: buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
# Forked repos can't push to GHCR, so we need to download the image as an artifact
|
||||
- name: Download runtime image for fork
|
||||
- name: Download runtime source for fork
|
||||
if: github.event.pull_request.head.repo.fork
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: runtime-${{ matrix.base_image }}
|
||||
path: /tmp
|
||||
- name: Load runtime image for fork
|
||||
if: github.event.pull_request.head.repo.fork
|
||||
name: runtime-src-${{ matrix.base_image.tag }}
|
||||
path: containers/runtime
|
||||
- name: Lowercase Repository Owner
|
||||
run: |
|
||||
docker load --input /tmp/runtime-${{ matrix.base_image }}.tar
|
||||
echo REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]') >> $GITHUB_ENV
|
||||
# Forked repos can't push to GHCR, so we need to rebuild using cache
|
||||
- name: Build runtime image ${{ matrix.base_image.image }} for fork
|
||||
if: github.event.pull_request.head.repo.fork
|
||||
uses: useblacksmith/build-push-action@v1
|
||||
with:
|
||||
load: true
|
||||
tags: ghcr.io/${{ env.REPO_OWNER }}/runtime:${{ env.RELEVANT_SHA }}-${{ matrix.base_image.tag }}
|
||||
context: containers/runtime
|
||||
- name: Cache Poetry dependencies
|
||||
uses: actions/cache@v4
|
||||
uses: useblacksmith/cache@v5
|
||||
with:
|
||||
path: |
|
||||
~/.cache/pypoetry
|
||||
~/.virtualenvs
|
||||
key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
|
||||
lookup-only: true
|
||||
restore-keys: |
|
||||
${{ runner.os }}-poetry-
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: '3.12'
|
||||
- name: Install poetry via pipx
|
||||
run: pipx install poetry
|
||||
- name: Install Python dependencies using Poetry
|
||||
run: make install-python-dependencies
|
||||
- name: Lowercase Repository Owner
|
||||
run: |
|
||||
echo REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]') >> $GITHUB_ENV
|
||||
run: make install-python-dependencies POETRY_GROUP=main,test,runtime INSTALL_PLAYWRIGHT=0
|
||||
- name: Run docker runtime tests
|
||||
run: |
|
||||
# We install pytest-xdist in order to run tests across CPUs
|
||||
@@ -253,14 +300,17 @@ jobs:
|
||||
# Install to be able to retry on failures for flaky tests
|
||||
poetry run pip install pytest-rerunfailures
|
||||
|
||||
image_name=ghcr.io/${{ env.REPO_OWNER }}/runtime:${{ env.RELEVANT_SHA }}-${{ matrix.base_image }}
|
||||
image_name=ghcr.io/${{ env.REPO_OWNER }}/runtime:${{ env.RELEVANT_SHA }}-${{ matrix.base_image.tag }}
|
||||
|
||||
# Setting RUN_AS_OPENHANDS to false means use root.
|
||||
# That should mean SANDBOX_USER_ID is ignored but some tests do not check for RUN_AS_OPENHANDS.
|
||||
|
||||
TEST_RUNTIME=docker \
|
||||
SANDBOX_USER_ID=$(id -u) \
|
||||
SANDBOX_RUNTIME_CONTAINER_IMAGE=$image_name \
|
||||
TEST_IN_CI=true \
|
||||
RUN_AS_OPENHANDS=false \
|
||||
poetry run pytest -n 3 -raRs --reruns 2 --reruns-delay 5 --cov=openhands --cov-report=xml -s ./tests/runtime --ignore=tests/runtime/test_browsergym_envs.py
|
||||
poetry run pytest -n 7 -raRs --reruns 2 --reruns-delay 5 --cov=openhands --cov-report=xml -s ./tests/runtime --ignore=tests/runtime/test_browsergym_envs.py --durations=10
|
||||
- name: Upload coverage to Codecov
|
||||
uses: codecov/codecov-action@v5
|
||||
env:
|
||||
@@ -269,47 +319,51 @@ jobs:
|
||||
# Run unit tests with the Docker runtime Docker images as openhands user
|
||||
test_runtime_oh:
|
||||
name: RT Unit Tests (openhands)
|
||||
runs-on: ubuntu-latest
|
||||
needs: [ghcr_build_runtime]
|
||||
runs-on: blacksmith-8vcpu-ubuntu-2204
|
||||
needs: [ghcr_build_runtime, define-matrix]
|
||||
strategy:
|
||||
matrix:
|
||||
base_image: ['nikolaik']
|
||||
base_image: ${{ fromJson(needs.define-matrix.outputs.base_image) }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Set up Docker Buildx
|
||||
id: buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
# Forked repos can't push to GHCR, so we need to download the image as an artifact
|
||||
- name: Download runtime image for fork
|
||||
- name: Download runtime source for fork
|
||||
if: github.event.pull_request.head.repo.fork
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: runtime-${{ matrix.base_image }}
|
||||
path: /tmp
|
||||
- name: Load runtime image for fork
|
||||
if: github.event.pull_request.head.repo.fork
|
||||
name: runtime-src-${{ matrix.base_image.tag }}
|
||||
path: containers/runtime
|
||||
- name: Lowercase Repository Owner
|
||||
run: |
|
||||
docker load --input /tmp/runtime-${{ matrix.base_image }}.tar
|
||||
echo REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]') >> $GITHUB_ENV
|
||||
# Forked repos can't push to GHCR, so we need to rebuild using cache
|
||||
- name: Build runtime image ${{ matrix.base_image.image }} for fork
|
||||
if: github.event.pull_request.head.repo.fork
|
||||
uses: useblacksmith/build-push-action@v1
|
||||
with:
|
||||
load: true
|
||||
tags: ghcr.io/${{ env.REPO_OWNER }}/runtime:${{ env.RELEVANT_SHA }}-${{ matrix.base_image.tag }}
|
||||
context: containers/runtime
|
||||
- name: Cache Poetry dependencies
|
||||
uses: actions/cache@v4
|
||||
uses: useblacksmith/cache@v5
|
||||
with:
|
||||
path: |
|
||||
~/.cache/pypoetry
|
||||
~/.virtualenvs
|
||||
key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
|
||||
lookup-only: true
|
||||
restore-keys: |
|
||||
${{ runner.os }}-poetry-
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: '3.12'
|
||||
- name: Install poetry via pipx
|
||||
run: pipx install poetry
|
||||
- name: Install Python dependencies using Poetry
|
||||
run: make install-python-dependencies
|
||||
- name: Lowercase Repository Owner
|
||||
run: |
|
||||
echo REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]') >> $GITHUB_ENV
|
||||
run: make install-python-dependencies POETRY_GROUP=main,test,runtime INSTALL_PLAYWRIGHT=0
|
||||
- name: Run runtime tests
|
||||
run: |
|
||||
# We install pytest-xdist in order to run tests across CPUs
|
||||
@@ -318,14 +372,14 @@ jobs:
|
||||
# Install to be able to retry on failures for flaky tests
|
||||
poetry run pip install pytest-rerunfailures
|
||||
|
||||
image_name=ghcr.io/${{ env.REPO_OWNER }}/runtime:${{ env.RELEVANT_SHA }}-${{ matrix.base_image }}
|
||||
image_name=ghcr.io/${{ env.REPO_OWNER }}/runtime:${{ env.RELEVANT_SHA }}-${{ matrix.base_image.tag }}
|
||||
|
||||
TEST_RUNTIME=docker \
|
||||
SANDBOX_USER_ID=$(id -u) \
|
||||
SANDBOX_RUNTIME_CONTAINER_IMAGE=$image_name \
|
||||
TEST_IN_CI=true \
|
||||
RUN_AS_OPENHANDS=true \
|
||||
poetry run pytest -n 3 -raRs --reruns 2 --reruns-delay 5 --cov=openhands --cov-report=xml -s ./tests/runtime --ignore=tests/runtime/test_browsergym_envs.py
|
||||
poetry run pytest -n 7 -raRs --reruns 2 --reruns-delay 5 --cov=openhands --cov-report=xml -s ./tests/runtime --ignore=tests/runtime/test_browsergym_envs.py --durations=10
|
||||
- name: Upload coverage to Codecov
|
||||
uses: codecov/codecov-action@v5
|
||||
env:
|
||||
@@ -338,7 +392,7 @@ jobs:
|
||||
runtime_tests_check_success:
|
||||
name: All Runtime Tests Passed
|
||||
if: ${{ !cancelled() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') }}
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
needs: [test_runtime_root, test_runtime_oh, verify_hash_equivalence_in_runtime_and_app]
|
||||
steps:
|
||||
- name: All tests passed
|
||||
@@ -347,7 +401,7 @@ jobs:
|
||||
runtime_tests_check_fail:
|
||||
name: All Runtime Tests Passed
|
||||
if: ${{ cancelled() || contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') }}
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
needs: [test_runtime_root, test_runtime_oh, verify_hash_equivalence_in_runtime_and_app]
|
||||
steps:
|
||||
- name: Some tests failed
|
||||
@@ -358,7 +412,7 @@ jobs:
|
||||
name: Update PR Description
|
||||
if: github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork && github.actor != 'dependabot[bot]'
|
||||
needs: [ghcr_build_runtime]
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
6
.github/workflows/integration-runner.yml
vendored
6
.github/workflows/integration-runner.yml
vendored
@@ -18,7 +18,7 @@ env:
|
||||
jobs:
|
||||
run-integration-tests:
|
||||
if: github.event.label.name == 'integration-test' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule'
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
permissions:
|
||||
contents: "read"
|
||||
id-token: "write"
|
||||
@@ -35,13 +35,13 @@ jobs:
|
||||
run: pipx install poetry
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
cache: "poetry"
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
uses: useblacksmith/setup-node@v5
|
||||
with:
|
||||
node-version: '22.x'
|
||||
|
||||
|
||||
8
.github/workflows/lint-fix.yml
vendored
8
.github/workflows/lint-fix.yml
vendored
@@ -9,7 +9,7 @@ jobs:
|
||||
lint-fix-frontend:
|
||||
if: github.event.label.name == 'lint-fix'
|
||||
name: Fix frontend linting issues
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
@@ -22,7 +22,7 @@ jobs:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Install Node.js 20
|
||||
uses: actions/setup-node@v4
|
||||
uses: useblacksmith/setup-node@v5
|
||||
with:
|
||||
node-version: 20
|
||||
- name: Install frontend dependencies
|
||||
@@ -52,7 +52,7 @@ jobs:
|
||||
lint-fix-python:
|
||||
if: github.event.label.name == 'lint-fix'
|
||||
name: Fix Python linting issues
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
@@ -65,7 +65,7 @@ jobs:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Set up python
|
||||
uses: actions/setup-python@v5
|
||||
uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: 3.12
|
||||
cache: 'pip'
|
||||
|
||||
12
.github/workflows/lint.yml
vendored
12
.github/workflows/lint.yml
vendored
@@ -19,11 +19,11 @@ jobs:
|
||||
# Run lint on the frontend code
|
||||
lint-frontend:
|
||||
name: Lint frontend
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Install Node.js 20
|
||||
uses: actions/setup-node@v4
|
||||
uses: useblacksmith/setup-node@v5
|
||||
with:
|
||||
node-version: 20
|
||||
- name: Install dependencies
|
||||
@@ -39,13 +39,13 @@ jobs:
|
||||
# Run lint on the python code
|
||||
lint-python:
|
||||
name: Lint python
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Set up python
|
||||
uses: actions/setup-python@v5
|
||||
uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: 3.12
|
||||
cache: 'pip'
|
||||
@@ -57,11 +57,11 @@ jobs:
|
||||
# Check version consistency across documentation
|
||||
check-version-consistency:
|
||||
name: Check version consistency
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Set up python
|
||||
uses: actions/setup-python@v5
|
||||
uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: 3.12
|
||||
- name: Run version consistency check
|
||||
|
||||
34
.github/workflows/openhands-resolver.yml
vendored
34
.github/workflows/openhands-resolver.yml
vendored
@@ -16,10 +16,15 @@ on:
|
||||
type: string
|
||||
default: "main"
|
||||
description: "Target branch to pull and create PR against"
|
||||
pr_type:
|
||||
required: false
|
||||
type: string
|
||||
default: "draft"
|
||||
description: "The PR type that is going to be created (draft, ready)"
|
||||
LLM_MODEL:
|
||||
required: false
|
||||
type: string
|
||||
default: "anthropic/claude-3-5-sonnet-20241022"
|
||||
default: "anthropic/claude-3-7-sonnet-20250219"
|
||||
LLM_API_VERSION:
|
||||
required: false
|
||||
type: string
|
||||
@@ -145,13 +150,15 @@ jobs:
|
||||
fi
|
||||
|
||||
- name: Set environment variables
|
||||
env:
|
||||
REVIEW_BODY: ${{ github.event.review.body || '' }}
|
||||
run: |
|
||||
# Handle pull request events first
|
||||
if [ -n "${{ github.event.pull_request.number }}" ]; then
|
||||
echo "ISSUE_NUMBER=${{ github.event.pull_request.number }}" >> $GITHUB_ENV
|
||||
echo "ISSUE_TYPE=pr" >> $GITHUB_ENV
|
||||
# Handle pull request review events
|
||||
elif [ -n "${{ github.event.review.body }}" ]; then
|
||||
elif [ -n "$REVIEW_BODY" ]; then
|
||||
echo "ISSUE_NUMBER=${{ github.event.pull_request.number }}" >> $GITHUB_ENV
|
||||
echo "ISSUE_TYPE=pr" >> $GITHUB_ENV
|
||||
# Handle issue comment events that reference a PR
|
||||
@@ -164,7 +171,7 @@ jobs:
|
||||
echo "ISSUE_TYPE=issue" >> $GITHUB_ENV
|
||||
fi
|
||||
|
||||
if [ -n "${{ github.event.review.body }}" ]; then
|
||||
if [ -n "$REVIEW_BODY" ]; then
|
||||
echo "COMMENT_ID=${{ github.event.review.id || 'None' }}" >> $GITHUB_ENV
|
||||
else
|
||||
echo "COMMENT_ID=${{ github.event.comment.id || 'None' }}" >> $GITHUB_ENV
|
||||
@@ -172,7 +179,7 @@ jobs:
|
||||
|
||||
echo "MAX_ITERATIONS=${{ inputs.max_iterations || 50 }}" >> $GITHUB_ENV
|
||||
echo "SANDBOX_ENV_GITHUB_TOKEN=${{ secrets.PAT_TOKEN || github.token }}" >> $GITHUB_ENV
|
||||
echo "SANDBOX_ENV_BASE_CONTAINER_IMAGE=${{ inputs.base_container_image }}" >> $GITHUB_ENV
|
||||
echo "SANDBOX_BASE_CONTAINER_IMAGE=${{ inputs.base_container_image }}" >> $GITHUB_ENV
|
||||
|
||||
# Set branch variables
|
||||
echo "TARGET_BRANCH=${{ inputs.target_branch || 'main' }}" >> $GITHUB_ENV
|
||||
@@ -238,7 +245,7 @@ jobs:
|
||||
PYTHONPATH: ""
|
||||
run: |
|
||||
cd /tmp && python -m openhands.resolver.resolve_issue \
|
||||
--repo ${{ github.repository }} \
|
||||
--selected-repo ${{ github.repository }} \
|
||||
--issue-number ${{ env.ISSUE_NUMBER }} \
|
||||
--issue-type ${{ env.ISSUE_TYPE }} \
|
||||
--max-iterations ${{ env.MAX_ITERATIONS }} \
|
||||
@@ -278,9 +285,9 @@ jobs:
|
||||
cd /tmp && python -m openhands.resolver.send_pull_request \
|
||||
--issue-number ${{ env.ISSUE_NUMBER }} \
|
||||
--target-branch ${{ env.TARGET_BRANCH }} \
|
||||
--pr-type draft \
|
||||
--pr-type ${{ inputs.pr_type || 'draft' }} \
|
||||
--reviewer ${{ github.actor }} | tee pr_result.txt && \
|
||||
grep "draft created" pr_result.txt | sed 's/.*\///g' > pr_number.txt
|
||||
grep "PR created" pr_result.txt | sed 's/.*\///g' > pr_number.txt
|
||||
else
|
||||
cd /tmp && python -m openhands.resolver.send_pull_request \
|
||||
--issue-number ${{ env.ISSUE_NUMBER }} \
|
||||
@@ -295,11 +302,12 @@ jobs:
|
||||
if: always()
|
||||
env:
|
||||
AGENT_RESPONDED: ${{ env.AGENT_RESPONDED || 'false' }}
|
||||
ISSUE_NUMBER: ${{ env.ISSUE_NUMBER }}
|
||||
with:
|
||||
github-token: ${{ secrets.PAT_TOKEN || github.token }}
|
||||
script: |
|
||||
const fs = require('fs');
|
||||
const issueNumber = ${{ env.ISSUE_NUMBER }};
|
||||
const issueNumber = process.env.ISSUE_NUMBER;
|
||||
let logContent = '';
|
||||
|
||||
try {
|
||||
@@ -330,13 +338,15 @@ jobs:
|
||||
if: always() # Comment on issue even if the previous steps fail
|
||||
env:
|
||||
AGENT_RESPONDED: ${{ env.AGENT_RESPONDED || 'false' }}
|
||||
ISSUE_NUMBER: ${{ env.ISSUE_NUMBER }}
|
||||
RESOLUTION_SUCCESS: ${{ steps.check_result.outputs.RESOLUTION_SUCCESS }}
|
||||
with:
|
||||
github-token: ${{ secrets.PAT_TOKEN || github.token }}
|
||||
script: |
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const issueNumber = ${{ env.ISSUE_NUMBER }};
|
||||
const success = ${{ steps.check_result.outputs.RESOLUTION_SUCCESS }};
|
||||
const issueNumber = process.env.ISSUE_NUMBER;
|
||||
const success = process.env.RESOLUTION_SUCCESS === 'true';
|
||||
|
||||
let prNumber = '';
|
||||
let branchName = '';
|
||||
@@ -401,10 +411,12 @@ jobs:
|
||||
- name: Fallback Error Comment
|
||||
uses: actions/github-script@v7
|
||||
if: ${{ env.AGENT_RESPONDED == 'false' }} # Only run if no conditions were met in previous steps
|
||||
env:
|
||||
ISSUE_NUMBER: ${{ env.ISSUE_NUMBER }}
|
||||
with:
|
||||
github-token: ${{ secrets.PAT_TOKEN || github.token }}
|
||||
script: |
|
||||
const issueNumber = ${{ env.ISSUE_NUMBER }};
|
||||
const issueNumber = process.env.ISSUE_NUMBER;
|
||||
|
||||
github.rest.issues.createComment({
|
||||
issue_number: issueNumber,
|
||||
|
||||
6
.github/workflows/py-unit-tests.yml
vendored
6
.github/workflows/py-unit-tests.yml
vendored
@@ -19,7 +19,7 @@ jobs:
|
||||
# Run python unit tests on Linux
|
||||
test-on-linux:
|
||||
name: Python Unit Tests on Linux
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
env:
|
||||
INSTALL_DOCKER: '0' # Set to '0' to skip Docker installation
|
||||
strategy:
|
||||
@@ -33,13 +33,13 @@ jobs:
|
||||
- name: Install tmux
|
||||
run: sudo apt-get update && sudo apt-get install -y tmux
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
uses: useblacksmith/setup-node@v5
|
||||
with:
|
||||
node-version: '22.x'
|
||||
- name: Install poetry via pipx
|
||||
run: pipx install poetry
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
cache: 'poetry'
|
||||
|
||||
4
.github/workflows/pypi-release.yml
vendored
4
.github/workflows/pypi-release.yml
vendored
@@ -12,10 +12,10 @@ on:
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-python@v5
|
||||
- uses: useblacksmith/setup-python@v6
|
||||
with:
|
||||
python-version: 3.12
|
||||
- name: Install Poetry
|
||||
|
||||
5
.github/workflows/run-eval.yml
vendored
5
.github/workflows/run-eval.yml
vendored
@@ -10,7 +10,7 @@ jobs:
|
||||
trigger-job:
|
||||
name: Trigger remote eval job
|
||||
if: ${{ github.event.label.name == 'run-eval-xs' || github.event.label.name == 'run-eval-s' || github.event.label.name == 'run-eval-m' }}
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
|
||||
steps:
|
||||
- name: Checkout PR branch
|
||||
@@ -19,9 +19,10 @@ jobs:
|
||||
ref: ${{ github.head_ref }}
|
||||
|
||||
- name: Trigger remote job
|
||||
env:
|
||||
PR_BRANCH: ${{ github.head_ref }}
|
||||
run: |
|
||||
REPO_URL="https://github.com/${{ github.repository }}"
|
||||
PR_BRANCH="${{ github.head_ref }}"
|
||||
echo "Repository URL: $REPO_URL"
|
||||
echo "PR Branch: $PR_BRANCH"
|
||||
|
||||
|
||||
2
.github/workflows/stale.yml
vendored
2
.github/workflows/stale.yml
vendored
@@ -8,7 +8,7 @@ on:
|
||||
|
||||
jobs:
|
||||
stale:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2204
|
||||
steps:
|
||||
- uses: actions/stale@v9
|
||||
with:
|
||||
|
||||
@@ -10,13 +10,21 @@ This repository contains the code for OpenHands, an automated AI software engine
|
||||
To set up the entire repo, including frontend and backend, run `make build`.
|
||||
You don't need to do this unless the user asks you to, or if you're trying to run the entire application.
|
||||
|
||||
Before pushing any changes, you should ensure that any lint errors or simple test errors have been fixed.
|
||||
IMPORTANT: Before making any changes to the codebase, ALWAYS run `make install-pre-commit-hooks` to ensure pre-commit hooks are properly installed.
|
||||
|
||||
Before pushing any changes, you MUST ensure that any lint errors or simple test errors have been fixed.
|
||||
|
||||
* If you've made changes to the backend, you should run `pre-commit run --all-files --config ./dev_config/python/.pre-commit-config.yaml`
|
||||
* If you've made changes to the frontend, you should run `cd frontend && npm run lint:fix && npm run build ; cd ..`
|
||||
|
||||
The pre-commit hooks MUST pass successfully before pushing any changes to the repository. This is a mandatory requirement to maintain code quality and consistency.
|
||||
|
||||
If either command fails, it may have automatically fixed some issues. You should fix any issues that weren't automatically fixed,
|
||||
then re-run the command to ensure it passes.
|
||||
then re-run the command to ensure it passes. Common issues include:
|
||||
- Mypy type errors
|
||||
- Ruff formatting issues
|
||||
- Trailing whitespace
|
||||
- Missing newlines at end of files
|
||||
|
||||
## Repository Structure
|
||||
Backend:
|
||||
@@ -33,6 +41,7 @@ Frontend:
|
||||
- Testing:
|
||||
- Run tests: `npm run test`
|
||||
- To run specific tests: `npm run test -- -t "TestName"`
|
||||
- Our test framework is vitest
|
||||
- Building:
|
||||
- Build for production: `npm run build`
|
||||
- Environment Variables:
|
||||
@@ -40,3 +49,25 @@ Frontend:
|
||||
- Available variables: VITE_BACKEND_HOST, VITE_USE_TLS, VITE_INSECURE_SKIP_VERIFY, VITE_FRONTEND_PORT
|
||||
- Internationalization:
|
||||
- Generate i18n declaration file: `npm run make-i18n`
|
||||
|
||||
|
||||
## Template for Github Pull Request
|
||||
|
||||
If you are starting a pull request (PR), please follow the template in `.github/pull_request_template.md`.
|
||||
|
||||
## Implementation Details
|
||||
|
||||
These details may or may not be useful for your current task.
|
||||
|
||||
### Frontend
|
||||
|
||||
#### Action Handling:
|
||||
- Actions are defined in `frontend/src/types/action-type.ts`
|
||||
- The `HANDLED_ACTIONS` array in `frontend/src/state/chat-slice.ts` determines which actions are displayed as collapsible UI elements
|
||||
- To add a new action type to the UI:
|
||||
1. Add the action type to the `HANDLED_ACTIONS` array
|
||||
2. Implement the action handling in `addAssistantAction` function in chat-slice.ts
|
||||
3. Add a translation key in the format `ACTION_MESSAGE$ACTION_NAME` to the i18n files
|
||||
- Actions with `thought` property are displayed in the UI based on their action type:
|
||||
- Regular actions (like "run", "edit") display the thought as a separate message
|
||||
- Special actions (like "think") are displayed as collapsible elements only
|
||||
|
||||
5
.openhands/setup.sh
Executable file
5
.openhands/setup.sh
Executable file
@@ -0,0 +1,5 @@
|
||||
#! /bin/bash
|
||||
|
||||
echo "Setting up the environment..."
|
||||
|
||||
python -m pip install pre-commit
|
||||
@@ -1,22 +1,26 @@
|
||||
# Development Guide
|
||||
|
||||
This guide is for people working on OpenHands and editing the source code.
|
||||
If you wish to contribute your changes, check out the [CONTRIBUTING.md](https://github.com/All-Hands-AI/OpenHands/blob/main/CONTRIBUTING.md) on how to clone and setup the project initially before moving on.
|
||||
Otherwise, you can clone the OpenHands project directly.
|
||||
|
||||
## Start the Server for Development
|
||||
|
||||
### 1. Requirements
|
||||
* Linux, Mac OS, or [WSL on Windows](https://learn.microsoft.com/en-us/windows/wsl/install) [Ubuntu >= 22.04]
|
||||
* [Docker](https://docs.docker.com/engine/install/) (For those on MacOS, make sure to allow the default Docker socket to be used from advanced settings!)
|
||||
* [Python](https://www.python.org/downloads/) = 3.12
|
||||
* [NodeJS](https://nodejs.org/en/download/package-manager) >= 20.x
|
||||
* [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) >= 1.8
|
||||
* OS-specific dependencies:
|
||||
|
||||
- Linux, Mac OS, or [WSL on Windows](https://learn.microsoft.com/en-us/windows/wsl/install) [Ubuntu >= 22.04]
|
||||
- [Docker](https://docs.docker.com/engine/install/) (For those on MacOS, make sure to allow the default Docker socket to be used from advanced settings!)
|
||||
- [Python](https://www.python.org/downloads/) = 3.12
|
||||
- [NodeJS](https://nodejs.org/en/download/package-manager) >= 22.x
|
||||
- [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) >= 1.8
|
||||
- OS-specific dependencies:
|
||||
- Ubuntu: build-essential => `sudo apt-get install build-essential`
|
||||
- WSL: netcat => `sudo apt-get install netcat`
|
||||
|
||||
Make sure you have all these dependencies installed before moving on to `make build`.
|
||||
|
||||
#### Develop without sudo access
|
||||
|
||||
If you want to develop without system admin/sudo access to upgrade/install `Python` and/or `NodeJs`, you can use `conda` or `mamba` to manage the packages for you:
|
||||
|
||||
```bash
|
||||
@@ -31,6 +35,7 @@ mamba install conda-forge::poetry
|
||||
```
|
||||
|
||||
### 2. Build and Setup The Environment
|
||||
|
||||
Begin by building the project which includes setting up the environment and installing dependencies. This step ensures that OpenHands is ready to run on your system:
|
||||
|
||||
```bash
|
||||
@@ -38,54 +43,65 @@ make build
|
||||
```
|
||||
|
||||
### 3. Configuring the Language Model
|
||||
|
||||
OpenHands supports a diverse array of Language Models (LMs) through the powerful [litellm](https://docs.litellm.ai) library.
|
||||
By default, we've chosen Claude Sonnet 3.5 as our go-to model, but the world is your oyster! You can unleash the
|
||||
potential of any other LM that piques your interest.
|
||||
|
||||
To configure the LM of your choice, run:
|
||||
|
||||
```bash
|
||||
make setup-config
|
||||
```
|
||||
```bash
|
||||
make setup-config
|
||||
```
|
||||
|
||||
This command will prompt you to enter the LLM API key, model name, and other variables ensuring that OpenHands is tailored to your specific needs. Note that the model name will apply only when you run headless. If you use the UI, please set the model in the UI.
|
||||
This command will prompt you to enter the LLM API key, model name, and other variables ensuring that OpenHands is tailored to your specific needs. Note that the model name will apply only when you run headless. If you use the UI, please set the model in the UI.
|
||||
|
||||
Note: If you have previously run OpenHands using the docker command, you may have already set some environmental variables in your terminal. The final configurations are set from highest to lowest priority:
|
||||
Environment variables > config.toml variables > default variables
|
||||
Note: If you have previously run OpenHands using the docker command, you may have already set some environmental variables in your terminal. The final configurations are set from highest to lowest priority:
|
||||
Environment variables > config.toml variables > default variables
|
||||
|
||||
**Note on Alternative Models:**
|
||||
See [our documentation](https://docs.all-hands.dev/modules/usage/llms) for recommended models.
|
||||
|
||||
### 4. Running the application
|
||||
|
||||
#### Option A: Run the Full Application
|
||||
|
||||
Once the setup is complete, this command starts both the backend and frontend servers, allowing you to interact with OpenHands:
|
||||
|
||||
```bash
|
||||
make run
|
||||
```
|
||||
|
||||
#### Option B: Individual Server Startup
|
||||
|
||||
- **Start the Backend Server:** If you prefer, you can start the backend server independently to focus on backend-related tasks or configurations.
|
||||
```bash
|
||||
make start-backend
|
||||
```
|
||||
|
||||
```bash
|
||||
make start-backend
|
||||
```
|
||||
|
||||
- **Start the Frontend Server:** Similarly, you can start the frontend server on its own to work on frontend-related components or interface enhancements.
|
||||
```bash
|
||||
make start-frontend
|
||||
```
|
||||
```bash
|
||||
make start-frontend
|
||||
```
|
||||
|
||||
### 6. LLM Debugging
|
||||
|
||||
If you encounter any issues with the Language Model (LM) or you're simply curious, export DEBUG=1 in the environment and restart the backend.
|
||||
OpenHands will log the prompts and responses in the logs/llm/CURRENT_DATE directory, allowing you to identify the causes.
|
||||
|
||||
### 7. Help
|
||||
|
||||
Need help or info on available targets and commands? Use the help command for all the guidance you need with OpenHands.
|
||||
|
||||
```bash
|
||||
make help
|
||||
```
|
||||
```
|
||||
|
||||
### 8. Testing
|
||||
|
||||
To run tests, refer to the following:
|
||||
|
||||
#### Unit tests
|
||||
|
||||
```bash
|
||||
@@ -93,14 +109,16 @@ poetry run pytest ./tests/unit/test_*.py
|
||||
```
|
||||
|
||||
### 9. Add or update dependency
|
||||
|
||||
1. Add your dependency in `pyproject.toml` or use `poetry add xxx`.
|
||||
2. Update the poetry.lock file via `poetry lock --no-update`.
|
||||
|
||||
### 9. Use existing Docker image
|
||||
|
||||
To reduce build time (e.g., if no changes were made to the client-runtime component), you can use an existing Docker container image by
|
||||
setting the SANDBOX_RUNTIME_CONTAINER_IMAGE environment variable to the desired Docker image.
|
||||
|
||||
Example: `export SANDBOX_RUNTIME_CONTAINER_IMAGE=ghcr.io/all-hands-ai/runtime:0.28-nikolaik`
|
||||
Example: `export SANDBOX_RUNTIME_CONTAINER_IMAGE=ghcr.io/all-hands-ai/runtime:0.34-nikolaik`
|
||||
|
||||
## Develop inside Docker container
|
||||
|
||||
@@ -126,3 +144,20 @@ cd ./containers/dev
|
||||
```
|
||||
|
||||
You do need [Docker](https://docs.docker.com/engine/install/) installed on your host though.
|
||||
|
||||
## Key Documentation Resources
|
||||
|
||||
Here's a guide to the important documentation files in the repository:
|
||||
|
||||
- [/README.md](./README.md): Main project overview, features, and basic setup instructions
|
||||
- [/Development.md](./Development.md) (this file): Comprehensive guide for developers working on OpenHands
|
||||
- [/CONTRIBUTING.md](./CONTRIBUTING.md): Guidelines for contributing to the project, including code style and PR process
|
||||
- [/docs/DOC_STYLE_GUIDE.md](./docs/DOC_STYLE_GUIDE.md): Standards for writing and maintaining project documentation
|
||||
- [/openhands/README.md](./openhands/README.md): Details about the backend Python implementation
|
||||
- [/frontend/README.md](./frontend/README.md): Frontend React application setup and development guide
|
||||
- [/containers/README.md](./containers/README.md): Information about Docker containers and deployment
|
||||
- [/tests/unit/README.md](./tests/unit/README.md): Guide to writing and running unit tests
|
||||
- [/evaluation/README.md](./evaluation/README.md): Documentation for the evaluation framework and benchmarks
|
||||
- [/microagents/README.md](./microagents/README.md): Information about the microagents architecture and implementation
|
||||
- [/openhands/server/README.md](./openhands/server/README.md): Server implementation details and API documentation
|
||||
- [/openhands/runtime/README.md](./openhands/runtime/README.md): Documentation for the runtime environment and execution model
|
||||
|
||||
63
Makefile
63
Makefile
@@ -39,6 +39,7 @@ ifeq ($(INSTALL_DOCKER),)
|
||||
@$(MAKE) -s check-docker
|
||||
endif
|
||||
@$(MAKE) -s check-poetry
|
||||
@$(MAKE) -s check-tmux
|
||||
@echo "$(GREEN)Dependencies checked successfully.$(RESET)"
|
||||
|
||||
check-system:
|
||||
@@ -101,6 +102,18 @@ check-docker:
|
||||
exit 1; \
|
||||
fi
|
||||
|
||||
check-tmux:
|
||||
@echo "$(YELLOW)Checking tmux installation...$(RESET)"
|
||||
@if command -v tmux > /dev/null; then \
|
||||
echo "$(BLUE)$(shell tmux -V) is already installed.$(RESET)"; \
|
||||
else \
|
||||
echo "$(YELLOW)╔════════════════════════════════════════════════════════════════════════════╗$(RESET)"; \
|
||||
echo "$(YELLOW)║ OPTIONAL: tmux is not installed. ║$(RESET)"; \
|
||||
echo "$(YELLOW)║ Some advanced terminal features may not work without tmux. ║$(RESET)"; \
|
||||
echo "$(YELLOW)║ You can install it if needed, but it's not required for development. ║$(RESET)"; \
|
||||
echo "$(YELLOW)╚════════════════════════════════════════════════════════════════════════════╝$(RESET)"; \
|
||||
fi
|
||||
|
||||
check-poetry:
|
||||
@echo "$(YELLOW)Checking Poetry installation...$(RESET)"
|
||||
@if command -v poetry > /dev/null; then \
|
||||
@@ -133,20 +146,29 @@ install-python-dependencies:
|
||||
export HNSWLIB_NO_NATIVE=1; \
|
||||
poetry run pip install chroma-hnswlib; \
|
||||
fi
|
||||
@poetry install
|
||||
@if [ -f "/etc/manjaro-release" ]; then \
|
||||
echo "$(BLUE)Detected Manjaro Linux. Installing Playwright dependencies...$(RESET)"; \
|
||||
poetry run pip install playwright; \
|
||||
poetry run playwright install chromium; \
|
||||
@if [ -n "${POETRY_GROUP}" ]; then \
|
||||
echo "Installing only POETRY_GROUP=${POETRY_GROUP}"; \
|
||||
poetry install --only $${POETRY_GROUP}; \
|
||||
else \
|
||||
if [ ! -f cache/playwright_chromium_is_installed.txt ]; then \
|
||||
echo "Running playwright install --with-deps chromium..."; \
|
||||
poetry run playwright install --with-deps chromium; \
|
||||
mkdir -p cache; \
|
||||
touch cache/playwright_chromium_is_installed.txt; \
|
||||
poetry install; \
|
||||
fi
|
||||
@if [ "${INSTALL_PLAYWRIGHT}" != "false" ] && [ "${INSTALL_PLAYWRIGHT}" != "0" ]; then \
|
||||
if [ -f "/etc/manjaro-release" ]; then \
|
||||
echo "$(BLUE)Detected Manjaro Linux. Installing Playwright dependencies...$(RESET)"; \
|
||||
poetry run pip install playwright; \
|
||||
poetry run playwright install chromium; \
|
||||
else \
|
||||
echo "Setup already done. Skipping playwright installation."; \
|
||||
if [ ! -f cache/playwright_chromium_is_installed.txt ]; then \
|
||||
echo "Running playwright install --with-deps chromium..."; \
|
||||
poetry run playwright install --with-deps chromium; \
|
||||
mkdir -p cache; \
|
||||
touch cache/playwright_chromium_is_installed.txt; \
|
||||
else \
|
||||
echo "Setup already done. Skipping playwright installation."; \
|
||||
fi \
|
||||
fi \
|
||||
else \
|
||||
echo "Skipping Playwright installation (INSTALL_PLAYWRIGHT=${INSTALL_PLAYWRIGHT})."; \
|
||||
fi
|
||||
@echo "$(GREEN)Python dependencies installed successfully.$(RESET)"
|
||||
|
||||
@@ -166,7 +188,7 @@ install-pre-commit-hooks:
|
||||
|
||||
lint-backend:
|
||||
@echo "$(YELLOW)Running linters...$(RESET)"
|
||||
@poetry run pre-commit run --files openhands/**/* agenthub/**/* evaluation/**/* --show-diff-on-failure --config $(PRE_COMMIT_CONFIG_PATH)
|
||||
@poetry run pre-commit run --files openhands/**/* evaluation/**/* tests/**/* --show-diff-on-failure --config $(PRE_COMMIT_CONFIG_PATH)
|
||||
|
||||
lint-frontend:
|
||||
@echo "$(YELLOW)Running linters for frontend...$(RESET)"
|
||||
@@ -185,7 +207,7 @@ test:
|
||||
|
||||
build-frontend:
|
||||
@echo "$(YELLOW)Building frontend...$(RESET)"
|
||||
@cd frontend && npm run build
|
||||
@cd frontend && npm run prepare && npm run build
|
||||
|
||||
# Start backend
|
||||
start-backend:
|
||||
@@ -195,7 +217,14 @@ start-backend:
|
||||
# Start frontend
|
||||
start-frontend:
|
||||
@echo "$(YELLOW)Starting frontend...$(RESET)"
|
||||
@cd frontend && VITE_BACKEND_HOST=$(BACKEND_HOST_PORT) VITE_FRONTEND_PORT=$(FRONTEND_PORT) npm run dev -- --port $(FRONTEND_PORT) --host $(BACKEND_HOST)
|
||||
@cd frontend && \
|
||||
if grep -qi microsoft /proc/version 2>/dev/null; then \
|
||||
echo "Detected WSL environment. Using 'dev_wsl'"; \
|
||||
SCRIPT=dev_wsl; \
|
||||
else \
|
||||
SCRIPT=dev; \
|
||||
fi; \
|
||||
VITE_BACKEND_HOST=$(BACKEND_HOST_PORT) VITE_FRONTEND_PORT=$(FRONTEND_PORT) npm run $$SCRIPT -- --port $(FRONTEND_PORT) --host $(BACKEND_HOST)
|
||||
|
||||
# Common setup for running the app (non-callable)
|
||||
_run_setup:
|
||||
@@ -231,12 +260,6 @@ docker-run:
|
||||
docker compose up $(OPTIONS); \
|
||||
fi
|
||||
|
||||
# Run the app (WSL mode)
|
||||
run-wsl:
|
||||
@echo "$(YELLOW)Running the app in WSL mode...$(RESET)"
|
||||
@$(MAKE) -s _run_setup
|
||||
@cd frontend && echo "$(BLUE)Starting frontend with npm (WSL mode)...$(RESET)" && npm run dev_wsl -- --port $(FRONTEND_PORT)
|
||||
@echo "$(GREEN)Application started successfully in WSL mode.$(RESET)"
|
||||
|
||||
# Setup config.toml
|
||||
setup-config:
|
||||
|
||||
49
README.md
49
README.md
@@ -12,13 +12,13 @@
|
||||
<a href="https://codecov.io/github/All-Hands-AI/OpenHands?branch=main"><img alt="CodeCov" src="https://img.shields.io/codecov/c/github/All-Hands-AI/OpenHands?style=for-the-badge&color=blue"></a>
|
||||
<a href="https://github.com/All-Hands-AI/OpenHands/blob/main/LICENSE"><img src="https://img.shields.io/github/license/All-Hands-AI/OpenHands?style=for-the-badge&color=blue" alt="MIT License"></a>
|
||||
<br/>
|
||||
<a href="https://join.slack.com/t/openhands-ai/shared_invite/zt-2ypg5jweb-d~6hObZDbXi_HEL8PDrbHg"><img src="https://img.shields.io/badge/Slack-Join%20Us-red?logo=slack&logoColor=white&style=for-the-badge" alt="Join our Slack community"></a>
|
||||
<a href="https://join.slack.com/t/openhands-ai/shared_invite/zt-2ngejmfw6-9gW4APWOC9XUp1n~SiQ6iw"><img src="https://img.shields.io/badge/Slack-Join%20Us-red?logo=slack&logoColor=white&style=for-the-badge" alt="Join our Slack community"></a>
|
||||
<a href="https://discord.gg/ESHStjSjD4"><img src="https://img.shields.io/badge/Discord-Join%20Us-purple?logo=discord&logoColor=white&style=for-the-badge" alt="Join our Discord community"></a>
|
||||
<a href="https://github.com/All-Hands-AI/OpenHands/blob/main/CREDITS.md"><img src="https://img.shields.io/badge/Project-Credits-blue?style=for-the-badge&color=FFE165&logo=github&logoColor=white" alt="Credits"></a>
|
||||
<br/>
|
||||
<a href="https://docs.all-hands.dev/modules/usage/getting-started"><img src="https://img.shields.io/badge/Documentation-000?logo=googledocs&logoColor=FFE165&style=for-the-badge" alt="Check out the documentation"></a>
|
||||
<a href="https://arxiv.org/abs/2407.16741"><img src="https://img.shields.io/badge/Paper%20on%20Arxiv-000?logoColor=FFE165&logo=arxiv&style=for-the-badge" alt="Paper on Arxiv"></a>
|
||||
<a href="https://huggingface.co/spaces/OpenHands/evaluation"><img src="https://img.shields.io/badge/Benchmark%20score-000?logoColor=FFE165&logo=huggingface&style=for-the-badge" alt="Evaluation Benchmark Score"></a>
|
||||
<a href="https://docs.google.com/spreadsheets/d/1wOUdFCMyY6Nt0AIqF705KN4JKOWgeI4wUGUP60krXXs/edit?gid=0#gid=0"><img src="https://img.shields.io/badge/Benchmark%20score-000?logoColor=FFE165&logo=huggingface&style=for-the-badge" alt="Evaluation Benchmark Score"></a>
|
||||
<hr>
|
||||
</div>
|
||||
|
||||
@@ -27,7 +27,7 @@ Welcome to OpenHands (formerly OpenDevin), a platform for software development a
|
||||
OpenHands agents can do anything a human developer can: modify code, run commands, browse the web,
|
||||
call APIs, and yes—even copy code snippets from StackOverflow.
|
||||
|
||||
Learn more at [docs.all-hands.dev](https://docs.all-hands.dev), or jump to the [Quick Start](#-quick-start).
|
||||
Learn more at [docs.all-hands.dev](https://docs.all-hands.dev), or [sign up for OpenHands Cloud](https://app.all-hands.dev) to get started.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Using OpenHands for work? We'd love to chat! Fill out
|
||||
@@ -36,49 +36,58 @@ Learn more at [docs.all-hands.dev](https://docs.all-hands.dev), or jump to the [
|
||||
|
||||

|
||||
|
||||
## ⚡ Quick Start
|
||||
## ☁️ OpenHands Cloud
|
||||
The easiest way to get started with OpenHands is on [OpenHands Cloud](https://app.all-hands.dev),
|
||||
which comes with $50 in free credits for new users.
|
||||
|
||||
The easiest way to run OpenHands is in Docker.
|
||||
## 💻 Running OpenHands Locally
|
||||
|
||||
OpenHands can also run on your local system using Docker.
|
||||
See the [Running OpenHands](https://docs.all-hands.dev/modules/usage/installation) guide for
|
||||
system requirements and more information.
|
||||
|
||||
> [!WARNING]
|
||||
> On a public network? See our [Hardened Docker Installation Guide](https://docs.all-hands.dev/modules/usage/runtimes/docker#hardened-docker-installation)
|
||||
> to secure your deployment by restricting network binding and implementing additional security measures.
|
||||
|
||||
|
||||
```bash
|
||||
docker pull docker.all-hands.dev/all-hands-ai/runtime:0.28-nikolaik
|
||||
docker pull docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik
|
||||
|
||||
docker run -it --rm --pull=always \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.28-nikolaik \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.34-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.28
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.34
|
||||
```
|
||||
|
||||
You'll find OpenHands running at [http://localhost:3000](http://localhost:3000)!
|
||||
|
||||
Finally, you'll need a model provider and API key.
|
||||
When you open the application, you'll be asked to choose an LLM provider and add an API key.
|
||||
[Anthropic's Claude 3.5 Sonnet](https://www.anthropic.com/api) (`anthropic/claude-3-5-sonnet-20241022`)
|
||||
works best, but you have [many options](https://docs.all-hands.dev/modules/usage/llms).
|
||||
|
||||
---
|
||||
## 💡 Other ways to run OpenHands
|
||||
|
||||
You can also [connect OpenHands to your local filesystem](https://docs.all-hands.dev/modules/usage/runtimes#connecting-to-your-filesystem),
|
||||
> [!CAUTION]
|
||||
> OpenHands is meant to be run by a single user on their local workstation.
|
||||
> It is not appropriate for multi-tenant deployments where multiple users share the same instance. There is no built-in authentication, isolation, or scalability.
|
||||
>
|
||||
> If you're interested in running OpenHands in a multi-tenant environment, please
|
||||
> [get in touch with us](https://docs.google.com/forms/d/e/1FAIpQLSet3VbGaz8z32gW9Wm-Grl4jpt5WgMXPgJ4EDPVmCETCBpJtQ/viewform)
|
||||
> for advanced deployment options.
|
||||
|
||||
You can also [connect OpenHands to your local filesystem](https://docs.all-hands.dev/modules/usage/runtimes/docker#connecting-to-your-filesystem),
|
||||
run OpenHands in a scriptable [headless mode](https://docs.all-hands.dev/modules/usage/how-to/headless-mode),
|
||||
interact with it via a [friendly CLI](https://docs.all-hands.dev/modules/usage/how-to/cli-mode),
|
||||
or run it on tagged issues with [a github action](https://docs.all-hands.dev/modules/usage/how-to/github-action).
|
||||
|
||||
Visit [Running OpenHands](https://docs.all-hands.dev/modules/usage/installation) for more information and setup instructions.
|
||||
|
||||
> [!CAUTION]
|
||||
> OpenHands is meant to be run by a single user on their local workstation.
|
||||
> It is not appropriate for multi-tenant deployments where multiple users share the same instance. There is no built-in isolation or scalability.
|
||||
>
|
||||
> If you're interested in running OpenHands in a multi-tenant environment, please
|
||||
> [get in touch with us](https://docs.google.com/forms/d/e/1FAIpQLSet3VbGaz8z32gW9Wm-Grl4jpt5WgMXPgJ4EDPVmCETCBpJtQ/viewform)
|
||||
> for advanced deployment options.
|
||||
|
||||
If you want to modify the OpenHands source code, check out [Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md).
|
||||
|
||||
Having issues? The [Troubleshooting Guide](https://docs.all-hands.dev/modules/usage/troubleshooting) can help.
|
||||
@@ -96,7 +105,7 @@ troubleshooting resources, and advanced configuration options.
|
||||
OpenHands is a community-driven project, and we welcome contributions from everyone. We do most of our communication
|
||||
through Slack, so this is the best place to start, but we also are happy to have you contact us on Discord or Github:
|
||||
|
||||
- [Join our Slack workspace](https://join.slack.com/t/openhands-ai/shared_invite/zt-2ypg5jweb-d~6hObZDbXi_HEL8PDrbHg) - Here we talk about research, architecture, and future development.
|
||||
- [Join our Slack workspace](https://join.slack.com/t/openhands-ai/shared_invite/zt-2ngejmfw6-9gW4APWOC9XUp1n~SiQ6iw) - Here we talk about research, architecture, and future development.
|
||||
- [Join our Discord server](https://discord.gg/ESHStjSjD4) - This is a community-run server for general discussion, questions, and feedback.
|
||||
- [Read or post Github Issues](https://github.com/All-Hands-AI/OpenHands/issues) - Check out the issues we're working on, or add your own ideas.
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
#daytona_target = ""
|
||||
|
||||
# Base path for the workspace
|
||||
workspace_base = "./workspace"
|
||||
#workspace_base = "./workspace"
|
||||
|
||||
# Cache directory path
|
||||
#cache_dir = "/tmp/cache"
|
||||
@@ -38,13 +38,14 @@ workspace_base = "./workspace"
|
||||
# Disable color in terminal output
|
||||
#disable_color = false
|
||||
|
||||
# Enable saving and restoring the session when run from CLI
|
||||
#enable_cli_session = false
|
||||
|
||||
# Path to store trajectories, can be a folder or a file
|
||||
# If it's a folder, the session id will be used as the file name
|
||||
#save_trajectory_path="./trajectories"
|
||||
|
||||
# Whether to save screenshots in the trajectory
|
||||
# The screenshots are encoded and can make trajectory json files very large
|
||||
#save_screenshots_in_trajectory = false
|
||||
|
||||
# Path to replay a trajectory, must be a file path
|
||||
# If provided, trajectory will be loaded and replayed before the
|
||||
# agent responds to any user instruction
|
||||
@@ -56,9 +57,6 @@ workspace_base = "./workspace"
|
||||
# File store type
|
||||
#file_store = "memory"
|
||||
|
||||
# List of allowed file extensions for uploads
|
||||
#file_uploads_allowed_extensions = [".*"]
|
||||
|
||||
# Maximum file size for uploads, in megabytes
|
||||
#file_uploads_max_file_size_mb = 0
|
||||
|
||||
@@ -66,7 +64,7 @@ workspace_base = "./workspace"
|
||||
#max_budget_per_task = 0.0
|
||||
|
||||
# Maximum number of iterations
|
||||
#max_iterations = 100
|
||||
#max_iterations = 250
|
||||
|
||||
# Path to mount the workspace in the sandbox
|
||||
#workspace_mount_path_in_sandbox = "/workspace"
|
||||
@@ -100,6 +98,12 @@ workspace_base = "./workspace"
|
||||
# When false, a NoOpCondenserConfig (no summarization) will be used
|
||||
#enable_default_condenser = true
|
||||
|
||||
# Maximum number of concurrent conversations per user
|
||||
#max_concurrent_conversations = 3
|
||||
|
||||
# Maximum age of conversations in seconds before they are automatically closed
|
||||
#conversation_max_age_seconds = 864000 # 10 days
|
||||
|
||||
#################################### LLM #####################################
|
||||
# Configuration for LLM models (group name starts with 'llm')
|
||||
# use 'llm' for the default LLM config
|
||||
@@ -196,6 +200,8 @@ model = "gpt-4o"
|
||||
# https://github.com/All-Hands-AI/OpenHands/pull/4711
|
||||
#native_tool_calling = None
|
||||
|
||||
|
||||
|
||||
[llm.gpt4o-mini]
|
||||
api_key = ""
|
||||
model = "gpt-4o"
|
||||
@@ -209,20 +215,27 @@ model = "gpt-4o"
|
||||
##############################################################################
|
||||
[agent]
|
||||
|
||||
# whether the browsing tool is enabled
|
||||
codeact_enable_browsing = true
|
||||
# Whether the browsing tool is enabled
|
||||
enable_browsing = true
|
||||
|
||||
# whether the LLM draft editor is enabled
|
||||
codeact_enable_llm_editor = false
|
||||
# Whether the LLM draft editor is enabled
|
||||
enable_llm_editor = false
|
||||
|
||||
# whether the IPython tool is enabled
|
||||
codeact_enable_jupyter = true
|
||||
# Whether the standard editor tool (str_replace_editor) is enabled
|
||||
# Only has an effect if enable_llm_editor is False
|
||||
enable_editor = true
|
||||
|
||||
# Memory enabled
|
||||
#memory_enabled = false
|
||||
# Whether the IPython tool is enabled
|
||||
enable_jupyter = true
|
||||
|
||||
# Memory maximum threads
|
||||
#memory_max_threads = 3
|
||||
# Whether the command tool is enabled
|
||||
enable_cmd = true
|
||||
|
||||
# Whether the think tool is enabled
|
||||
enable_think = true
|
||||
|
||||
# Whether the finish tool is enabled
|
||||
enable_finish = true
|
||||
|
||||
# LLM config group to use
|
||||
#llm_config = 'your-llm-config-group'
|
||||
@@ -258,7 +271,7 @@ llm_config = 'gpt3'
|
||||
# Use host network
|
||||
#use_host_network = false
|
||||
|
||||
# runtime extra build args
|
||||
# Runtime extra build args
|
||||
#runtime_extra_build_args = ["--network=host", "--add-host=host.docker.internal:host-gateway"]
|
||||
|
||||
# Enable auto linting after editing
|
||||
@@ -276,6 +289,33 @@ llm_config = 'gpt3'
|
||||
# BrowserGym environment to use for evaluation
|
||||
#browsergym_eval_env = ""
|
||||
|
||||
# Platform to use for building the runtime image (e.g., "linux/amd64")
|
||||
#platform = ""
|
||||
|
||||
# Force rebuild of runtime image even if it exists
|
||||
#force_rebuild_runtime = false
|
||||
|
||||
# Runtime container image to use (if not provided, will be built from base_container_image)
|
||||
#runtime_container_image = ""
|
||||
|
||||
# Keep runtime alive after session ends
|
||||
#keep_runtime_alive = false
|
||||
|
||||
# Pause closed runtimes instead of stopping them
|
||||
#pause_closed_runtimes = false
|
||||
|
||||
# Delay in seconds before closing idle runtimes
|
||||
#close_delay = 300
|
||||
|
||||
# Remove all containers when stopping the runtime
|
||||
#rm_all_containers = false
|
||||
|
||||
# Enable GPU support in the runtime
|
||||
#enable_gpu = false
|
||||
|
||||
# Additional Docker runtime kwargs
|
||||
#docker_runtime_kwargs = {}
|
||||
|
||||
#################################### Security ###################################
|
||||
# Configuration for security features
|
||||
##############################################################################
|
||||
@@ -287,6 +327,9 @@ llm_config = 'gpt3'
|
||||
# The security analyzer to use (For Headless / CLI only - In Web this is overridden by Session Init)
|
||||
#security_analyzer = ""
|
||||
|
||||
# Whether to enable security analyzer
|
||||
#enable_security_analyzer = false
|
||||
|
||||
#################################### Condenser #################################
|
||||
# Condensers control how conversation history is managed and compressed when
|
||||
# the context grows too large. Each agent uses one condenser configuration.
|
||||
|
||||
@@ -48,7 +48,8 @@ RUN mkdir -p $FILE_STORE_PATH
|
||||
RUN mkdir -p $WORKSPACE_BASE
|
||||
|
||||
RUN apt-get update -y \
|
||||
&& apt-get install -y curl ssh sudo
|
||||
&& apt-get install -y curl ssh sudo \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Default is 1000, but OSX is often 501
|
||||
RUN sed -i 's/^UID_MIN.*/UID_MIN 499/' /etc/login.defs
|
||||
|
||||
@@ -7,15 +7,17 @@ org_name=""
|
||||
push=0
|
||||
load=0
|
||||
tag_suffix=""
|
||||
dry_run=0
|
||||
|
||||
# Function to display usage information
|
||||
usage() {
|
||||
echo "Usage: $0 -i <image_name> [-o <org_name>] [--push] [--load] [-t <tag_suffix>]"
|
||||
echo "Usage: $0 -i <image_name> [-o <org_name>] [--push] [--load] [-t <tag_suffix>] [--dry]"
|
||||
echo " -i: Image name (required)"
|
||||
echo " -o: Organization name"
|
||||
echo " --push: Push the image"
|
||||
echo " --load: Load the image"
|
||||
echo " -t: Tag suffix"
|
||||
echo " --dry: Don't build, only create build-args.json"
|
||||
exit 1
|
||||
}
|
||||
|
||||
@@ -27,6 +29,7 @@ while [[ $# -gt 0 ]]; do
|
||||
--push) push=1; shift ;;
|
||||
--load) load=1; shift ;;
|
||||
-t) tag_suffix="$2"; shift 2 ;;
|
||||
--dry) dry_run=1; shift ;;
|
||||
*) usage ;;
|
||||
esac
|
||||
done
|
||||
@@ -113,10 +116,13 @@ echo "Repo: $DOCKER_REPOSITORY"
|
||||
echo "Base dir: $DOCKER_BASE_DIR"
|
||||
|
||||
args=""
|
||||
full_tags=()
|
||||
for tag in "${tags[@]}"; do
|
||||
args+=" -t $DOCKER_REPOSITORY:$tag"
|
||||
full_tags+=("$DOCKER_REPOSITORY:$tag")
|
||||
done
|
||||
|
||||
|
||||
if [[ $push -eq 1 ]]; then
|
||||
args+=" --push"
|
||||
args+=" --cache-to=type=registry,ref=$DOCKER_REPOSITORY:$cache_tag,mode=max"
|
||||
@@ -136,6 +142,26 @@ else
|
||||
# For push or without load, build for multiple platforms
|
||||
platform="linux/amd64,linux/arm64"
|
||||
fi
|
||||
if [[ $dry_run -eq 1 ]]; then
|
||||
echo "Dry Run is enabled. Writing build config to docker-build-dry.json"
|
||||
jq -n \
|
||||
--argjson tags "$(printf '%s\n' "${full_tags[@]}" | jq -R . | jq -s .)" \
|
||||
--arg platform "$platform" \
|
||||
--arg openhands_build_version "$OPENHANDS_BUILD_VERSION" \
|
||||
--arg dockerfile "$dir/Dockerfile" \
|
||||
'{
|
||||
tags: $tags,
|
||||
platform: $platform,
|
||||
build_args: [
|
||||
"OPENHANDS_BUILD_VERSION=" + $openhands_build_version
|
||||
],
|
||||
dockerfile: $dockerfile
|
||||
}' > docker-build-dry.json
|
||||
|
||||
exit 0
|
||||
fi
|
||||
|
||||
|
||||
|
||||
echo "Building for platform(s): $platform"
|
||||
|
||||
|
||||
@@ -61,8 +61,8 @@ RUN add-apt-repository ppa:deadsnakes/ppa \
|
||||
&& apt-get install -y python3.12 python3.12-venv python3.12-dev python3-pip \
|
||||
&& ln -s /usr/bin/python3.12 /usr/bin/python
|
||||
|
||||
# NodeJS >= 18.17.1
|
||||
RUN curl -fsSL https://deb.nodesource.com/setup_18.x | bash - \
|
||||
# NodeJS >= 22.x
|
||||
RUN curl -fsSL https://deb.nodesource.com/setup_22.x | bash - \
|
||||
&& apt-get install -y nodejs
|
||||
|
||||
# Poetry >= 1.8
|
||||
@@ -108,7 +108,7 @@ WORKDIR /app
|
||||
|
||||
# cache build dependencies
|
||||
RUN \
|
||||
--mount=type=bind,source=./,target=/app/ \
|
||||
--mount=type=bind,source=./,target=/app/,rw \
|
||||
<<EOF
|
||||
#!/bin/bash
|
||||
make -s clean
|
||||
|
||||
@@ -11,7 +11,7 @@ services:
|
||||
- BACKEND_HOST=${BACKEND_HOST:-"0.0.0.0"}
|
||||
- SANDBOX_API_HOSTNAME=host.docker.internal
|
||||
#
|
||||
- SANDBOX_RUNTIME_CONTAINER_IMAGE=${SANDBOX_RUNTIME_CONTAINER_IMAGE:-ghcr.io/all-hands-ai/runtime:0.28-nikolaik}
|
||||
- SANDBOX_RUNTIME_CONTAINER_IMAGE=${SANDBOX_RUNTIME_CONTAINER_IMAGE:-ghcr.io/all-hands-ai/runtime:0.34-nikolaik}
|
||||
- SANDBOX_USER_ID=${SANDBOX_USER_ID:-1234}
|
||||
- WORKSPACE_MOUNT_PATH=${WORKSPACE_BASE:-$PWD/workspace}
|
||||
ports:
|
||||
|
||||
@@ -6,6 +6,7 @@ select = [
|
||||
"I",
|
||||
"Q",
|
||||
"B",
|
||||
"ASYNC",
|
||||
]
|
||||
|
||||
ignore = [
|
||||
|
||||
@@ -7,7 +7,7 @@ services:
|
||||
image: openhands:latest
|
||||
container_name: openhands-app-${DATE:-}
|
||||
environment:
|
||||
- SANDBOX_RUNTIME_CONTAINER_IMAGE=${SANDBOX_RUNTIME_CONTAINER_IMAGE:-docker.all-hands.dev/all-hands-ai/runtime:0.28-nikolaik}
|
||||
- SANDBOX_RUNTIME_CONTAINER_IMAGE=${SANDBOX_RUNTIME_CONTAINER_IMAGE:-docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik}
|
||||
#- SANDBOX_USER_ID=${SANDBOX_USER_ID:-1234} # enable this only if you want a specific non-root sandbox user but you will have to manually adjust permissions of openhands-state for this user
|
||||
- WORKSPACE_MOUNT_PATH=${WORKSPACE_BASE:-$PWD/workspace}
|
||||
ports:
|
||||
|
||||
1
docs/.gitignore
vendored
1
docs/.gitignore
vendored
@@ -3,6 +3,7 @@
|
||||
|
||||
# Production
|
||||
/build
|
||||
/static/swagger-ui
|
||||
|
||||
# Generated files
|
||||
.docusaurus
|
||||
|
||||
@@ -32,6 +32,8 @@ For instructions or processes that need to be followed in a specific order, use
|
||||
|
||||
Example:
|
||||
1. Step one: Do this.
|
||||
- First this sub step.
|
||||
- Then this sub step.
|
||||
2. Step two: Complete this action.
|
||||
3. Step three: Verify the result.
|
||||
|
||||
@@ -47,6 +49,15 @@ docker run -it \
|
||||
...
|
||||
```
|
||||
|
||||
### Use of Note and Warning
|
||||
|
||||
When adding a note or warning, use the built-in note and warning syntax.
|
||||
|
||||
Example:
|
||||
:::note
|
||||
This section is for advanced users only.
|
||||
:::
|
||||
|
||||
### Referring to UI Elements
|
||||
|
||||
When referencing UI elements, use ``.
|
||||
|
||||
@@ -1,21 +1,32 @@
|
||||
# Website
|
||||
# OpenHands Documentation
|
||||
|
||||
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
|
||||
This website is built using [Docusaurus](https://docusaurus.io/).
|
||||
|
||||
When published, the content will be published at https://docs.all-hands.dev/.
|
||||
|
||||
### Installation
|
||||
|
||||
```
|
||||
```bash
|
||||
$ cd docs
|
||||
$ yarn
|
||||
```
|
||||
|
||||
### Local Development
|
||||
|
||||
```
|
||||
$ yarn start
|
||||
$ yarn start # for the default English version
|
||||
```
|
||||
|
||||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
||||
|
||||
Alternatively, you can pass a `--locale` argument to render a specific language in dev mode as in:
|
||||
|
||||
```
|
||||
$ yarn start --locale pt-BR # for the Brazilian Portuguese version
|
||||
$ yarn start --locale fr # for the French version
|
||||
$ yarn start --locale zh-Hans # for the Chinese Han (simplified variant) version
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```
|
||||
@@ -24,18 +35,26 @@ $ yarn build
|
||||
|
||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||
|
||||
It compiles all languages.
|
||||
|
||||
### Deployment
|
||||
|
||||
Using SSH:
|
||||
Open a new pull request and - when it is merged - the [deploy-docs](.github/workflows/deploy-docs.yml) GH action will take care of everything else.
|
||||
|
||||
```
|
||||
$ USE_SSH=true yarn deploy
|
||||
## Automatic Translations
|
||||
|
||||
Translations can be automatically updated when the original English content changes, this is done by the script [`translation_updater.py`](./translation_updater.py).
|
||||
|
||||
From the root of the repository, you can run the following:
|
||||
|
||||
```bash
|
||||
$ export ANTHROPIC_API_KEY=<your_api_key>
|
||||
$ poetry run python docs/translation_updater.py
|
||||
# ...
|
||||
# Change detected in docs/modules/usage/getting-started.mdx
|
||||
# translating... docs/modules/usage/getting-started.mdx pt-BR
|
||||
# translation done
|
||||
# ...
|
||||
```
|
||||
|
||||
Not using SSH:
|
||||
|
||||
```
|
||||
$ GIT_USER=<Your GitHub username> yarn deploy
|
||||
```
|
||||
|
||||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
||||
This process uses `claude-3-7-sonnet-20250219` as base model and each language consumes at least ~30k input tokens and ~35k output tokens.
|
||||
|
||||
@@ -1,30 +1,30 @@
|
||||
import type * as Preset from "@docusaurus/preset-classic";
|
||||
import type { Config } from "@docusaurus/types";
|
||||
import { themes as prismThemes } from "prism-react-renderer";
|
||||
import type * as Preset from '@docusaurus/preset-classic';
|
||||
import type { Config } from '@docusaurus/types';
|
||||
import { themes as prismThemes } from 'prism-react-renderer';
|
||||
|
||||
const config: Config = {
|
||||
title: "OpenHands",
|
||||
tagline: "Code Less, Make More",
|
||||
favicon: "img/logo-square.png",
|
||||
title: 'OpenHands',
|
||||
tagline: 'Code Less, Make More',
|
||||
favicon: 'img/logo-square.png',
|
||||
|
||||
// Set the production url of your site here
|
||||
url: "https://docs.all-hands.dev",
|
||||
baseUrl: "/",
|
||||
url: 'https://docs.all-hands.dev',
|
||||
baseUrl: '/',
|
||||
|
||||
// GitHub pages deployment config.
|
||||
organizationName: "All-Hands-AI",
|
||||
projectName: "OpenHands",
|
||||
organizationName: 'All-Hands-AI',
|
||||
projectName: 'OpenHands',
|
||||
trailingSlash: false,
|
||||
|
||||
onBrokenLinks: "throw",
|
||||
onBrokenMarkdownLinks: "warn",
|
||||
onBrokenLinks: 'throw',
|
||||
onBrokenMarkdownLinks: 'warn',
|
||||
|
||||
// Even if you don't use internationalization, you can use this field to set
|
||||
// useful metadata like html lang. For example, if your site is Chinese, you
|
||||
// may want to replace "en" with "zh-Hans".
|
||||
i18n: {
|
||||
defaultLocale: 'en',
|
||||
locales: ['en', 'fr', 'zh-Hans'],
|
||||
locales: ['en', 'fr', 'zh-Hans', 'ja', 'pt-BR'],
|
||||
localeConfigs: {
|
||||
en: {
|
||||
htmlLang: 'en-GB',
|
||||
@@ -36,64 +36,64 @@ const config: Config = {
|
||||
mermaid: true,
|
||||
},
|
||||
themes: ['@docusaurus/theme-mermaid'],
|
||||
plugins: [],
|
||||
presets: [
|
||||
[
|
||||
"classic",
|
||||
'classic',
|
||||
{
|
||||
docs: {
|
||||
path: "modules",
|
||||
routeBasePath: "modules",
|
||||
sidebarPath: "./sidebars.ts",
|
||||
path: 'modules',
|
||||
routeBasePath: 'modules',
|
||||
sidebarPath: './sidebars.ts',
|
||||
exclude: [
|
||||
// '**/_*.{js,jsx,ts,tsx,md,mdx}',
|
||||
// '**/_*/**',
|
||||
"**/*.test.{js,jsx,ts,tsx}",
|
||||
"**/__tests__/**",
|
||||
'**/*.test.{js,jsx,ts,tsx}',
|
||||
'**/__tests__/**',
|
||||
],
|
||||
},
|
||||
blog: {
|
||||
showReadingTime: true,
|
||||
},
|
||||
theme: {
|
||||
customCss: "./src/css/custom.css",
|
||||
customCss: './src/css/custom.css',
|
||||
},
|
||||
} satisfies Preset.Options,
|
||||
],
|
||||
],
|
||||
themeConfig: {
|
||||
image: "img/docusaurus.png",
|
||||
image: 'img/docusaurus.png',
|
||||
navbar: {
|
||||
title: "OpenHands",
|
||||
title: 'OpenHands',
|
||||
logo: {
|
||||
alt: "OpenHands",
|
||||
src: "img/logo.png",
|
||||
alt: 'OpenHands',
|
||||
src: 'img/logo.png',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: "docSidebar",
|
||||
sidebarId: "docsSidebar",
|
||||
position: "left",
|
||||
label: "User Guides",
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'docsSidebar',
|
||||
position: 'left',
|
||||
label: 'User Guides',
|
||||
},
|
||||
{
|
||||
type: "docSidebar",
|
||||
sidebarId: "apiSidebar",
|
||||
position: "left",
|
||||
label: "Python API",
|
||||
href: 'https://docs.all-hands.dev/swagger-ui/', // FIXME: this should be a relative path, but docusarus steals the click
|
||||
label: 'API',
|
||||
position: 'left',
|
||||
},
|
||||
{
|
||||
type: 'localeDropdown',
|
||||
position: 'left',
|
||||
},
|
||||
{
|
||||
href: "https://all-hands.dev",
|
||||
label: "Company",
|
||||
position: "right",
|
||||
href: 'https://all-hands.dev',
|
||||
label: 'Company',
|
||||
position: 'right',
|
||||
},
|
||||
{
|
||||
href: "https://github.com/All-Hands-AI/OpenHands",
|
||||
label: "GitHub",
|
||||
position: "right",
|
||||
href: 'https://github.com/All-Hands-AI/OpenHands',
|
||||
label: 'GitHub',
|
||||
position: 'right',
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
102
docs/generate-swagger-ui.js
Normal file
102
docs/generate-swagger-ui.js
Normal file
@@ -0,0 +1,102 @@
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const swaggerUiDist = require('swagger-ui-dist');
|
||||
|
||||
/**
|
||||
* This script manually sets up Swagger UI for the Docusaurus documentation.
|
||||
*
|
||||
* Why we need this approach:
|
||||
* 1. Docusaurus doesn't have a built-in way to integrate Swagger UI
|
||||
* 2. We need to copy the necessary files from swagger-ui-dist to our static directory
|
||||
* 3. We need to create a custom index.html file that points to our OpenAPI spec
|
||||
* 4. This approach allows us to customize the Swagger UI to match our documentation style
|
||||
*/
|
||||
|
||||
// Get the absolute path to the swagger-ui-dist package
|
||||
const swaggerUiDistPath = swaggerUiDist.getAbsoluteFSPath();
|
||||
|
||||
// Create the target directory if it doesn't exist
|
||||
const targetDir = path.join(__dirname, 'static', 'swagger-ui');
|
||||
if (!fs.existsSync(targetDir)) {
|
||||
fs.mkdirSync(targetDir, { recursive: true });
|
||||
}
|
||||
|
||||
// Copy all files from swagger-ui-dist to our target directory
|
||||
const files = fs.readdirSync(swaggerUiDistPath);
|
||||
files.forEach(file => {
|
||||
const sourcePath = path.join(swaggerUiDistPath, file);
|
||||
const targetPath = path.join(targetDir, file);
|
||||
|
||||
// Skip directories and non-essential files
|
||||
if (fs.statSync(sourcePath).isDirectory() ||
|
||||
file === 'package.json' ||
|
||||
file === 'README.md' ||
|
||||
file.endsWith('.map')) {
|
||||
return;
|
||||
}
|
||||
|
||||
fs.copyFileSync(sourcePath, targetPath);
|
||||
});
|
||||
|
||||
// Create a custom index.html file that points to our OpenAPI spec
|
||||
const indexHtml = `
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>OpenHands API Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
|
||||
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
|
||||
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
|
||||
<style>
|
||||
html {
|
||||
box-sizing: border-box;
|
||||
overflow: -moz-scrollbars-vertical;
|
||||
overflow-y: scroll;
|
||||
}
|
||||
|
||||
*,
|
||||
*:before,
|
||||
*:after {
|
||||
box-sizing: inherit;
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
background: #fafafa;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="swagger-ui"></div>
|
||||
|
||||
<script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
|
||||
<script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
|
||||
<script>
|
||||
window.onload = function() {
|
||||
// Begin Swagger UI call region
|
||||
const ui = SwaggerUIBundle({
|
||||
url: "/openapi.json",
|
||||
dom_id: '#swagger-ui',
|
||||
deepLinking: true,
|
||||
presets: [
|
||||
SwaggerUIBundle.presets.apis,
|
||||
SwaggerUIStandalonePreset
|
||||
],
|
||||
plugins: [
|
||||
SwaggerUIBundle.plugins.DownloadUrl
|
||||
],
|
||||
layout: "StandaloneLayout"
|
||||
});
|
||||
// End Swagger UI call region
|
||||
window.ui = ui;
|
||||
};
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
|
||||
fs.writeFileSync(path.join(targetDir, 'index.html'), indexHtml);
|
||||
|
||||
console.log('Swagger UI files generated successfully in static/swagger-ui/');
|
||||
@@ -402,5 +402,26 @@
|
||||
"theme.unlistedContent.message": {
|
||||
"message": "Cette page n'est pas répertoriée. Les moteurs de recherche ne l'indexeront pas, et seuls les utilisateurs ayant un lien direct peuvent y accéder.",
|
||||
"description": "The unlisted content banner message"
|
||||
},
|
||||
"Use AI to tackle the toil in your backlog. Our agents have all the same tools as a human developer: they can modify code, run commands, browse the web, call APIs, and yes-even copy code snippets from StackOverflow.": {
|
||||
"message": "Utilisez l'IA pour gérer les tâches répétitives de votre backlog. Nos agents disposent des mêmes outils qu'un développeur humain : ils peuvent modifier du code, exécuter des commandes, naviguer sur le web, appeler des API et même copier des extraits de code depuis StackOverflow."
|
||||
},
|
||||
"Get started with OpenHands.": {
|
||||
"message": "Commencer avec OpenHands"
|
||||
},
|
||||
"Most Popular Links": {
|
||||
"message": "Liens Populaires"
|
||||
},
|
||||
"Customizing OpenHands to a repository": {
|
||||
"message": "Personnaliser OpenHands pour un dépôt"
|
||||
},
|
||||
"Integrating OpenHands with Github": {
|
||||
"message": "Intégrer OpenHands avec Github"
|
||||
},
|
||||
"Recommended models to use": {
|
||||
"message": "Modèles recommandés"
|
||||
},
|
||||
"Connecting OpenHands to your filesystem": {
|
||||
"message": "Connecter OpenHands à votre système de fichiers"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -14,5 +14,197 @@
|
||||
"sidebar.apiSidebar.category.Backend": {
|
||||
"message": "Backend",
|
||||
"description": "The label for category Backend in sidebar apiSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.User Guides": {
|
||||
"message": "Guides d'Utilisateur",
|
||||
"description": "The label for category User Guides in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Running OpenHands": {
|
||||
"message": "Exécution d'OpenHands",
|
||||
"description": "The label for category Running OpenHands in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Prompting": {
|
||||
"message": "Prompting",
|
||||
"description": "The label for category Prompting in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Architecture": {
|
||||
"message": "Architecture",
|
||||
"description": "The label for category Architecture in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Running OpenHands": {
|
||||
"message": "Exécution d'OpenHands",
|
||||
"description": "The label for document Running OpenHands in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Getting Started": {
|
||||
"message": "Commencer",
|
||||
"description": "The label for document Getting Started in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Key Features": {
|
||||
"message": "Fonctionnalités Clés",
|
||||
"description": "The label for document Key Features in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Customization": {
|
||||
"message": "Personnalisation",
|
||||
"description": "The label for category Customization in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Usage Methods": {
|
||||
"message": "Méthodes d'Utilisation",
|
||||
"description": "The label for category Usage Methods in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Advanced Configuration": {
|
||||
"message": "Configuration Avancée",
|
||||
"description": "The label for category Advanced Configuration in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Troubleshooting": {
|
||||
"message": "Dépannage",
|
||||
"description": "The label for document Troubleshooting in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Feedback": {
|
||||
"message": "Retour d'Information",
|
||||
"description": "The label for document Feedback in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.For OpenHands Developers": {
|
||||
"message": "Pour les Développeurs OpenHands",
|
||||
"description": "The label for category For OpenHands Developers in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.About": {
|
||||
"message": "À Propos",
|
||||
"description": "The label for document About in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Best Practices": {
|
||||
"message": "Meilleures Pratiques",
|
||||
"description": "The label for document Best Practices in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Microagents": {
|
||||
"message": "Micro-agents",
|
||||
"description": "The label for category Microagents in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Overview": {
|
||||
"message": "Aperçu",
|
||||
"description": "The label for document Overview in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Repository": {
|
||||
"message": "Dépôt",
|
||||
"description": "The label for document Repository in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Public": {
|
||||
"message": "Public",
|
||||
"description": "The label for document Public in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Repository Customization": {
|
||||
"message": "Personnalisation du Dépôt",
|
||||
"description": "The label for document Repository Customization in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.GUI Mode": {
|
||||
"message": "Mode GUI",
|
||||
"description": "The label for document GUI Mode in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.CLI Mode": {
|
||||
"message": "Mode CLI",
|
||||
"description": "The label for document CLI Mode in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Headless Mode": {
|
||||
"message": "Mode Sans Interface",
|
||||
"description": "The label for document Headless Mode in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Github Action": {
|
||||
"message": "Action GitHub",
|
||||
"description": "The label for document Github Action in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Cloud": {
|
||||
"message": "Cloud",
|
||||
"description": "The label for category Cloud in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Openhands Cloud": {
|
||||
"message": "OpenHands Cloud",
|
||||
"description": "The label for document Openhands Cloud in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Cloud GitHub Resolver": {
|
||||
"message": "Résolveur GitHub Cloud",
|
||||
"description": "The label for document Cloud GitHub Resolver in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.LLM Configuration": {
|
||||
"message": "Configuration LLM",
|
||||
"description": "The label for category LLM Configuration in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Providers": {
|
||||
"message": "Fournisseurs",
|
||||
"description": "The label for category Providers in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Azure": {
|
||||
"message": "Azure",
|
||||
"description": "The label for document Azure in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Google": {
|
||||
"message": "Google",
|
||||
"description": "The label for document Google in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Groq": {
|
||||
"message": "Groq",
|
||||
"description": "The label for document Groq in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.LiteLLM Proxy": {
|
||||
"message": "Proxy LiteLLM",
|
||||
"description": "The label for document LiteLLM Proxy in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.OpenAI": {
|
||||
"message": "OpenAI",
|
||||
"description": "The label for document OpenAI in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.OpenRouter": {
|
||||
"message": "OpenRouter",
|
||||
"description": "The label for document OpenRouter in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Runtime Configuration": {
|
||||
"message": "Configuration d'Exécution",
|
||||
"description": "The label for category Runtime Configuration in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Docker Runtime": {
|
||||
"message": "Environnement Docker",
|
||||
"description": "The label for document Docker Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Remote Runtime": {
|
||||
"message": "Environnement Distant",
|
||||
"description": "The label for document Remote Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Modal Runtime": {
|
||||
"message": "Environnement Modal",
|
||||
"description": "The label for document Modal Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Daytona Runtime": {
|
||||
"message": "Environnement Daytona",
|
||||
"description": "The label for document Daytona Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Local Runtime": {
|
||||
"message": "Environnement Local",
|
||||
"description": "The label for document Local Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Configuration Options": {
|
||||
"message": "Options de Configuration",
|
||||
"description": "The label for document Configuration Options in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Custom Sandbox": {
|
||||
"message": "Bac à Sable Personnalisé",
|
||||
"description": "The label for document Custom Sandbox in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Development Overview": {
|
||||
"message": "Aperçu du Développement",
|
||||
"description": "The label for document Development Overview in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Backend": {
|
||||
"message": "Backend",
|
||||
"description": "The label for document Backend in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Runtime": {
|
||||
"message": "Environnement d'Exécution",
|
||||
"description": "The label for document Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Debugging": {
|
||||
"message": "Débogage",
|
||||
"description": "The label for document Debugging in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Evaluation": {
|
||||
"message": "Évaluation",
|
||||
"description": "The label for document Evaluation in sidebar docsSidebar"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,41 +11,39 @@ la priorité.
|
||||
|
||||
# Table des matières
|
||||
|
||||
1. [Configuration de base](#configuration-de-base)
|
||||
- [Clés API](#clés-api)
|
||||
- [Espace de travail](#espace-de-travail)
|
||||
- [Débogage et journalisation](#débogage-et-journalisation)
|
||||
- [Gestion des sessions](#gestion-des-sessions)
|
||||
- [Trajectoires](#trajectoires)
|
||||
- [Stockage de fichiers](#stockage-de-fichiers)
|
||||
- [Gestion des tâches](#gestion-des-tâches)
|
||||
- [Configuration du bac à sable](#configuration-du-bac-à-sable)
|
||||
- [Divers](#divers)
|
||||
2. [Configuration LLM](#configuration-llm)
|
||||
- [Informations d'identification AWS](#informations-didentification-aws)
|
||||
- [Configuration de l'API](#configuration-de-lapi)
|
||||
- [Fournisseur LLM personnalisé](#fournisseur-llm-personnalisé)
|
||||
1. [Configuration de base](#core-configuration)
|
||||
- [Clés API](#api-keys)
|
||||
- [Espace de travail](#workspace)
|
||||
- [Débogage et journalisation](#debugging-and-logging)
|
||||
- [Trajectoires](#trajectories)
|
||||
- [Stockage de fichiers](#file-store)
|
||||
- [Gestion des tâches](#task-management)
|
||||
- [Configuration du bac à sable](#sandbox-configuration)
|
||||
- [Divers](#miscellaneous)
|
||||
2. [Configuration LLM](#llm-configuration)
|
||||
- [Informations d'identification AWS](#aws-credentials)
|
||||
- [Configuration de l'API](#api-configuration)
|
||||
- [Fournisseur LLM personnalisé](#custom-llm-provider)
|
||||
- [Embeddings](#embeddings)
|
||||
- [Gestion des messages](#gestion-des-messages)
|
||||
- [Sélection du modèle](#sélection-du-modèle)
|
||||
- [Nouvelles tentatives](#nouvelles-tentatives)
|
||||
- [Options avancées](#options-avancées)
|
||||
3. [Configuration de l'agent](#configuration-de-lagent)
|
||||
- [Configuration du micro-agent](#configuration-du-micro-agent)
|
||||
- [Configuration de la mémoire](#configuration-de-la-mémoire)
|
||||
- [Configuration LLM](#configuration-llm-2)
|
||||
- [Configuration de l'espace d'action](#configuration-de-lespace-daction)
|
||||
- [Utilisation du micro-agent](#utilisation-du-micro-agent)
|
||||
4. [Configuration du bac à sable](#configuration-du-bac-à-sable-2)
|
||||
- [Exécution](#exécution)
|
||||
- [Image de conteneur](#image-de-conteneur)
|
||||
- [Mise en réseau](#mise-en-réseau)
|
||||
- [Linting et plugins](#linting-et-plugins)
|
||||
- [Dépendances et environnement](#dépendances-et-environnement)
|
||||
- [Évaluation](#évaluation)
|
||||
5. [Configuration de sécurité](#configuration-de-sécurité)
|
||||
- [Mode de confirmation](#mode-de-confirmation)
|
||||
- [Analyseur de sécurité](#analyseur-de-sécurité)
|
||||
- [Gestion des messages](#message-handling)
|
||||
- [Sélection du modèle](#model-selection)
|
||||
- [Nouvelles tentatives](#retrying)
|
||||
- [Options avancées](#advanced-options)
|
||||
3. [Configuration de l'agent](#agent-configuration)
|
||||
- [Configuration de la mémoire](#memory-configuration)
|
||||
- [Configuration LLM](#llm-configuration-1)
|
||||
- [Configuration de l'espace d'action](#actionspace-configuration)
|
||||
- [Utilisation du micro-agent](#microagent-usage)
|
||||
4. [Configuration du bac à sable](#sandbox-configuration-1)
|
||||
- [Exécution](#execution)
|
||||
- [Image de conteneur](#container-image)
|
||||
- [Mise en réseau](#networking)
|
||||
- [Linting et plugins](#linting-and-plugins)
|
||||
- [Dépendances et environnement](#dependencies-and-environment)
|
||||
- [Évaluation](#evaluation)
|
||||
5. [Configuration de sécurité](#security-configuration)
|
||||
- [Mode de confirmation](#confirmation-mode)
|
||||
- [Analyseur de sécurité](#security-analyzer)
|
||||
|
||||
---
|
||||
|
||||
@@ -356,12 +354,12 @@ Les options de configuration de l'agent sont définies dans les sections `[agent
|
||||
- Valeur par défaut : `true`
|
||||
- Description : Si l'appel de fonction est activé
|
||||
|
||||
- `codeact_enable_browsing`
|
||||
- `enable_browsing`
|
||||
- Type : `bool`
|
||||
- Valeur par défaut : `false`
|
||||
- Description : Si le délégué de navigation est activé dans l'espace d'action (fonctionne uniquement avec l'appel de fonction)
|
||||
|
||||
- `codeact_enable_llm_editor`
|
||||
- `enable_llm_editor`
|
||||
- Type : `bool`
|
||||
- Valeur par défaut : `false`
|
||||
- Description : Si l'éditeur LLM est activé dans l'espace d'action (fonctionne uniquement avec l'appel de fonction)
|
||||
|
||||
@@ -60,25 +60,7 @@ Félicitations !
|
||||
|
||||
## Explication technique
|
||||
|
||||
Lorsqu'une image personnalisée est utilisée pour la première fois, elle ne sera pas trouvée et donc elle sera construite (à l'exécution ultérieure, l'image construite sera trouvée et renvoyée).
|
||||
|
||||
L'image personnalisée est construite avec [_build_sandbox_image()](https://github.com/All-Hands-AI/OpenHands/blob/main/openhands/runtime/docker/image_agnostic_util.py#L29), qui crée un fichier docker en utilisant votre image personnalisée comme base et configure ensuite l'environnement pour OpenHands, comme ceci:
|
||||
|
||||
```python
|
||||
dockerfile_content = (
|
||||
f'FROM {base_image}\n'
|
||||
'RUN apt update && apt install -y openssh-server wget sudo\n'
|
||||
'RUN mkdir -p -m0755 /var/run/sshd\n'
|
||||
'RUN mkdir -p /openhands && mkdir -p /openhands/logs && chmod 777 /openhands/logs\n'
|
||||
'RUN wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"\n'
|
||||
'RUN bash Miniforge3-$(uname)-$(uname -m).sh -b -p /openhands/miniforge3\n'
|
||||
'RUN bash -c ". /openhands/miniforge3/etc/profile.d/conda.sh && conda config --set changeps1 False && conda config --append channels conda-forge"\n'
|
||||
'RUN echo "export PATH=/openhands/miniforge3/bin:$PATH" >> ~/.bashrc\n'
|
||||
'RUN echo "export PATH=/openhands/miniforge3/bin:$PATH" >> /openhands/bash.bashrc\n'
|
||||
).strip()
|
||||
```
|
||||
|
||||
> Remarque: Le nom de l'image est modifié via [_get_new_image_name()](https://github.com/All-Hands-AI/OpenHands/blob/main/openhands/runtime/docker/image_agnostic_util.py#L63) et c'est ce nom modifié qui sera recherché lors des exécutions ultérieures.
|
||||
Veuillez consulter le [chapitre sur les images Docker personnalisées dans la documentation d'exécution](https://docs.all-hands.dev/fr/modules/usage/architecture/runtime) pour obtenir des explications plus détaillées.
|
||||
|
||||
## Dépannage / Erreurs
|
||||
|
||||
|
||||
@@ -52,7 +52,7 @@ LLM_API_KEY="sk_test_12345"
|
||||
```bash
|
||||
docker run -it \
|
||||
--pull=always \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.28-nikolaik \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik \
|
||||
-e SANDBOX_USER_ID=$(id -u) \
|
||||
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
|
||||
-e LLM_API_KEY=$LLM_API_KEY \
|
||||
@@ -61,7 +61,7 @@ docker run -it \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
--name openhands-app-$(date +%Y%m%d%H%M%S) \
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.28 \
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.34 \
|
||||
python -m openhands.core.cli
|
||||
```
|
||||
|
||||
|
||||
@@ -21,14 +21,18 @@ OpenHands fournit un mode Interface Graphique (GUI) convivial pour interagir ave
|
||||
3. Entrez la `Clé API` correspondante pour le fournisseur choisi.
|
||||
4. Cliquez sur "Enregistrer" pour appliquer les paramètres.
|
||||
|
||||
### Configuration du Jeton GitHub
|
||||
### Jetons de Contrôle de Version
|
||||
|
||||
OpenHands prend en charge plusieurs fournisseurs de contrôle de version. Vous pouvez configurer des jetons pour plusieurs fournisseurs simultanément.
|
||||
|
||||
#### Configuration du Jeton GitHub
|
||||
|
||||
OpenHands exporte automatiquement un `GITHUB_TOKEN` vers l'environnement shell s'il est disponible. Cela peut se produire de deux manières :
|
||||
|
||||
1. **Localement (OSS)** : L'utilisateur saisit directement son jeton GitHub
|
||||
2. **En ligne (SaaS)** : Le jeton est obtenu via l'authentification OAuth GitHub
|
||||
|
||||
#### Configuration d'un Jeton GitHub Local
|
||||
##### Configuration d'un Jeton GitHub Local
|
||||
|
||||
1. **Générer un Personal Access Token (PAT)** :
|
||||
- Allez dans Paramètres GitHub > Paramètres développeur > Personal Access Tokens > Tokens (classique)
|
||||
@@ -40,11 +44,11 @@ OpenHands exporte automatiquement un `GITHUB_TOKEN` vers l'environnement shell s
|
||||
|
||||
2. **Entrer le Jeton dans OpenHands** :
|
||||
- Cliquez sur le bouton Paramètres (icône d'engrenage) en haut à droite
|
||||
- Accédez à la section "GitHub"
|
||||
- Accédez à la section "Git Provider Settings"
|
||||
- Collez votre jeton dans le champ "Jeton GitHub"
|
||||
- Cliquez sur "Enregistrer" pour appliquer les modifications
|
||||
|
||||
#### Politiques de Jetons Organisationnels
|
||||
##### Politiques de Jetons Organisationnels
|
||||
|
||||
Si vous travaillez avec des dépôts organisationnels, une configuration supplémentaire peut être nécessaire :
|
||||
|
||||
@@ -59,7 +63,7 @@ Si vous travaillez avec des dépôts organisationnels, une configuration supplé
|
||||
- Si nécessaire, cliquez sur "Activer SSO" à côté de votre organisation
|
||||
- Terminez le processus d'autorisation SSO
|
||||
|
||||
#### Authentification OAuth (Mode En Ligne)
|
||||
##### Authentification OAuth (Mode En Ligne)
|
||||
|
||||
Lorsque vous utilisez OpenHands en mode en ligne, le flux OAuth GitHub :
|
||||
|
||||
@@ -74,7 +78,7 @@ Lorsque vous utilisez OpenHands en mode en ligne, le flux OAuth GitHub :
|
||||
- Autorisez OpenHands à accéder à votre compte GitHub
|
||||
- Si vous utilisez une organisation, autorisez l'accès à l'organisation si vous y êtes invité
|
||||
|
||||
#### Dépannage
|
||||
##### Dépannage
|
||||
|
||||
Problèmes courants et solutions :
|
||||
|
||||
@@ -95,6 +99,43 @@ Problèmes courants et solutions :
|
||||
- Vérifiez la console du navigateur pour tout message d'erreur
|
||||
- Utilisez le bouton "Tester la connexion" dans les paramètres s'il est disponible
|
||||
|
||||
#### Configuration du Jeton GitLab
|
||||
|
||||
OpenHands exporte automatiquement un `GITLAB_TOKEN` vers l'environnement shell, uniquement pour les installations locales, s'il est disponible.
|
||||
|
||||
##### Configuration d'un Jeton GitLab
|
||||
|
||||
1. **Générer un Personal Access Token (PAT)** :
|
||||
- Sur GitLab, allez dans Paramètres utilisateur > Jetons d'accès
|
||||
- Créez un nouveau jeton avec les portées suivantes :
|
||||
- `api` (Accès API)
|
||||
- `read_user` (Lecture des informations utilisateur)
|
||||
- `read_repository` (Lecture du dépôt)
|
||||
- `write_repository` (Écriture du dépôt)
|
||||
- Définissez une date d'expiration ou laissez vide pour un jeton sans expiration
|
||||
|
||||
2. **Entrer le Jeton dans OpenHands** :
|
||||
- Cliquez sur le bouton Paramètres (icône d'engrenage)
|
||||
- Accédez à la section `Git Provider Settings`
|
||||
- Collez votre jeton dans le champ `Jeton GitLab`
|
||||
- Si vous utilisez GitLab auto-hébergé, entrez l'URL de votre instance GitLab
|
||||
- Cliquez sur `Enregistrer les modifications` pour appliquer les changements
|
||||
|
||||
##### Dépannage
|
||||
|
||||
Problèmes courants et solutions :
|
||||
|
||||
1. **Jeton Non Reconnu** :
|
||||
- Assurez-vous que le jeton est correctement enregistré dans les paramètres
|
||||
- Vérifiez que le jeton n'a pas expiré
|
||||
- Vérifiez que le jeton a les portées requises
|
||||
- Pour les instances auto-hébergées, vérifiez l'URL correcte de l'instance
|
||||
|
||||
2. **Accès Refusé** :
|
||||
- Vérifiez les permissions d'accès au projet
|
||||
- Vérifiez si le jeton possède les portées nécessaires
|
||||
- Pour les dépôts de groupe/organisation, assurez-vous d'avoir les accès appropriés
|
||||
|
||||
### Paramètres Avancés
|
||||
|
||||
1. Basculez sur `Options Avancées` pour accéder aux paramètres supplémentaires.
|
||||
|
||||
@@ -46,7 +46,7 @@ LLM_API_KEY="sk_test_12345"
|
||||
```bash
|
||||
docker run -it \
|
||||
--pull=always \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.28-nikolaik \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik \
|
||||
-e SANDBOX_USER_ID=$(id -u) \
|
||||
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
|
||||
-e LLM_API_KEY=$LLM_API_KEY \
|
||||
@@ -56,6 +56,6 @@ docker run -it \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
--name openhands-app-$(date +%Y%m%d%H%M%S) \
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.28 \
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.34 \
|
||||
python -m openhands.core.main -t "write a bash script that prints hi" --no-auto-continue
|
||||
```
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
|
||||
|
||||
# Installation
|
||||
# Exécution d'OpenHands
|
||||
|
||||
## Configuration système requise
|
||||
|
||||
@@ -13,16 +13,16 @@
|
||||
La façon la plus simple d'exécuter OpenHands est avec Docker.
|
||||
|
||||
```bash
|
||||
docker pull docker.all-hands.dev/all-hands-ai/runtime:0.28-nikolaik
|
||||
docker pull docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik
|
||||
|
||||
docker run -it --rm --pull=always \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.28-nikolaik \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik \
|
||||
-e LOG_ALL_EVENTS=true \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-p 3000:3000 \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
--name openhands-app \
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.28
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.34
|
||||
```
|
||||
|
||||
Vous pouvez également exécuter OpenHands en mode [headless scriptable](https://docs.all-hands.dev/modules/usage/how-to/headless-mode), en tant que [CLI interactive](https://docs.all-hands.dev/modules/usage/how-to/cli-mode), ou en utilisant l'[Action GitHub OpenHands](https://docs.all-hands.dev/modules/usage/how-to/github-action).
|
||||
|
||||
@@ -42,7 +42,7 @@ Explorez le code source d'OpenHands sur [GitHub](https://github.com/All-Hands-AI
|
||||
/>
|
||||
</a>
|
||||
<br></br>
|
||||
<a href="https://join.slack.com/t/openhands-ai/shared_invite/zt-2ypg5jweb-d~6hObZDbXi_HEL8PDrbHg">
|
||||
<a href="https://join.slack.com/t/openhands-ai/shared_invite/zt-2ngejmfw6-9gW4APWOC9XUp1n~SiQ6iw">
|
||||
<img
|
||||
src="https://img.shields.io/badge/Slack-Join%20Us-red?logo=slack&logoColor=white&style=for-the-badge"
|
||||
alt="Join our Slack community"
|
||||
|
||||
@@ -13,7 +13,7 @@ C'est le Runtime par défaut qui est utilisé lorsque vous démarrez OpenHands.
|
||||
|
||||
```
|
||||
docker run # ...
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.28-nikolaik \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
# ...
|
||||
```
|
||||
|
||||
427
docs/i18n/ja/code.json
Normal file
427
docs/i18n/ja/code.json
Normal file
@@ -0,0 +1,427 @@
|
||||
{
|
||||
"footer.title": {
|
||||
"message": "OpenHands"
|
||||
},
|
||||
"footer.docs": {
|
||||
"message": "ドキュメント"
|
||||
},
|
||||
"footer.community": {
|
||||
"message": "コミュニティ"
|
||||
},
|
||||
"footer.copyright": {
|
||||
"message": "© {year} OpenHands"
|
||||
},
|
||||
"faq.title": {
|
||||
"message": "よくある質問",
|
||||
"description": "FAQ Title"
|
||||
},
|
||||
"faq.description": {
|
||||
"message": "よくある質問"
|
||||
},
|
||||
"faq.section.title.1": {
|
||||
"message": "OpenHandsとは何ですか?",
|
||||
"description": "First Section Title"
|
||||
},
|
||||
"faq.section.highlight": {
|
||||
"message": "OpenHands",
|
||||
"description": "Highlight Text"
|
||||
},
|
||||
"faq.section.description.1": {
|
||||
"message": "はソフトウェアエンジニアリングとウェブナビゲーションのタスクをいつでも解決できる自律型ソフトウェアエンジニアです。「過去数ヶ月間のOpenHandsリポジトリへのプルリクエスト数を調べる」などのデータサイエンスクエリや、「このファイルにテストを追加して、すべてのテストが通るか確認してください。通らない場合は、ファイルを修正してください」などのソフトウェアエンジニアリングタスクを実行できます。",
|
||||
"description": "Description for OpenHands"
|
||||
},
|
||||
"faq.section.description.2": {
|
||||
"message": "さらに、OpenHandsは新しいエージェントをテストおよび評価したいエージェント開発者向けのプラットフォームとコミュニティでもあります。",
|
||||
"description": "Further Description for OpenHands"
|
||||
},
|
||||
"faq.section.title.2": {
|
||||
"message": "サポート",
|
||||
"description": "Support Section Title"
|
||||
},
|
||||
"faq.section.support.answer": {
|
||||
"message": "他のユーザーも同様に発生する可能性のある問題が発生した場合は、{githubLink}で報告してください。インストールに関する問題や一般的な質問がある場合は、{discordLink}または{slackLink}にご参加ください。",
|
||||
"description": "Support Answer"
|
||||
},
|
||||
"faq.section.title.3": {
|
||||
"message": "OpenHandsでGitHubの問題を解決するには?",
|
||||
"description": "GitHub Issue Section Title"
|
||||
},
|
||||
"faq.section.github.steps.intro": {
|
||||
"message": "OpenHandsを使用してGitHubの問題を解決するには、以下のようなステップを実行するようOpenHandsにコマンドを送信します:",
|
||||
"description": "GitHub Steps Introduction"
|
||||
},
|
||||
"faq.section.github.step1": {
|
||||
"message": "イシュー https://github.com/All-Hands-AI/OpenHands/issues/1611 を読む",
|
||||
"description": "GitHub Step 1"
|
||||
},
|
||||
"faq.section.github.step2": {
|
||||
"message": "リポジトリをクローンして新しいブランチをチェックアウトする",
|
||||
"description": "GitHub Step 2"
|
||||
},
|
||||
"faq.section.github.step3": {
|
||||
"message": "イシューの説明に基づいて、問題を解決するためにファイルを修正する",
|
||||
"description": "GitHub Step 3"
|
||||
},
|
||||
"faq.section.github.step4": {
|
||||
"message": "GITHUB_TOKEN環境変数を使用して結果をGitHubにプッシュする",
|
||||
"description": "GitHub Step 4"
|
||||
},
|
||||
"faq.section.github.step5": {
|
||||
"message": "プルリクエストを送信するために使用するリンクを教えてください",
|
||||
"description": "GitHub Step 5"
|
||||
},
|
||||
"faq.section.github.steps.preRun": {
|
||||
"message": "OpenHandsを起動する前に、以下を実行できます:",
|
||||
"description": "GitHub Steps Pre-Run"
|
||||
},
|
||||
"faq.section.github.steps.tokenInfo": {
|
||||
"message": "ここでXXXはあなたが作成したGitHubトークンで、OpenHandsリポジトリにプッシュする権限を持っています。OpenHandsリポジトリの変更権限がない場合は、次のように変更する必要があるかもしれません:",
|
||||
"description": "GitHub Steps Token Info"
|
||||
},
|
||||
"faq.section.github.steps.usernameInfo": {
|
||||
"message": "ここでUSERNAMEはあなたのGitHubユーザー名です。",
|
||||
"description": "GitHub Steps Username Info"
|
||||
},
|
||||
"faq.section.title.4": {
|
||||
"message": "OpenHandsはDevinとどう違いますか?",
|
||||
"description": "Devin Section Title"
|
||||
},
|
||||
"faq.section.openhands.linkText": {
|
||||
"message": "Devin",
|
||||
"description": "Devin Link Text"
|
||||
},
|
||||
"faq.section.openhands.description": {
|
||||
"message": "はCognition Inc.の商用製品で、OpenHandsの最初のインスピレーションとなりました。どちらもソフトウェアエンジニアリングの仕事をうまくこなすことを目指していますが、OpenHandsはダウンロード、使用、修正が可能である一方、DevinはCognitionのサイトを通じてのみ使用できます。さらに、OpenHandsは最初のインスピレーションを超えて進化し、現在はエージェント開発全般のためのコミュニティエコシステムとなっており、あなたの参加と",
|
||||
"description": "Devin Description"
|
||||
},
|
||||
"faq.section.openhands.contribute": {
|
||||
"message": "貢献",
|
||||
"description": "Contribute Link"
|
||||
},
|
||||
"faq.section.title.5": {
|
||||
"message": "OpenHandsはChatGPTとどう違いますか?",
|
||||
"description": "ChatGPT Section Title"
|
||||
},
|
||||
"faq.section.chatgpt.description": {
|
||||
"message": "ChatGPTはオンラインでアクセスでき、ローカルファイルに接続せず、コード実行能力も限られています。コードを書くことはできますが、テストや実行が難しいです。",
|
||||
"description": "ChatGPT Description"
|
||||
},
|
||||
"homepage.description": {
|
||||
"message": "ソフトウェアエンジニアリングのためのAIコード生成。",
|
||||
"description": "The homepage description"
|
||||
},
|
||||
"homepage.getStarted": {
|
||||
"message": "はじめる"
|
||||
},
|
||||
"welcome.message": {
|
||||
"message": "OpenHandsへようこそ。複雑なエンジニアリングタスクを実行し、ソフトウェア開発プロジェクトでユーザーと積極的に協力できる自律型AIソフトウェアエンジニアシステムです。"
|
||||
},
|
||||
"theme.ErrorPageContent.title": {
|
||||
"message": "このページはクラッシュしました。",
|
||||
"description": "The title of the fallback page when the page crashed"
|
||||
},
|
||||
"theme.BackToTopButton.buttonAriaLabel": {
|
||||
"message": "ページの先頭に戻る",
|
||||
"description": "The ARIA label for the back to top button"
|
||||
},
|
||||
"theme.blog.archive.title": {
|
||||
"message": "アーカイブ",
|
||||
"description": "The page & hero title of the blog archive page"
|
||||
},
|
||||
"theme.blog.archive.description": {
|
||||
"message": "アーカイブ",
|
||||
"description": "The page & hero description of the blog archive page"
|
||||
},
|
||||
"theme.blog.paginator.navAriaLabel": {
|
||||
"message": "ブログ記事リストのページネーション",
|
||||
"description": "The ARIA label for the blog pagination"
|
||||
},
|
||||
"theme.blog.paginator.newerEntries": {
|
||||
"message": "新しい記事",
|
||||
"description": "The label used to navigate to the newer blog posts page (previous page)"
|
||||
},
|
||||
"theme.blog.paginator.olderEntries": {
|
||||
"message": "古い記事",
|
||||
"description": "The label used to navigate to the older blog posts page (next page)"
|
||||
},
|
||||
"theme.blog.post.paginator.navAriaLabel": {
|
||||
"message": "ブログ記事のページネーション",
|
||||
"description": "The ARIA label for the blog posts pagination"
|
||||
},
|
||||
"theme.blog.post.paginator.newerPost": {
|
||||
"message": "新しい記事",
|
||||
"description": "The blog post button label to navigate to the newer/previous post"
|
||||
},
|
||||
"theme.blog.post.paginator.olderPost": {
|
||||
"message": "古い記事",
|
||||
"description": "The blog post button label to navigate to the older/next post"
|
||||
},
|
||||
"theme.blog.post.plurals": {
|
||||
"message": "1記事|{count}記事",
|
||||
"description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
|
||||
},
|
||||
"theme.blog.tagTitle": {
|
||||
"message": "「{tagName}」のタグが付いた{nPosts}",
|
||||
"description": "The title of the page for a blog tag"
|
||||
},
|
||||
"theme.tags.tagsPageLink": {
|
||||
"message": "すべてのタグを表示",
|
||||
"description": "The label of the link targeting the tag list page"
|
||||
},
|
||||
"theme.colorToggle.ariaLabel": {
|
||||
"message": "ダークモードとライトモードを切り替える(現在は{mode})",
|
||||
"description": "The ARIA label for the navbar color mode toggle"
|
||||
},
|
||||
"theme.colorToggle.ariaLabel.mode.dark": {
|
||||
"message": "ダークモード",
|
||||
"description": "The name for the dark color mode"
|
||||
},
|
||||
"theme.colorToggle.ariaLabel.mode.light": {
|
||||
"message": "ライトモード",
|
||||
"description": "The name for the light color mode"
|
||||
},
|
||||
"theme.docs.breadcrumbs.navAriaLabel": {
|
||||
"message": "パンくずリストナビゲーション",
|
||||
"description": "The ARIA label for the breadcrumbs"
|
||||
},
|
||||
"theme.docs.DocCard.categoryDescription.plurals": {
|
||||
"message": "1項目|{count}項目",
|
||||
"description": "The default description for a category card in the generated index about how many items this category includes"
|
||||
},
|
||||
"theme.docs.paginator.navAriaLabel": {
|
||||
"message": "ドキュメントページ",
|
||||
"description": "The ARIA label for the docs pagination"
|
||||
},
|
||||
"theme.docs.paginator.previous": {
|
||||
"message": "前へ",
|
||||
"description": "The label used to navigate to the previous doc"
|
||||
},
|
||||
"theme.docs.paginator.next": {
|
||||
"message": "次へ",
|
||||
"description": "The label used to navigate to the next doc"
|
||||
},
|
||||
"theme.docs.tagDocListPageTitle.nDocsTagged": {
|
||||
"message": "1つのドキュメントにタグ付け|{count}のドキュメントにタグ付け",
|
||||
"description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
|
||||
},
|
||||
"theme.docs.tagDocListPageTitle": {
|
||||
"message": "\"{tagName}\"で{nDocsTagged}",
|
||||
"description": "The title of the page for a docs tag"
|
||||
},
|
||||
"theme.docs.versionBadge.label": {
|
||||
"message": "バージョン: {versionLabel}"
|
||||
},
|
||||
"theme.docs.versions.unreleasedVersionLabel": {
|
||||
"message": "これは{siteTitle}の次期バージョン{versionLabel}のドキュメントです。",
|
||||
"description": "The label used to tell the user that he's browsing an unreleased doc version"
|
||||
},
|
||||
"theme.docs.versions.unmaintainedVersionLabel": {
|
||||
"message": "これは{siteTitle} {versionLabel}のドキュメントで、現在はアクティブにメンテナンスされていません。",
|
||||
"description": "The label used to tell the user that he's browsing an unmaintained doc version"
|
||||
},
|
||||
"theme.docs.versions.latestVersionSuggestionLabel": {
|
||||
"message": "最新のドキュメントについては、{latestVersionLink}({versionLabel})をご覧ください。",
|
||||
"description": "The label used to tell the user to check the latest version"
|
||||
},
|
||||
"theme.docs.versions.latestVersionLinkLabel": {
|
||||
"message": "最新バージョン",
|
||||
"description": "The label used for the latest version suggestion link label"
|
||||
},
|
||||
"theme.common.editThisPage": {
|
||||
"message": "このページを編集",
|
||||
"description": "The link label to edit the current page"
|
||||
},
|
||||
"theme.common.headingLinkTitle": {
|
||||
"message": "{heading}への直接リンク",
|
||||
"description": "Title for link to heading"
|
||||
},
|
||||
"theme.lastUpdated.atDate": {
|
||||
"message": " {date}に",
|
||||
"description": "The words used to describe on which date a page has been last updated"
|
||||
},
|
||||
"theme.lastUpdated.byUser": {
|
||||
"message": " {user}によって",
|
||||
"description": "The words used to describe by who the page has been last updated"
|
||||
},
|
||||
"theme.lastUpdated.lastUpdatedAtBy": {
|
||||
"message": "最終更新{atDate}{byUser}",
|
||||
"description": "The sentence used to display when a page has been last updated, and by who"
|
||||
},
|
||||
"theme.navbar.mobileVersionsDropdown.label": {
|
||||
"message": "バージョン",
|
||||
"description": "The label for the navbar versions dropdown on mobile view"
|
||||
},
|
||||
"theme.NotFound.title": {
|
||||
"message": "ページが見つかりません",
|
||||
"description": "The title of the 404 page"
|
||||
},
|
||||
"theme.tags.tagsListLabel": {
|
||||
"message": "タグ:",
|
||||
"description": "The label alongside a tag list"
|
||||
},
|
||||
"theme.admonition.caution": {
|
||||
"message": "注意",
|
||||
"description": "The default label used for the Caution admonition (:::caution)"
|
||||
},
|
||||
"theme.admonition.danger": {
|
||||
"message": "危険",
|
||||
"description": "The default label used for the Danger admonition (:::danger)"
|
||||
},
|
||||
"theme.admonition.info": {
|
||||
"message": "情報",
|
||||
"description": "The default label used for the Info admonition (:::info)"
|
||||
},
|
||||
"theme.admonition.note": {
|
||||
"message": "メモ",
|
||||
"description": "The default label used for the Note admonition (:::note)"
|
||||
},
|
||||
"theme.admonition.tip": {
|
||||
"message": "ヒント",
|
||||
"description": "The default label used for the Tip admonition (:::tip)"
|
||||
},
|
||||
"theme.admonition.warning": {
|
||||
"message": "警告",
|
||||
"description": "The default label used for the Warning admonition (:::warning)"
|
||||
},
|
||||
"theme.AnnouncementBar.closeButtonAriaLabel": {
|
||||
"message": "閉じる",
|
||||
"description": "The ARIA label for close button of announcement bar"
|
||||
},
|
||||
"theme.blog.sidebar.navAriaLabel": {
|
||||
"message": "最近のブログ記事ナビゲーション",
|
||||
"description": "The ARIA label for recent posts in the blog sidebar"
|
||||
},
|
||||
"theme.CodeBlock.copied": {
|
||||
"message": "コピーしました",
|
||||
"description": "The copied button label on code blocks"
|
||||
},
|
||||
"theme.CodeBlock.copyButtonAriaLabel": {
|
||||
"message": "コードをコピー",
|
||||
"description": "The ARIA label for copy code blocks button"
|
||||
},
|
||||
"theme.CodeBlock.copy": {
|
||||
"message": "コピー",
|
||||
"description": "The copy button label on code blocks"
|
||||
},
|
||||
"theme.CodeBlock.wordWrapToggle": {
|
||||
"message": "折り返し表示の切り替え",
|
||||
"description": "The title attribute for toggle word wrapping button of code block lines"
|
||||
},
|
||||
"theme.DocSidebarItem.expandCategoryAriaLabel": {
|
||||
"message": "サイドバーカテゴリ「{label}」を展開",
|
||||
"description": "The ARIA label to expand the sidebar category"
|
||||
},
|
||||
"theme.DocSidebarItem.collapseCategoryAriaLabel": {
|
||||
"message": "サイドバーカテゴリ「{label}」を折りたたむ",
|
||||
"description": "The ARIA label to collapse the sidebar category"
|
||||
},
|
||||
"theme.NavBar.navAriaLabel": {
|
||||
"message": "メイン",
|
||||
"description": "The ARIA label for the main navigation"
|
||||
},
|
||||
"theme.navbar.mobileLanguageDropdown.label": {
|
||||
"message": "言語",
|
||||
"description": "The label for the mobile language switcher dropdown"
|
||||
},
|
||||
"theme.NotFound.p1": {
|
||||
"message": "お探しのものが見つかりませんでした。",
|
||||
"description": "The first paragraph of the 404 page"
|
||||
},
|
||||
"theme.NotFound.p2": {
|
||||
"message": "元のURLにリンクしたサイトの所有者に連絡して、リンクが切れていることを知らせてください。",
|
||||
"description": "The 2nd paragraph of the 404 page"
|
||||
},
|
||||
"theme.TOCCollapsible.toggleButtonLabel": {
|
||||
"message": "このページの内容",
|
||||
"description": "The label used by the button on the collapsible TOC component"
|
||||
},
|
||||
"theme.blog.post.readMore": {
|
||||
"message": "もっと読む",
|
||||
"description": "The label used in blog post item excerpts to link to full blog posts"
|
||||
},
|
||||
"theme.blog.post.readMoreLabel": {
|
||||
"message": "{title}についてもっと読む",
|
||||
"description": "The ARIA label for the link to full blog posts from excerpts"
|
||||
},
|
||||
"theme.blog.post.readingTime.plurals": {
|
||||
"message": "1分で読めます|{readingTime}分で読めます",
|
||||
"description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
|
||||
},
|
||||
"theme.docs.breadcrumbs.home": {
|
||||
"message": "ホームページ",
|
||||
"description": "The ARIA label for the home page in the breadcrumbs"
|
||||
},
|
||||
"theme.docs.sidebar.collapseButtonTitle": {
|
||||
"message": "サイドバーを折りたたむ",
|
||||
"description": "The title attribute for collapse button of doc sidebar"
|
||||
},
|
||||
"theme.docs.sidebar.collapseButtonAriaLabel": {
|
||||
"message": "サイドバーを折りたたむ",
|
||||
"description": "The title attribute for collapse button of doc sidebar"
|
||||
},
|
||||
"theme.docs.sidebar.navAriaLabel": {
|
||||
"message": "ドキュメントサイドバーナビゲーション",
|
||||
"description": "The ARIA label for the sidebar navigation"
|
||||
},
|
||||
"theme.docs.sidebar.closeSidebarButtonAriaLabel": {
|
||||
"message": "ナビゲーションバーを閉じる",
|
||||
"description": "The ARIA label for close button of mobile sidebar"
|
||||
},
|
||||
"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": {
|
||||
"message": "← メインメニューに戻る",
|
||||
"description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"
|
||||
},
|
||||
"theme.docs.sidebar.toggleSidebarButtonAriaLabel": {
|
||||
"message": "ナビゲーションバーの開閉",
|
||||
"description": "The ARIA label for hamburger menu button of mobile navigation"
|
||||
},
|
||||
"theme.docs.sidebar.expandButtonTitle": {
|
||||
"message": "サイドバーを展開",
|
||||
"description": "The ARIA label and title attribute for expand button of doc sidebar"
|
||||
},
|
||||
"theme.docs.sidebar.expandButtonAriaLabel": {
|
||||
"message": "サイドバーを展開",
|
||||
"description": "The ARIA label and title attribute for expand button of doc sidebar"
|
||||
},
|
||||
"theme.ErrorPageContent.tryAgain": {
|
||||
"message": "再試行",
|
||||
"description": "The label of the button to try again rendering when the React error boundary captures an error"
|
||||
},
|
||||
"theme.common.skipToMainContent": {
|
||||
"message": "メインコンテンツに直接移動",
|
||||
"description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation"
|
||||
},
|
||||
"theme.tags.tagsPageTitle": {
|
||||
"message": "タグ",
|
||||
"description": "The title of the tag list page"
|
||||
},
|
||||
"theme.unlistedContent.title": {
|
||||
"message": "非公開ページ",
|
||||
"description": "The unlisted content banner title"
|
||||
},
|
||||
"theme.unlistedContent.message": {
|
||||
"message": "このページは非公開です。検索エンジンにインデックスされず、直接リンクを持つユーザーのみがアクセスできます。",
|
||||
"description": "The unlisted content banner message"
|
||||
},
|
||||
"Use AI to tackle the toil in your backlog. Our agents have all the same tools as a human developer: they can modify code, run commands, browse the web, call APIs, and yes-even copy code snippets from StackOverflow.": {
|
||||
"message": "AIを使用してバックログの作業を効率化しましょう。私たちのエージェントは人間の開発者と同じツールを持っています:コードの修正、コマンドの実行、ウェブの閲覧、APIの呼び出し、そしてStackOverflowからのコードスニペットのコピーさえも可能です。"
|
||||
},
|
||||
"Get started with OpenHands.": {
|
||||
"message": "OpenHandsを始める"
|
||||
},
|
||||
"Most Popular Links": {
|
||||
"message": "人気のリンク"
|
||||
},
|
||||
"Customizing OpenHands to a repository": {
|
||||
"message": "リポジトリ向けにOpenHandsをカスタマイズする"
|
||||
},
|
||||
"Integrating OpenHands with Github": {
|
||||
"message": "OpenHandsをGithubと統合する"
|
||||
},
|
||||
"Recommended models to use": {
|
||||
"message": "推奨モデル"
|
||||
},
|
||||
"Connecting OpenHands to your filesystem": {
|
||||
"message": "OpenHandsをファイルシステムに接続する"
|
||||
}
|
||||
}
|
||||
14
docs/i18n/ja/docusaurus-plugin-content-blog/options.json
Normal file
14
docs/i18n/ja/docusaurus-plugin-content-blog/options.json
Normal file
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"title": {
|
||||
"message": "ブログ",
|
||||
"description": "The title for the blog used in SEO"
|
||||
},
|
||||
"description": {
|
||||
"message": "OpenHands ブログ",
|
||||
"description": "The description for the blog used in SEO"
|
||||
},
|
||||
"sidebar.title": {
|
||||
"message": "最近の投稿",
|
||||
"description": "The label for the left sidebar"
|
||||
}
|
||||
}
|
||||
210
docs/i18n/ja/docusaurus-plugin-content-docs/current.json
Normal file
210
docs/i18n/ja/docusaurus-plugin-content-docs/current.json
Normal file
@@ -0,0 +1,210 @@
|
||||
{
|
||||
"version.label": {
|
||||
"message": "次のバージョン",
|
||||
"description": "The label for version current"
|
||||
},
|
||||
"sidebar.docsSidebar.category.🤖 Backends LLM": {
|
||||
"message": "🤖 LLMバックエンド",
|
||||
"description": "The label for category 🤖 Backends LLM in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.🚧 Dépannage": {
|
||||
"message": "🚧 トラブルシューティング",
|
||||
"description": "The label for category 🚧 Dépannage in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.apiSidebar.category.Backend": {
|
||||
"message": "バックエンド",
|
||||
"description": "The label for category Backend in sidebar apiSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.User Guides": {
|
||||
"message": "ユーザーガイド",
|
||||
"description": "The label for category User Guides in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Running OpenHands": {
|
||||
"message": "OpenHandsの実行",
|
||||
"description": "The label for category Running OpenHands in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Prompting": {
|
||||
"message": "プロンプト",
|
||||
"description": "The label for category Prompting in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Architecture": {
|
||||
"message": "アーキテクチャ",
|
||||
"description": "The label for category Architecture in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Running OpenHands": {
|
||||
"message": "OpenHandsの実行",
|
||||
"description": "The label for document Running OpenHands in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Getting Started": {
|
||||
"message": "はじめに",
|
||||
"description": "The label for document Getting Started in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Key Features": {
|
||||
"message": "主な機能",
|
||||
"description": "The label for document Key Features in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Customization": {
|
||||
"message": "カスタマイズ",
|
||||
"description": "The label for category Customization in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Usage Methods": {
|
||||
"message": "使用方法",
|
||||
"description": "The label for category Usage Methods in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Advanced Configuration": {
|
||||
"message": "高度な設定",
|
||||
"description": "The label for category Advanced Configuration in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Troubleshooting": {
|
||||
"message": "トラブルシューティング",
|
||||
"description": "The label for document Troubleshooting in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Feedback": {
|
||||
"message": "フィードバック",
|
||||
"description": "The label for document Feedback in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.For OpenHands Developers": {
|
||||
"message": "OpenHands開発者向け",
|
||||
"description": "The label for category For OpenHands Developers in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.About": {
|
||||
"message": "概要",
|
||||
"description": "The label for document About in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Best Practices": {
|
||||
"message": "ベストプラクティス",
|
||||
"description": "The label for document Best Practices in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Microagents": {
|
||||
"message": "マイクロエージェント",
|
||||
"description": "The label for category Microagents in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Overview": {
|
||||
"message": "概要",
|
||||
"description": "The label for document Overview in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Repository": {
|
||||
"message": "リポジトリ",
|
||||
"description": "The label for document Repository in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Public": {
|
||||
"message": "パブリック",
|
||||
"description": "The label for document Public in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Repository Customization": {
|
||||
"message": "リポジトリのカスタマイズ",
|
||||
"description": "The label for document Repository Customization in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.GUI Mode": {
|
||||
"message": "GUIモード",
|
||||
"description": "The label for document GUI Mode in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.CLI Mode": {
|
||||
"message": "CLIモード",
|
||||
"description": "The label for document CLI Mode in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Headless Mode": {
|
||||
"message": "ヘッドレスモード",
|
||||
"description": "The label for document Headless Mode in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Github Action": {
|
||||
"message": "GitHub アクション",
|
||||
"description": "The label for document Github Action in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Cloud": {
|
||||
"message": "クラウド",
|
||||
"description": "The label for category Cloud in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Openhands Cloud": {
|
||||
"message": "OpenHands クラウド",
|
||||
"description": "The label for document Openhands Cloud in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Cloud GitHub Resolver": {
|
||||
"message": "クラウド GitHub リゾルバー",
|
||||
"description": "The label for document Cloud GitHub Resolver in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.LLM Configuration": {
|
||||
"message": "LLM 設定",
|
||||
"description": "The label for category LLM Configuration in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Providers": {
|
||||
"message": "プロバイダー",
|
||||
"description": "The label for category Providers in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Azure": {
|
||||
"message": "Azure",
|
||||
"description": "The label for document Azure in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Google": {
|
||||
"message": "Google",
|
||||
"description": "The label for document Google in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Groq": {
|
||||
"message": "Groq",
|
||||
"description": "The label for document Groq in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.LiteLLM Proxy": {
|
||||
"message": "LiteLLM プロキシ",
|
||||
"description": "The label for document LiteLLM Proxy in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.OpenAI": {
|
||||
"message": "OpenAI",
|
||||
"description": "The label for document OpenAI in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.OpenRouter": {
|
||||
"message": "OpenRouter",
|
||||
"description": "The label for document OpenRouter in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.category.Runtime Configuration": {
|
||||
"message": "ランタイム設定",
|
||||
"description": "The label for category Runtime Configuration in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Docker Runtime": {
|
||||
"message": "Docker ランタイム",
|
||||
"description": "The label for document Docker Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Remote Runtime": {
|
||||
"message": "リモートランタイム",
|
||||
"description": "The label for document Remote Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Modal Runtime": {
|
||||
"message": "Modal ランタイム",
|
||||
"description": "The label for document Modal Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Daytona Runtime": {
|
||||
"message": "Daytona ランタイム",
|
||||
"description": "The label for document Daytona Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Local Runtime": {
|
||||
"message": "ローカルランタイム",
|
||||
"description": "The label for document Local Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Configuration Options": {
|
||||
"message": "設定オプション",
|
||||
"description": "The label for document Configuration Options in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Custom Sandbox": {
|
||||
"message": "カスタムサンドボックス",
|
||||
"description": "The label for document Custom Sandbox in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Development Overview": {
|
||||
"message": "開発概要",
|
||||
"description": "The label for document Development Overview in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Backend": {
|
||||
"message": "バックエンド",
|
||||
"description": "The label for document Backend in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Runtime": {
|
||||
"message": "ランタイム",
|
||||
"description": "The label for document Runtime in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Debugging": {
|
||||
"message": "デバッグ",
|
||||
"description": "The label for document Debugging in sidebar docsSidebar"
|
||||
},
|
||||
"sidebar.docsSidebar.doc.Evaluation": {
|
||||
"message": "評価",
|
||||
"description": "The label for document Evaluation in sidebar docsSidebar"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,88 @@
|
||||
# Python API
|
||||
|
||||
OpenHandsは、Pythonコードから直接使用できる豊富なAPIを提供しています。以下は、主要なAPIの概要です。
|
||||
|
||||
## OpenHands クライアント
|
||||
|
||||
```python
|
||||
from openhands import OpenHandsClient
|
||||
|
||||
# クライアントの初期化
|
||||
client = OpenHandsClient(
|
||||
api_key="your-api-key", # OpenAI APIキーなど
|
||||
model="gpt-4", # 使用するLLMモデル
|
||||
workspace="/path/to/workspace" # 作業ディレクトリ
|
||||
)
|
||||
|
||||
# タスクの実行
|
||||
result = client.execute_task("新しいPythonファイルを作成してください")
|
||||
|
||||
# 結果の取得
|
||||
print(result.success) # タスクが成功したかどうか
|
||||
print(result.output) # タスクの出力
|
||||
print(result.error) # エラーメッセージ(存在する場合)
|
||||
```
|
||||
|
||||
## サンドボックス設定
|
||||
|
||||
```python
|
||||
from openhands import SandboxConfig
|
||||
|
||||
# サンドボックス設定のカスタマイズ
|
||||
config = SandboxConfig(
|
||||
allowed_commands=["git", "python"], # 許可するコマンド
|
||||
timeout=300, # タイムアウト(秒)
|
||||
max_memory="2g", # メモリ制限
|
||||
network_access=True # ネットワークアクセスの許可
|
||||
)
|
||||
|
||||
# 設定を使用してクライアントを初期化
|
||||
client = OpenHandsClient(
|
||||
api_key="your-api-key",
|
||||
model="gpt-4",
|
||||
workspace="/path/to/workspace",
|
||||
sandbox_config=config
|
||||
)
|
||||
```
|
||||
|
||||
## イベントハンドリング
|
||||
|
||||
```python
|
||||
from openhands import OpenHandsClient
|
||||
|
||||
def on_progress(event):
|
||||
print(f"進捗: {event.message}")
|
||||
|
||||
def on_error(event):
|
||||
print(f"エラー: {event.error}")
|
||||
|
||||
# イベントハンドラーを設定してクライアントを初期化
|
||||
client = OpenHandsClient(
|
||||
api_key="your-api-key",
|
||||
model="gpt-4",
|
||||
workspace="/path/to/workspace",
|
||||
on_progress=on_progress,
|
||||
on_error=on_error
|
||||
)
|
||||
```
|
||||
|
||||
## 非同期API
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
from openhands import AsyncOpenHandsClient
|
||||
|
||||
async def main():
|
||||
# 非同期クライアントの初期化
|
||||
client = AsyncOpenHandsClient(
|
||||
api_key="your-api-key",
|
||||
model="gpt-4",
|
||||
workspace="/path/to/workspace"
|
||||
)
|
||||
|
||||
# タスクの非同期実行
|
||||
result = await client.execute_task("新しいPythonファイルを作成してください")
|
||||
print(result.output)
|
||||
|
||||
# 非同期メインの実行
|
||||
asyncio.run(main())
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"items": ["python/python"],
|
||||
"label": "バックエンド",
|
||||
"type": "categorie"
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
# OpenHands について
|
||||
|
||||
## 研究戦略
|
||||
|
||||
LLM を使用して本番レベルのアプリケーションを完全に複製することは複雑な endeavor です。私たちの戦略は以下の通りです:
|
||||
|
||||
- **コア技術研究:** コード生成と処理の技術的側面を理解し改善するための基礎研究に注力します。
|
||||
- **タスク計画:** バグ検出、コードベース管理、最適化の機能を開発します。
|
||||
- **評価:** 私たちのエージェントをより良く理解し改善するための包括的な評価指標を確立します。
|
||||
|
||||
## デフォルトエージェント
|
||||
|
||||
現在のデフォルトエージェントは、コードの生成とファイル処理が可能な [CodeActAgent](agents) です。
|
||||
|
||||
## 構築技術
|
||||
|
||||
OpenHands は、強力なフレームワークとライブラリを組み合わせて構築されており、開発のための堅牢な基盤を提供しています。
|
||||
プロジェクトで使用されている主要な技術は以下の通りです:
|
||||
|
||||
       
|
||||
|
||||
これらの技術の選択は進行中であり、プロジェクトの進化に伴って新しい技術が追加されたり、既存の技術が削除されたりする可能性があることに注意してください。
|
||||
私たちは OpenHands の機能を強化するために、最も適切で効率的なツールを採用するよう努めています。
|
||||
|
||||
## ライセンス
|
||||
|
||||
MIT [ライセンス](https://github.com/All-Hands-AI/OpenHands/blob/main/LICENSE) の下で配布されています。
|
||||
@@ -0,0 +1,23 @@
|
||||
# 🧠 メインエージェントと機能
|
||||
|
||||
## CodeActAgent
|
||||
|
||||
### 説明
|
||||
|
||||
このエージェントは、CodeActのアイデア ([論文](https://arxiv.org/abs/2402.01030), [ツイート](https://twitter.com/xingyaow_/status/1754556835703751087)) を実装しており、LLMエージェントの**行動**を、_シンプルさ_と_パフォーマンス_の両方のために、統一された**コード**行動空間に統合します。
|
||||
|
||||
概念的なアイデアは以下の図に示されています。各ターンで、エージェントは以下のことができます。
|
||||
|
||||
1. **会話**: 明確化、確認などのために、自然言語で人間とコミュニケーションをとる。
|
||||
2. **CodeAct**: コードを実行してタスクを実行することを選択する
|
||||
|
||||
- 任意の有効なLinux `bash`コマンドを実行する
|
||||
- [対話型Pythonインタープリター](https://ipython.org/)で任意の有効な`Python`コードを実行する。これは`bash`コマンドを通してシミュレートされます。詳細はプラグインシステムを参照してください。
|
||||
|
||||

|
||||
|
||||
### デモ
|
||||
|
||||
https://github.com/All-Hands-AI/OpenHands/assets/38853559/f592a192-e86c-4f48-ad31-d69282d5f6ac
|
||||
|
||||
_データサイエンスタスク(線形回帰)を実行する`gpt-4-turbo-2024-04-09`を使用したCodeActAgentの例_。
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# 🏛️ システムアーキテクチャの概要
|
||||
|
||||
以下は、システムアーキテクチャの高レベルな概要です。システムは主に2つのコンポーネントに分かれています: フロントエンドとバックエンドです。フロントエンドはユーザーとのインタラクションの管理と結果の表示を担当します。バックエンドはビジネスロジックの管理とエージェントの実行を担当します。
|
||||
|
||||

|
||||
|
||||
この概要は、主要なコンポーネントとそれらの相互作用を示すために簡略化されています。バックエンドアーキテクチャのより詳細なビューについては、[バックエンドアーキテクチャ](#backend-architecture-ja)のセクションを参照してください。
|
||||
|
||||
# バックエンドアーキテクチャ {#backend-architecture-ja}
|
||||
|
||||
_**注意**: バックエンドアーキテクチャは開発中であり、変更される可能性があります。以下の図は、図のフッターに示されているコミットに基づく現在のバックエンドアーキテクチャを示しています。_
|
||||
|
||||

|
||||
|
||||
<details>
|
||||
<summary>この図の更新</summary>
|
||||
<div>
|
||||
バックエンドアーキテクチャ図の生成は部分的に自動化されています。
|
||||
図はpy2pumlツールを使用してコード内の型アノテーションから生成されます。
|
||||
その後、図は手動でレビューされ、調整され、PNGとSVGにエクスポートされます。
|
||||
|
||||
## 前提条件
|
||||
|
||||
- openhandsが実行可能なPython環境
|
||||
(リポジトリのルートにあるREADME.mdファイルの指示に従って)
|
||||
- [py2puml](https://github.com/lucsorel/py2puml)がインストールされていること
|
||||
|
||||
## 手順
|
||||
|
||||
1. リポジトリのルートから以下のコマンドを実行して、図を自動的に生成します:
|
||||
`py2puml openhands openhands > docs/architecture/backend_architecture.puml`
|
||||
|
||||
2. 生成されたファイルをPlantUMLエディタ(Visual Studio CodeのPlantUML拡張機能や[PlantText](https://www.planttext.com/)など)で開きます。
|
||||
|
||||
3. 生成されたPUMLを確認し、図に必要な変更を加えます(欠落している部分を追加し、エラーを修正し、レイアウトを改善します)。
|
||||
_py2pumlはコード内の型アノテーションから図を作成するため、型アノテーションが欠落していたり正しくない場合、図が不完全または不正確になる可能性があります。_
|
||||
|
||||
4. 新しい図と以前の図の違いを確認し、変更が正しいかどうかを手動で確認します。
|
||||
_過去に図に手動で追加され、現在も関連性のある部分を削除しないように注意してください。_
|
||||
|
||||
5. 図の生成に使用されたコミットのハッシュを図のフッターに追加します。
|
||||
|
||||
6. 図をPNGファイルとSVGファイルにエクスポートし、`docs/architecture`ディレクトリ内の既存の図を置き換えます。これは(例えば[PlantText](https://www.planttext.com/)を使用して)行うことができます。
|
||||
|
||||
</div>
|
||||
</details>
|
||||
@@ -0,0 +1,53 @@
|
||||
# 🏛️ システムアーキテクチャ
|
||||
|
||||
<div style={{ textAlign: 'center' }}>
|
||||
<img src="https://github.com/All-Hands-AI/OpenHands/assets/16201837/97d747e3-29d8-4ccb-8d34-6ad1adb17f38" alt="OpenHands System Architecture Diagram Jul 4 2024" />
|
||||
<p><em>OpenHands システムアーキテクチャ図 (2024年7月4日)</em></p>
|
||||
</div>
|
||||
|
||||
これはシステムアーキテクチャの高レベルな概要です。システムはフロントエンドとバックエンドの2つの主要コンポーネントに分かれています。フロントエンドはユーザーインタラクションを処理し、結果を表示する役割を担います。バックエンドはビジネスロジックを処理し、エージェントを実行する役割を担います。
|
||||
|
||||
# フロントエンドアーキテクチャ {#frontend-architecture-ja}
|
||||
|
||||

|
||||
|
||||
この概要は、主要なコンポーネントとそれらの相互作用を示すために簡略化されています。バックエンドアーキテクチャのより詳細なビューについては、以下のバックエンドアーキテクチャのセクションを参照してください。
|
||||
|
||||
# バックエンドアーキテクチャ {#backend-architecture-ja}
|
||||
|
||||
_**免責事項**: バックエンドアーキテクチャは現在進行中の作業であり、変更される可能性があります。以下の図は、図のフッターに示されているコミットに基づくバックエンドの現在のアーキテクチャを示しています。_
|
||||
|
||||

|
||||
|
||||
<details>
|
||||
<summary>この図の更新</summary>
|
||||
<div>
|
||||
バックエンドアーキテクチャ図の生成は部分的に自動化されています。
|
||||
この図は、py2pumlツールを使用してコード内の型ヒントから生成されます。
|
||||
その後、図は手動でレビュー、調整され、PNGとSVGにエクスポートされます。
|
||||
|
||||
## 前提条件
|
||||
|
||||
- openhandsが実行可能なPython環境
|
||||
(リポジトリのルートにあるREADME.mdファイルの指示に従って)
|
||||
- [py2puml](https://github.com/lucsorel/py2puml)がインストールされていること
|
||||
|
||||
## 手順
|
||||
|
||||
1. リポジトリのルートから以下のコマンドを実行して、図を自動生成します:
|
||||
`py2puml openhands openhands > docs/architecture/backend_architecture.puml`
|
||||
|
||||
2. 生成されたファイルをPlantUMLエディタで開きます。例えば、PlantUML拡張機能を使用したVisual Studio Codeや[PlantText](https://www.planttext.com/)など。
|
||||
|
||||
3. 生成されたPUMLをレビューし、図に必要な調整を行います(欠落部分の追加、ミスの修正、位置の改善など)。
|
||||
_py2pumlは、コード内の型ヒントに基づいて図を作成するため、型ヒントが欠落していたり正しくない場合、図が不完全または不正確になることがあります。_
|
||||
|
||||
4. 新旧の図の差分をレビューし、変更が正しいかどうかを手動で確認します。
|
||||
_過去に図に手動で追加され、現在も関連性のある部分を削除しないように注意してください。_
|
||||
|
||||
5. 図のフッターに、図の生成に使用されたコミットのコミットハッシュを追加します。
|
||||
|
||||
6. 図をPNGとSVGファイルとしてエクスポートし、`docs/architecture`ディレクトリ内の既存の図を置き換えます。これは(例えば[PlantText](https://www.planttext.com/))で行うことができます。
|
||||
|
||||
</div>
|
||||
</details>
|
||||
@@ -0,0 +1,129 @@
|
||||
以下に翻訳結果を示します。
|
||||
|
||||
# 📦 Dockerランタイム
|
||||
|
||||
OpenHands Dockerランタイムは、AIエージェントのアクションを安全かつ柔軟に実行できるようにするコアコンポーネントです。
|
||||
Dockerを使用してサンドボックス化された環境を作成し、ホストシステムを危険にさらすことなく任意のコードを安全に実行できます。
|
||||
|
||||
## サンドボックス化されたランタイムが必要な理由
|
||||
|
||||
OpenHandsでは、いくつかの理由から、信頼できないコードを安全で隔離された環境で実行する必要があります。
|
||||
|
||||
1. セキュリティ: 信頼できないコードを実行すると、ホストシステムに重大なリスクを及ぼす可能性があります。サンドボックス化された環境では、悪意のあるコードがホストシステムのリソースにアクセスしたり、変更したりすることを防ぐことができます。
|
||||
2. 一貫性: サンドボックス化された環境では、異なるマシンやセットアップ間でコードの実行が一貫していることが保証され、「自分のマシンでは動作する」という問題が解消されます。
|
||||
3. リソース制御: サンドボックス化により、リソースの割り当てと使用をより適切に制御でき、暴走プロセスがホストシステムに影響を与えることを防ぐことができます。
|
||||
4. 分離: 異なるプロジェクトやユーザーは、ホストシステムや他のプロジェクトに干渉することなく、分離された環境で作業できます。
|
||||
5. 再現性: サンドボックス化された環境では、実行環境が一貫しており制御可能であるため、バグや問題を再現しやすくなります。
|
||||
|
||||
## ランタイムの仕組み
|
||||
|
||||
OpenHandsランタイムシステムは、Dockerコンテナを使用してクライアント-サーバーアーキテクチャを実装しています。以下は、その仕組みの概要です。
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A[ユーザー提供のカスタムDockerイメージ] --> B[OpenHandsバックエンド]
|
||||
B -->|ビルド| C[OHランタイムイメージ]
|
||||
C -->|起動| D[アクション実行サーバー]
|
||||
D -->|初期化| E[ブラウザ]
|
||||
D -->|初期化| F[Bashシェル]
|
||||
D -->|初期化| G[プラグイン]
|
||||
G -->|初期化| L[Jupyterサーバー]
|
||||
|
||||
B -->|生成| H[エージェント]
|
||||
B -->|生成| I[EventStream]
|
||||
I <--->|REST APIを介して
|
||||
アクションを実行し
|
||||
観測結果を取得
|
||||
| D
|
||||
|
||||
H -->|アクション生成| I
|
||||
I -->|観測結果取得| H
|
||||
|
||||
subgraph "Dockerコンテナ"
|
||||
D
|
||||
E
|
||||
F
|
||||
G
|
||||
L
|
||||
end
|
||||
```
|
||||
|
||||
1. ユーザー入力: ユーザーがカスタムベースDockerイメージを提供します。
|
||||
2. イメージのビルド: OpenHandsは、ユーザー提供のイメージをベースに新しいDockerイメージ(「OHランタイムイメージ」)をビルドします。この新しいイメージには、主に「ランタイムクライアント」であるOpenHands固有のコードが含まれます。
|
||||
3. コンテナの起動: OpenHandsが起動すると、OHランタイムイメージを使用してDockerコンテナが起動します。
|
||||
4. アクション実行サーバーの初期化: アクション実行サーバーは、コンテナ内で`ActionExecutor`を初期化し、Bashシェルなどの必要なコンポーネントをセットアップし、指定されたプラグインをロードします。
|
||||
5. 通信: OpenHandsバックエンド(`openhands/runtime/impl/eventstream/eventstream_runtime.py`)は、RESTful APIを介してアクション実行サーバーと通信し、アクションを送信し、観測結果を受信します。
|
||||
6. アクションの実行: ランタイムクライアントはバックエンドからアクションを受信し、サンドボックス化された環境内でそれらを実行し、観測結果を送り返します。
|
||||
7. 観測結果の返却: アクション実行サーバーは、実行結果を観測結果としてOpenHandsバックエンドに送り返します。
|
||||
|
||||
クライアントの役割:
|
||||
|
||||
- OpenHandsバックエンドとサンドボックス化された環境の間の仲介役を果たします。
|
||||
- コンテナ内で様々なタイプのアクション(シェルコマンド、ファイル操作、Pythonコードなど)を安全に実行します。
|
||||
- 現在の作業ディレクトリやロードされたプラグインなど、サンドボックス化された環境の状態を管理します。
|
||||
- 観測結果をフォーマットしてバックエンドに返し、結果を処理するための一貫したインターフェースを確保します。
|
||||
|
||||
## OpenHandsがOHランタイムイメージをビルドおよび管理する方法
|
||||
|
||||
OpenHandsのランタイムイメージのビルドと管理に対するアプローチは、本番環境と開発環境の両方でDockerイメージを効率的、一貫性のある、柔軟な方法で作成および維持することを保証します。
|
||||
|
||||
詳細に興味がある場合は、[関連コード](https://github.com/All-Hands-AI/OpenHands/blob/main/openhands/runtime/utils/runtime_build.py)をチェックしてください。
|
||||
|
||||
### イメージタグ付けシステム
|
||||
|
||||
OpenHandsは、再現性と柔軟性のバランスを取るために、ランタイムイメージに3つのタグシステムを使用しています。
|
||||
タグは以下の2つの形式のいずれかになります。
|
||||
|
||||
- **バージョン付きタグ**: `oh_v{openhands_version}_{base_image}` (例: `oh_v0.9.9_nikolaik_s_python-nodejs_t_python3.12-nodejs22`)
|
||||
- **ロックタグ**: `oh_v{openhands_version}_{16_digit_lock_hash}` (例: `oh_v0.9.9_1234567890abcdef`)
|
||||
- **ソースタグ**: `oh_v{openhands_version}_{16_digit_lock_hash}_{16_digit_source_hash}`
|
||||
(例: `oh_v0.9.9_1234567890abcdef_1234567890abcdef`)
|
||||
|
||||
#### ソースタグ - 最も具体的
|
||||
|
||||
これは、ソースディレクトリのディレクトリハッシュのMD5の最初の16桁です。これにより、openhandsソースのみのハッシュが得られます。
|
||||
|
||||
#### ロックタグ
|
||||
|
||||
このハッシュは、以下のMD5の最初の16桁から構築されます。
|
||||
|
||||
- イメージがビルドされたベースイメージの名前(例: `nikolaik/python-nodejs:python3.12-nodejs22`)
|
||||
- イメージに含まれる`pyproject.toml`の内容
|
||||
- イメージに含まれる`poetry.lock`の内容
|
||||
|
||||
これにより、ソースコードとは無関係に、Openhandsの依存関係のハッシュが効果的に得られます。
|
||||
|
||||
#### バージョン付きタグ - 最も一般的
|
||||
|
||||
このタグは、openhandsのバージョンとベースイメージ名(タグ標準に適合するように変換されたもの)を連結したものです。
|
||||
|
||||
#### ビルドプロセス
|
||||
|
||||
イメージを生成する際...
|
||||
|
||||
- **再ビルドなし**: OpenHandsは最初に、同じ**最も具体的なソースタグ**を持つイメージが存在するかどうかをチェックします。そのようなイメージが存在する場合、ビルドは実行されず、既存のイメージが使用されます。
|
||||
- **最速の再ビルド**: 次に、OpenHandsは**一般的なロックタグ**を持つイメージが存在するかどうかをチェックします。そのようなイメージが存在する場合、OpenHandsはそれに基づいて新しいイメージをビルドし、現在のソースコードをコピーする最終操作を除くすべてのインストール手順(`poetry install`や`apt-get`など)をバイパスします。新しいイメージには**ソース**タグのみが付けられます。
|
||||
- **まあまあの再ビルド**: **ソース**タグも**ロック**タグも存在しない場合、**バージョン付き**タグイメージに基づいてイメージがビルドされます。バージョン付きタグイメージでは、ほとんどの依存関係がすでにインストールされているため、時間を節約できます。
|
||||
- **最も遅い再ビルド**: 3つのタグのすべてが存在しない場合、ベースイメージに基づいて新しいイメージがビルドされます(これは遅い操作です)。この新しいイメージには、**ソース**、**ロック**、**バージョン付き**の各タグが付けられます。
|
||||
|
||||
このタグ付けアプローチにより、OpenHandsは開発環境と本番環境の両方を効率的に管理できます。
|
||||
|
||||
1. 同一のソースコードとDockerfileは、常に同じイメージを生成します(ハッシュベースのタグを介して)。
|
||||
2. 小さな変更が発生した場合、システムはイメージを迅速に再ビルドできます(最近の互換性のあるイメージを活用することで)。
|
||||
3. **ロック**タグ(例: `runtime:oh_v0.9.3_1234567890abcdef`)は、特定のベースイメージ、依存関係、およびOpenHandsバージョンの組み合わせに対する最新のビルドを常に指します。
|
||||
|
||||
## ランタイムプラグインシステム
|
||||
|
||||
OpenHandsランタイムは、機能を拡張し、ランタイム環境をカスタマイズできるプラグインシステムをサポートしています。プラグインは、ランタイムクライアントの起動時に初期化されます。
|
||||
|
||||
独自のプラグインを実装したい場合は、[Jupyterプラグインの例](https://github.com/All-Hands-AI/OpenHands/blob/ecf4aed28b0cf7c18d4d8ff554883ba182fc6bdd/openhands/runtime/plugins/jupyter/__init__.py#L21-L55)をチェックしてください。
|
||||
|
||||
*プラグインシステムの詳細はまだ作成中です - 貢献を歓迎します!*
|
||||
|
||||
プラグインシステムの主な側面:
|
||||
|
||||
1. プラグインの定義: プラグインは、基本の`Plugin`クラスを継承するPythonクラスとして定義されます。
|
||||
2. プラグインの登録: 利用可能なプラグインは、`ALL_PLUGINS`辞書に登録されます。
|
||||
3. プラグインの指定: プラグインは、`Agent.sandbox_plugins: list[PluginRequirement]`に関連付けられます。ユーザーは、ランタイムを初期化するときにロードするプラグインを指定できます。
|
||||
4. 初期化: プラグインは、ランタイムクライアントの起動時に非同期で初期化されます。
|
||||
5. 使用: ランタイムクライアントは、初期化されたプラグインを使用して機能を拡張できます(例: IPythonセルを実行するためのJupyterPlugin)。
|
||||
@@ -0,0 +1,381 @@
|
||||
# 設定オプション
|
||||
|
||||
このガイドでは、OpenHandsで利用可能なすべての設定オプションを詳しく説明し、その動作をカスタマイズし、他のサービスと統合するのに役立ちます。
|
||||
|
||||
:::note
|
||||
[GUIモード](https://docs.all-hands.dev/modules/usage/how-to/gui-mode)で実行している場合、設定UIで利用可能な設定が常に優先されます。
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
# 目次
|
||||
|
||||
1. [基本設定](#core-configuration)
|
||||
- [APIキー](#api-keys)
|
||||
- [ワークスペース](#workspace)
|
||||
- [デバッグとロギング](#debugging-and-logging)
|
||||
- [トラジェクトリ](#trajectories)
|
||||
- [ファイルストア](#file-store)
|
||||
- [タスク管理](#task-management)
|
||||
- [サンドボックス設定](#sandbox-configuration)
|
||||
- [その他](#miscellaneous)
|
||||
2. [LLM設定](#llm-configuration)
|
||||
- [AWS認証情報](#aws-credentials)
|
||||
- [API設定](#api-configuration)
|
||||
- [カスタムLLMプロバイダー](#custom-llm-provider)
|
||||
- [埋め込み](#embeddings)
|
||||
- [メッセージ処理](#message-handling)
|
||||
- [モデル選択](#model-selection)
|
||||
- [リトライ](#retrying)
|
||||
- [詳細オプション](#advanced-options)
|
||||
3. [エージェント設定](#agent-configuration)
|
||||
- [メモリ設定](#memory-configuration)
|
||||
- [LLM設定](#llm-configuration-1)
|
||||
- [アクションスペース設定](#actionspace-configuration)
|
||||
- [マイクロエージェントの使用](#microagent-usage)
|
||||
4. [サンドボックス設定](#sandbox-configuration-1)
|
||||
- [実行](#execution)
|
||||
- [コンテナイメージ](#container-image)
|
||||
- [ネットワーキング](#networking)
|
||||
- [リンティングとプラグイン](#linting-and-plugins)
|
||||
- [依存関係と環境](#dependencies-and-environment)
|
||||
- [評価](#evaluation)
|
||||
5. [セキュリティ設定](#security-configuration)
|
||||
- [確認モード](#confirmation-mode)
|
||||
- [セキュリティアナライザー](#security-analyzer)
|
||||
|
||||
---
|
||||
|
||||
## 基本設定
|
||||
|
||||
基本設定オプションは`config.toml`ファイルの`[core]`セクションで定義されます。
|
||||
|
||||
**APIキー**
|
||||
- `e2b_api_key`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: E2BのAPIキー
|
||||
|
||||
- `modal_api_token_id`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: ModalのAPIトークンID
|
||||
|
||||
- `modal_api_token_secret`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: ModalのAPIトークンシークレット
|
||||
|
||||
**ワークスペース**
|
||||
- `workspace_base`
|
||||
- 型: `str`
|
||||
- デフォルト値: `"./workspace"`
|
||||
- 説明: ワークスペースのベースパス
|
||||
|
||||
- `cache_dir`
|
||||
- 型: `str`
|
||||
- デフォルト値: `"/tmp/cache"`
|
||||
- 説明: キャッシュディレクトリのパス
|
||||
|
||||
**デバッグとロギング**
|
||||
- `debug`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `false`
|
||||
- 説明: デバッグを有効にする
|
||||
|
||||
- `disable_color`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `false`
|
||||
- 説明: ターミナル出力のカラー表示を無効にする
|
||||
|
||||
**トラジェクトリ**
|
||||
- `save_trajectory_path`
|
||||
- 型: `str`
|
||||
- デフォルト値: `"./trajectories"`
|
||||
- 説明: トラジェクトリを保存するパス(フォルダまたはファイル)。フォルダの場合、トラジェクトリはセッションIDと.json拡張子を持つファイルとしてそのフォルダに保存されます。
|
||||
|
||||
**ファイルストア**
|
||||
- `file_store_path`
|
||||
- 型: `str`
|
||||
- デフォルト値: `"/tmp/file_store"`
|
||||
- 説明: ファイルストアのパス
|
||||
|
||||
- `file_store`
|
||||
- 型: `str`
|
||||
- デフォルト値: `"memory"`
|
||||
- 説明: ファイルストアのタイプ
|
||||
|
||||
- `file_uploads_allowed_extensions`
|
||||
- 型: `list of str`
|
||||
- デフォルト値: `[".*"]`
|
||||
- 説明: アップロードを許可するファイル拡張子のリスト
|
||||
|
||||
- `file_uploads_max_file_size_mb`
|
||||
- 型: `int`
|
||||
- デフォルト値: `0`
|
||||
- 説明: アップロードの最大ファイルサイズ(メガバイト)
|
||||
|
||||
- `file_uploads_restrict_file_types`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `false`
|
||||
- 説明: ファイルアップロードのファイルタイプを制限する
|
||||
|
||||
**タスク管理**
|
||||
- `max_budget_per_task`
|
||||
- 型: `float`
|
||||
- デフォルト値: `0.0`
|
||||
- 説明: タスクごとの最大予算(0.0は制限なし)
|
||||
|
||||
- `max_iterations`
|
||||
- 型: `int`
|
||||
- デフォルト値: `100`
|
||||
- 説明: 最大イテレーション数
|
||||
|
||||
**サンドボックス設定**
|
||||
- `workspace_mount_path_in_sandbox`
|
||||
- 型: `str`
|
||||
- デフォルト値: `"/workspace"`
|
||||
- 説明: サンドボックス内のワークスペースマウントパス
|
||||
|
||||
- `workspace_mount_path`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: ワークスペースマウントパス
|
||||
|
||||
- `workspace_mount_rewrite`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: ワークスペースマウントパスを書き換えるパス。通常は無視できます。別のコンテナ内での実行の特殊なケースを参照します。
|
||||
|
||||
**その他**
|
||||
- `run_as_openhands`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `true`
|
||||
- 説明: OpenHandsとして実行する
|
||||
|
||||
- `runtime`
|
||||
- 型: `str`
|
||||
- デフォルト値: `"docker"`
|
||||
- 説明: 実行環境
|
||||
|
||||
- `default_agent`
|
||||
- 型: `str`
|
||||
- デフォルト値: `"CodeActAgent"`
|
||||
- 説明: デフォルトのエージェント名
|
||||
|
||||
- `jwt_secret`
|
||||
- 型: `str`
|
||||
- デフォルト値: `uuid.uuid4().hex`
|
||||
- 説明: 認証用のJWTシークレット。独自の値に設定してください。
|
||||
|
||||
## LLM設定
|
||||
|
||||
LLM(大規模言語モデル)設定オプションは`config.toml`ファイルの`[llm]`セクションで定義されます。
|
||||
|
||||
dockerコマンドで使用する場合は、`-e LLM_<option>`として渡します。例:`-e LLM_NUM_RETRIES`
|
||||
|
||||
:::note
|
||||
開発設定では、カスタムLLM設定も定義できます。詳細は[カスタムLLM設定](./llms/custom-llm-configs)を参照してください。
|
||||
:::
|
||||
|
||||
**AWS認証情報**
|
||||
- `aws_access_key_id`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: AWSアクセスキーID
|
||||
|
||||
- `aws_region_name`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: AWSリージョン名
|
||||
|
||||
- `aws_secret_access_key`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: AWSシークレットアクセスキー
|
||||
|
||||
**API設定**
|
||||
- `api_key`
|
||||
- 型: `str`
|
||||
- デフォルト値: `None`
|
||||
- 説明: 使用するAPIキー
|
||||
|
||||
- `base_url`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: APIのベースURL
|
||||
|
||||
- `api_version`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: APIバージョン
|
||||
|
||||
- `input_cost_per_token`
|
||||
- 型: `float`
|
||||
- デフォルト値: `0.0`
|
||||
- 説明: 入力トークンあたりのコスト
|
||||
|
||||
- `output_cost_per_token`
|
||||
- 型: `float`
|
||||
- デフォルト値: `0.0`
|
||||
- 説明: 出力トークンあたりのコスト
|
||||
|
||||
**カスタムLLMプロバイダー**
|
||||
- `custom_llm_provider`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: カスタムLLMプロバイダー
|
||||
|
||||
**埋め込み**
|
||||
- `embedding_base_url`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: 埋め込みAPIのベースURL
|
||||
|
||||
- `embedding_deployment_name`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: 埋め込みデプロイメント名
|
||||
|
||||
- `embedding_model`
|
||||
- 型: `str`
|
||||
- デフォルト値: `"local"`
|
||||
- 説明: 使用する埋め込みモデル
|
||||
|
||||
**メッセージ処理**
|
||||
- `max_message_chars`
|
||||
- 型: `int`
|
||||
- デフォルト値: `30000`
|
||||
- 説明: LLMプロンプトに含まれるイベントコンテンツの最大文字数(概算)。より大きな観察は切り捨てられます。
|
||||
|
||||
- `max_input_tokens`
|
||||
- 型: `int`
|
||||
- デフォルト値: `0`
|
||||
- 説明: 最大入力トークン数
|
||||
|
||||
- `max_output_tokens`
|
||||
- 型: `int`
|
||||
- デフォルト値: `0`
|
||||
- 説明: 最大出力トークン数
|
||||
|
||||
**モデル選択**
|
||||
- `model`
|
||||
- 型: `str`
|
||||
- デフォルト値: `"claude-3-5-sonnet-20241022"`
|
||||
- 説明: 使用するモデル
|
||||
|
||||
**リトライ**
|
||||
- `num_retries`
|
||||
- 型: `int`
|
||||
- デフォルト値: `8`
|
||||
- 説明: リトライ回数
|
||||
|
||||
- `retry_max_wait`
|
||||
- 型: `int`
|
||||
- デフォルト値: `120`
|
||||
- 説明: リトライ間の最大待機時間(秒)
|
||||
|
||||
- `retry_min_wait`
|
||||
- 型: `int`
|
||||
- デフォルト値: `15`
|
||||
- 説明: リトライ間の最小待機時間(秒)
|
||||
|
||||
- `retry_multiplier`
|
||||
- 型: `float`
|
||||
- デフォルト値: `2.0`
|
||||
- 説明: 指数バックオフ計算の乗数
|
||||
|
||||
**詳細オプション**
|
||||
- `drop_params`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `false`
|
||||
- 説明: マッピングされていない(サポートされていない)パラメータを例外を発生させずに削除する
|
||||
|
||||
- `caching_prompt`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `true`
|
||||
- 説明: LLMによって提供され、サポートされている場合、プロンプトキャッシュ機能を使用する
|
||||
|
||||
- `ollama_base_url`
|
||||
- 型: `str`
|
||||
- デフォルト値: `""`
|
||||
- 説明: OLLAMA APIのベースURL
|
||||
|
||||
- `temperature`
|
||||
- 型: `float`
|
||||
- デフォルト値: `0.0`
|
||||
- 説明: APIの温度パラメータ
|
||||
|
||||
- `timeout`
|
||||
- 型: `int`
|
||||
- デフォルト値: `0`
|
||||
- 説明: APIのタイムアウト
|
||||
|
||||
- `top_p`
|
||||
- 型: `float`
|
||||
- デフォルト値: `1.0`
|
||||
- 説明: APIのtop_pパラメータ
|
||||
|
||||
- `disable_vision`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `None`
|
||||
- 説明: モデルがビジョン機能を持つ場合、この設定で画像処理を無効にできます(コスト削減に有用)
|
||||
|
||||
## エージェント設定
|
||||
|
||||
エージェント設定オプションは`config.toml`ファイルの`[agent]`および`[agent.<agent_name>]`セクションで定義されます。
|
||||
|
||||
**メモリ設定**
|
||||
- `memory_enabled`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `false`
|
||||
- 説明: 長期メモリ(埋め込み)が有効かどうか
|
||||
|
||||
- `memory_max_threads`
|
||||
- 型: `int`
|
||||
- デフォルト値: `3`
|
||||
- 説明: 埋め込みのために同時にインデックスを作成する最大スレッド数
|
||||
|
||||
**LLM設定**
|
||||
- `llm_config`
|
||||
- 型: `str`
|
||||
- デフォルト値: `'your-llm-config-group'`
|
||||
- 説明: 使用するLLM設定の名前
|
||||
|
||||
**アクションスペース設定**
|
||||
- `function_calling`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `true`
|
||||
- 説明: 関数呼び出しが有効かどうか
|
||||
|
||||
- `enable_browsing`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `false`
|
||||
- 説明: アクションスペースでブラウジングデリゲートが有効かどうか(関数呼び出しでのみ機能)
|
||||
|
||||
- `enable_llm_editor`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `false`
|
||||
- 説明: アクションスペースでLLMエディタが有効かどうか(関数呼び出しでのみ機能)
|
||||
|
||||
**マイクロエージェントの使用**
|
||||
- `enable_prompt_extensions`
|
||||
- 型: `bool`
|
||||
- デフォルト値: `true`
|
||||
- 説明: マイクロエージェントの使用が有効かどうか
|
||||
|
||||
- `disabled_microagents`
|
||||
- 型: `list of str`
|
||||
- デフォルト値: `None`
|
||||
- 説明: 無効にするマイクロエージェントのリスト
|
||||
|
||||
### 実行
|
||||
- `timeout`
|
||||
- 型: `int`
|
||||
- デフォルト値: `120`
|
||||
- 説明: サンドボックスのタイムアウト(秒)
|
||||
|
||||
- `user_id`
|
||||
- 型: `int`
|
||||
- デフォルト値: `1000`
|
||||
- 説明: サンドボックスのユーザーID
|
||||
@@ -0,0 +1,81 @@
|
||||
# 💿 カスタム Docker サポートを作成する方法
|
||||
|
||||
デフォルトの OpenHands サンドボックスは、最小限の ubuntu 構成で提供されています。ユースケースによっては、デフォルトでインストールされているソフトウェアが必要になる場合があります。この記事では、カスタム docker イメージを使用してこれを実現する方法について説明します。
|
||||
|
||||
## セットアップ
|
||||
|
||||
[Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md) のドキュメントに従って、OpenHands を使用できるようにしてください。
|
||||
|
||||
## カスタム Docker イメージの作成
|
||||
|
||||
次に、debian/ubuntu ベースのカスタム docker イメージを作成する必要があります。たとえば、OpenHands で "node" バイナリにアクセスできるようにしたい場合は、次のような Dockerfile を使用します:
|
||||
|
||||
```bash
|
||||
# 最新の ubuntu イメージから開始
|
||||
FROM ubuntu:latest
|
||||
|
||||
# 必要なアップデートを実行
|
||||
RUN apt-get update && apt-get install
|
||||
|
||||
# nodejs をインストール
|
||||
RUN apt-get install -y nodejs
|
||||
```
|
||||
|
||||
次に、選択した名前でカスタム docker イメージをビルドします。たとえば、"custom_image" とします。そのためには、ディレクトリを作成し、"Dockerfile" という名前のファイルをその中に配置し、ディレクトリ内でこのコマンドを実行します:
|
||||
|
||||
```bash
|
||||
docker build -t custom_image .
|
||||
```
|
||||
|
||||
これにより、```custom_image``` という名前の新しいイメージが作成され、Docker Engine で利用できるようになります。
|
||||
|
||||
> 注: ここで説明する設定では、OpenHands はサンドボックス内で "openhands" ユーザーとして動作するため、Dockerfile 経由でインストールされたパッケージは、root だけでなくシステム上のすべてのユーザーが利用できるようになります。
|
||||
>
|
||||
> 上記の apt-get によるインストールでは、すべてのユーザー向けに nodejs がインストールされます。
|
||||
|
||||
## config.toml ファイルでカスタムイメージを指定
|
||||
|
||||
OpenHands の設定は、トップレベルの ```config.toml``` ファイルを介して行われます。
|
||||
OpenHands ディレクトリに ```config.toml``` ファイルを作成し、次の内容を入力します:
|
||||
|
||||
```toml
|
||||
[core]
|
||||
workspace_base="./workspace"
|
||||
run_as_openhands=true
|
||||
[sandbox]
|
||||
base_container_image="custom_image"
|
||||
```
|
||||
|
||||
> ```base_container_image``` が前述のカスタムイメージ名に設定されていることを確認してください。
|
||||
|
||||
## 実行
|
||||
|
||||
ルートディレクトリで ```make run``` を実行して OpenHands を起動します。
|
||||
|
||||
```localhost:3001``` に移動し、目的の依存関係が利用可能かどうかを確認します。
|
||||
|
||||
上記の例の場合、コンソールで ```node -v``` コマンドを実行すると ```v18.19.1``` が出力されます。
|
||||
|
||||
おめでとうございます!
|
||||
|
||||
## 技術的な説明
|
||||
|
||||
詳細な説明については、[実行時ドキュメントのカスタムDockerイメージの章](https://docs.all-hands.dev/ja/modules/usage/architecture/runtime)を参照してください。
|
||||
|
||||
## トラブルシューティング / エラー
|
||||
|
||||
### エラー: ```useradd: UID 1000 は一意ではありません```
|
||||
このエラーがコンソール出力に表示される場合、OpenHands がサンドボックス内に UID 1000 で openhands ユーザーを作成しようとしていますが、この UID は (何らかの理由で) イメージ内ですでに使用されているためです。この問題を解決するには、config.toml ファイルの user_id フィールドの値を別の値に変更します:
|
||||
|
||||
```toml
|
||||
[core]
|
||||
workspace_base="./workspace"
|
||||
run_as_openhands=true
|
||||
[sandbox]
|
||||
base_container_image="custom_image"
|
||||
user_id="1001"
|
||||
```
|
||||
|
||||
### ポート使用エラー
|
||||
|
||||
ポートが使用中または利用不可であることを示すエラーメッセージが表示される場合は、実行中のすべての docker コンテナを削除してみてください (`docker ps` を実行し、関連するコンテナに対して `docker rm` を実行します)。その後、```make run``` を再実行します。
|
||||
@@ -0,0 +1,40 @@
|
||||
# ✅ フィードバックの提供
|
||||
|
||||
OpenHandsを使用する際、うまくいく場合もあれば、そうでない場合もあります。開発チームにフィードバックを提供し、おそらくより重要なことですが、コーディングエージェントのトレーニング例のオープンなコーパスを作成するために、OpenHandsを使用する際にフィードバックを提供することをお勧めします -- Share-OpenHands!
|
||||
|
||||
## 📝 フィードバックの提供方法
|
||||
|
||||
フィードバックの提供は簡単です! OpenHandsを使用している際、インタラクションの任意のポイントで親指を上または下に向けるボタンを押すことができます。メールアドレスの入力を求められます (例: フォローアップの質問をしたい場合に連絡できるように)。また、フィードバックを公開するか非公開にするかを選択できます。
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/5rFx-StMVV0?si=svo7xzp6LhGK_GXr" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
|
||||
|
||||
## 📜 データの使用とプライバシー
|
||||
|
||||
### データ共有設定
|
||||
|
||||
データを送信する際、公開または非公開で送信できます。
|
||||
|
||||
- **公開**データは、OpenHands自体と同様にMITライセンスの下で配布され、コミュニティがモデルのトレーニングとテストに使用できます。明らかに、公開できるフィードバックは、コミュニティ全体にとってより価値があるでしょう。機密情報を扱っていない場合は、このオプションを選択することをお勧めします!
|
||||
- **非公開**データは、OpenHandsの改善を目的としてOpenHandsチームが利用できるようになります。ただし、一意のIDを持つリンクが作成され、他の人と公開で共有できます。
|
||||
|
||||
### データの収集と保存は誰が行うのか?
|
||||
|
||||
データは、OpenHandsのメンテナーによって設立されたOpenHandsのサポートと改善を目的とする企業である[All Hands AI](https://all-hands.dev)によって収集および保存されます。
|
||||
|
||||
### 公開データはどのようにリリースされるのか?
|
||||
|
||||
公開データは、1,000件の公開例、10,000件の公開例などの固定されたマイルストーンに達した時点でリリースされます。
|
||||
その際、以下のリリースプロセスに従います:
|
||||
|
||||
1. 公開フィードバックを提供したすべての人に、データのリリースについて説明し、オプトアウトする機会を与えるメールが送信されます。
|
||||
2. データリリースを担当する人は、データの品質管理を行い、低品質のフィードバックを削除し、
|
||||
提出者のメールアドレスを削除し、機密情報を削除するよう試みます。
|
||||
3. データは、GitHubやHugging Faceなどの一般的に使用されているサイトを通じて、MITライセンスの下で公開されます。
|
||||
|
||||
### データを削除したい場合はどうすればよいですか?
|
||||
|
||||
All Hands AIのサーバー上のデータについては、リクエストに応じて削除いたします:
|
||||
|
||||
**1つのデータ:** 1つのデータを削除したい場合、データ送信時にインターフェイスに表示されるリンクとパスワードを使用してデータを削除するメカニズムを近日中に追加する予定です。
|
||||
|
||||
**すべてのデータ:** すべてのデータを削除したい場合、またはデータ送信時に受け取ったIDとパスワードがない場合は、元のデータ送信時に登録したメールアドレスから`contact@all-hands.dev`までご連絡ください。
|
||||
@@ -0,0 +1,108 @@
|
||||
# OpenHandsを始める
|
||||
|
||||
[OpenHandsをインストール](./installation)し、[LLMを設定](./installation#setup)しました。次は何をしましょうか?
|
||||
|
||||
OpenHandsは、さまざまなエンジニアリングタスクを支援できます。しかし、この技術はまだ新しく、
|
||||
エージェントが支援なしで広範で複雑なエンジニアリングタスクを処理できるようになるまでには時間がかかります。
|
||||
そのため、エージェントが得意とすることと、支援が必要な部分を理解することが重要です。
|
||||
|
||||
## Hello World
|
||||
|
||||
最初に試してみたいのは、シンプルな「hello world」の例かもしれません。
|
||||
これは見た目以上に複雑になる可能性があります!
|
||||
|
||||
エージェントに以下のように依頼してみてください:
|
||||
> "hello world!"と表示するbashスクリプトhello.shを作成してください
|
||||
|
||||
エージェントがスクリプトを作成するだけでなく、適切な権限を設定し、
|
||||
スクリプトを実行して出力を確認することに気付くでしょう。
|
||||
|
||||
エージェントにコードの改良を続けて依頼することもできます。これはエージェントと
|
||||
作業する優れた方法です。シンプルに始めて、反復的に改良していきます。
|
||||
|
||||
> hello.shを修正して、最初の引数として名前を受け取るようにしてください。デフォルトは"world"にしてください
|
||||
|
||||
また、エージェントが環境のセットアップに時間を要する可能性はありますが、
|
||||
必要な任意の言語で作業することができます!
|
||||
|
||||
> hello.shをRubyスクリプトに変換して実行してください
|
||||
|
||||
## ゼロからの構築
|
||||
|
||||
エージェントは、「グリーンフィールド」タスク(既存のコードベースに関する文脈を必要としないタスク)で
|
||||
特に優れた性能を発揮し、ゼロから始めることができます。
|
||||
|
||||
シンプルなタスクから始めて、反復的に改良していくのがベストです。また、
|
||||
要望する内容、使用する技術スタックなどについて、できるだけ具体的に指定することをお勧めします。
|
||||
|
||||
例えば、TODOアプリケーションを構築できます:
|
||||
|
||||
> フロントエンドのみのReactベースの基本的なTODOリストアプリケーションを作成してください。
|
||||
> すべての状態はlocalStorageに保存してください。
|
||||
|
||||
基本的な構造ができたら、アプリケーションの改良を続けることができます:
|
||||
|
||||
> 各タスクにオプションの期限を追加できるようにしてください
|
||||
|
||||
通常の開発と同様に、頻繁にコミットとプッシュを行うことをお勧めします。
|
||||
これにより、エージェントが予期せぬ方向に進んだ場合でも、以前の状態に戻ることができます。
|
||||
エージェントにコミットとプッシュを依頼することもできます:
|
||||
|
||||
> 変更をコミットして、"feature/due-dates"という新しいブランチにプッシュしてください
|
||||
|
||||
## 新しいコードの追加
|
||||
|
||||
OpenHandsは、既存のコードベースに新しいコードを追加する作業も優れています。
|
||||
|
||||
例えば、OpenHandsにコードを分析するGitHubアクションをプロジェクトに追加するよう依頼できます。
|
||||
OpenHandsはコードベースを確認して使用すべき言語を判断し、新しいファイルを
|
||||
`./github/workflows/lint.yml`に作成できます。
|
||||
|
||||
> このリポジトリのコードを分析するGitHubアクションを追加してください
|
||||
|
||||
一部のタスクではより多くの文脈が必要かもしれません。OpenHandsは`ls`や`grep`を使用して
|
||||
コードベースを検索できますが、事前に文脈を提供することで、より速く、より正確に作業を
|
||||
進めることができます。また、トークンの消費も少なくなります!
|
||||
|
||||
> ./backend/api/routes.jsを修正して、すべてのタスクのリストを返す新しいルートを追加してください
|
||||
|
||||
> ./frontend/componentsディレクトリにWidgetのリストを表示する新しいReactコンポーネントを追加してください。
|
||||
> 既存のWidgetコンポーネントを使用する必要があります。
|
||||
|
||||
## リファクタリング
|
||||
|
||||
OpenHandsは、特に小規模な既存コードのリファクタリングに優れています。
|
||||
コードベース全体のアーキテクチャを変更しようとするのは避けた方がよいですが、
|
||||
長いファイルや関数の分割、変数名の変更などは非常にうまく機能する傾向があります。
|
||||
|
||||
> ./app.goの1文字の変数名をすべて変更してください
|
||||
|
||||
> widget.phpの`build_and_deploy_widgets`関数を`build_widgets`と`deploy_widgets`の2つの関数に分割してください
|
||||
|
||||
> ./api/routes.jsを各ルートごとの別々のファイルに分割してください
|
||||
|
||||
## バグ修正
|
||||
|
||||
OpenHandsは、コードのバグの追跡と修正も支援できます。しかし、すべての
|
||||
開発者が知っているように、バグ修正は非常に繊細な作業になる可能性があり、多くの場合OpenHandsはより多くの文脈を
|
||||
必要とします。バグを診断済みで、OpenHandsにロジックを理解してもらいたい場合に特に役立ちます。
|
||||
|
||||
> 現在、`/subscribe`エンドポイントのemailフィールドが.ioドメインを拒否しています。これを修正してください。
|
||||
|
||||
> ./app.pyの`search_widgets`関数が大文字小文字を区別して検索を行っています。大文字小文字を区別しないように修正してください。
|
||||
|
||||
エージェントとバグを修正する際は、テスト駆動開発を行うと便利なことが多いです。
|
||||
エージェントに新しいテストを書かせ、バグが修正されるまで反復することができます:
|
||||
|
||||
> `hello`関数が空文字列でクラッシュします。このバグを再現するテストを書いて、コードを修正してテストが通るようにしてください。
|
||||
|
||||
## その他
|
||||
|
||||
OpenHandsは、ほぼすべてのコーディングタスクを支援できます。しかし、最大限に
|
||||
活用するには練習が必要です。以下の点を忘れないでください:
|
||||
* タスクを小さく保つ
|
||||
* できるだけ具体的に指定する
|
||||
* できるだけ多くの文脈を提供する
|
||||
* 頻繁にコミットとプッシュを行う
|
||||
|
||||
OpenHandsを最大限に活用する方法についての詳細なアドバイスは、[プロンプトのベストプラクティス](./prompting/prompting-best-practices)をご覧ください。
|
||||
@@ -0,0 +1,95 @@
|
||||
# CLI モード
|
||||
|
||||
OpenHands は対話型の CLI モードで実行できます。これにより、ユーザーはコマンドラインから対話型セッションを開始できます。
|
||||
|
||||
このモードは、非対話型でスクリプティングに適した [ヘッドレスモード](headless-mode) とは異なります。
|
||||
|
||||
## Python を使用する場合
|
||||
|
||||
コマンドラインから対話型の OpenHands セッションを開始するには:
|
||||
|
||||
1. [開発セットアップの手順](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md) に従っていることを確認してください。
|
||||
2. 以下のコマンドを実行します:
|
||||
|
||||
```bash
|
||||
poetry run python -m openhands.core.cli
|
||||
```
|
||||
|
||||
このコマンドを実行すると、タスクを入力して OpenHands からレスポンスを受け取ることができる対話型セッションが開始されます。
|
||||
|
||||
環境変数 [または `config.toml` ファイル](https://github.com/All-Hands-AI/OpenHands/blob/main/config.template.toml) を使用して、モデル、API キー、その他の設定を確実に設定する必要があります。
|
||||
|
||||
## Docker を使用する場合
|
||||
|
||||
Docker で OpenHands を CLI モードで実行するには:
|
||||
|
||||
1. ターミナルで以下の環境変数を設定します:
|
||||
|
||||
- `WORKSPACE_BASE` を OpenHands に編集させたいディレクトリに設定 (例: `export WORKSPACE_BASE=$(pwd)/workspace`)。
|
||||
- `LLM_MODEL` を使用するモデルに設定 (例: `export LLM_MODEL="anthropic/claude-3-5-sonnet-20241022"`)。
|
||||
- `LLM_API_KEY` を API キーに設定 (例: `export LLM_API_KEY="sk_test_12345"`)。
|
||||
|
||||
2. 以下の Docker コマンドを実行します:
|
||||
|
||||
```bash
|
||||
docker run -it \
|
||||
--pull=always \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik \
|
||||
-e SANDBOX_USER_ID=$(id -u) \
|
||||
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
|
||||
-e LLM_API_KEY=$LLM_API_KEY \
|
||||
-e LLM_MODEL=$LLM_MODEL \
|
||||
-v $WORKSPACE_BASE:/opt/workspace_base \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-v ~/.openhands-state:/.openhands-state \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
--name openhands-app-$(date +%Y%m%d%H%M%S) \
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.34 \
|
||||
python -m openhands.core.cli
|
||||
```
|
||||
|
||||
このコマンドを実行すると、Docker 内で対話型セッションが開始され、タスクを入力して OpenHands からレスポンスを受け取ることができます。
|
||||
|
||||
## CLI コマンドと期待される出力の例
|
||||
|
||||
CLI コマンドとその期待される出力の例を以下に示します:
|
||||
|
||||
### 例1: シンプルなタスク
|
||||
|
||||
```bash
|
||||
>> "Hello, World!" と出力する Python スクリプトを書いてください
|
||||
```
|
||||
|
||||
期待される出力:
|
||||
|
||||
```bash
|
||||
🤖 はい! "Hello, World!" と出力する Python スクリプトは以下のようになります:
|
||||
|
||||
❯ print("Hello, World!")
|
||||
```
|
||||
|
||||
### 例2: Bash コマンド
|
||||
|
||||
```bash
|
||||
>> "test_dir" という名前のディレクトリを作成してください
|
||||
```
|
||||
|
||||
期待される出力:
|
||||
|
||||
```bash
|
||||
🤖 "test_dir" という名前のディレクトリを作成します:
|
||||
|
||||
❯ mkdir test_dir
|
||||
```
|
||||
|
||||
### 例3: エラー処理
|
||||
|
||||
```bash
|
||||
>> 存在しないファイルを削除してください
|
||||
```
|
||||
|
||||
期待される出力:
|
||||
|
||||
```bash
|
||||
🤖 エラーが発生しました。もう一度お試しください。
|
||||
```
|
||||
@@ -0,0 +1,92 @@
|
||||
# カスタムサンドボックス
|
||||
|
||||
サンドボックスは、エージェントがタスクを実行する場所です。コンピュータ上で直接コマンドを実行する(これはリスクがある可能性があります)代わりに、エージェントはDockerコンテナ内でそれらを実行します。
|
||||
|
||||
デフォルトのOpenHandsサンドボックス([nikolaik/python-nodejs](https://hub.docker.com/r/nikolaik/python-nodejs)の`python-nodejs:python3.12-nodejs22`)にはPythonやNode.jsなどのパッケージがインストールされていますが、デフォルトでインストールする必要のある他のソフトウェアがある場合があります。
|
||||
|
||||
カスタマイズには2つのオプションがあります:
|
||||
|
||||
- 必要なソフトウェアがインストールされている既存のイメージを使用する。
|
||||
- 独自のカスタムDockerイメージを作成する。
|
||||
|
||||
最初のオプションを選択した場合は、`Dockerイメージの作成`セクションをスキップできます。
|
||||
|
||||
## Dockerイメージの作成
|
||||
|
||||
カスタムDockerイメージを作成するには、Debianベースである必要があります。
|
||||
|
||||
たとえば、OpenHandsに`ruby`をインストールしたい場合は、次の内容で`Dockerfile`を作成できます:
|
||||
|
||||
```dockerfile
|
||||
FROM nikolaik/python-nodejs:python3.12-nodejs22
|
||||
|
||||
# 必要なパッケージをインストール
|
||||
RUN apt-get update && apt-get install -y ruby
|
||||
```
|
||||
|
||||
または、Ruby固有のベースイメージを使用することもできます:
|
||||
|
||||
```dockerfile
|
||||
FROM ruby:latest
|
||||
```
|
||||
|
||||
このファイルをフォルダに保存します。次に、ターミナルでフォルダに移動し、次のコマンドを実行して、Dockerイメージ(たとえば、custom-imageという名前)をビルドします:
|
||||
|
||||
```bash
|
||||
docker build -t custom-image .
|
||||
```
|
||||
|
||||
これにより、`custom-image`という新しいイメージが作成され、Dockerで利用できるようになります。
|
||||
|
||||
## Dockerコマンドの使用
|
||||
|
||||
[dockerコマンド](/modules/usage/installation#start-the-app)を使用してOpenHandsを実行する場合は、`-e SANDBOX_RUNTIME_CONTAINER_IMAGE=...`を`-e SANDBOX_BASE_CONTAINER_IMAGE=<カスタムイメージ名>`に置き換えます:
|
||||
|
||||
```commandline
|
||||
docker run -it --rm --pull=always \
|
||||
-e SANDBOX_BASE_CONTAINER_IMAGE=custom-image \
|
||||
...
|
||||
```
|
||||
|
||||
## 開発ワークフローの使用
|
||||
|
||||
### セットアップ
|
||||
|
||||
まず、[Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)の手順に従って、OpenHandsを実行できることを確認してください。
|
||||
|
||||
### ベースサンドボックスイメージの指定
|
||||
|
||||
OpenHandsディレクトリ内の`config.toml`ファイルで、`base_container_image`を使用するイメージに設定します。これは、すでにプルしたイメージまたは構築したイメージにすることができます:
|
||||
|
||||
```bash
|
||||
[core]
|
||||
...
|
||||
[sandbox]
|
||||
base_container_image="custom-image"
|
||||
```
|
||||
|
||||
### その他の設定オプション
|
||||
|
||||
`config.toml`ファイルは、サンドボックスをカスタマイズするためのいくつかの他のオプションをサポートしています:
|
||||
|
||||
```toml
|
||||
[core]
|
||||
# ランタイムのビルド時に追加の依存関係をインストールする
|
||||
# 有効なシェルコマンドを含めることができる
|
||||
# これらのコマンドのいずれかでPythonインタープリターへのパスが必要な場合は、$OH_INTERPRETER_PATH変数を使用できる
|
||||
runtime_extra_deps = """
|
||||
pip install numpy pandas
|
||||
apt-get update && apt-get install -y ffmpeg
|
||||
"""
|
||||
|
||||
# ランタイムの環境変数を設定する
|
||||
# ランタイムで使用可能である必要がある設定に役立つ
|
||||
runtime_startup_env_vars = { DATABASE_URL = "postgresql://user:pass@localhost/db" }
|
||||
|
||||
# マルチアーキテクチャビルドのプラットフォームを指定する(例: "linux/amd64"または"linux/arm64")
|
||||
platform = "linux/amd64"
|
||||
```
|
||||
|
||||
### 実行
|
||||
|
||||
トップレベルのディレクトリで```make run```を実行して、OpenHandsを実行します。
|
||||
@@ -0,0 +1,69 @@
|
||||
以下は、OpenHandsのデバッグに関する入門書です。開発目的で使用してください。
|
||||
|
||||
## サーバー / VSCode
|
||||
|
||||
以下の`launch.json`は、エージェント、コントローラー、サーバー要素のデバッグを可能にしますが、サンドボックス(Dockerの中で動作する)はデバッグできません。`workspace/`ディレクトリ内の変更は無視されます。
|
||||
|
||||
```
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "OpenHands CLI",
|
||||
"type": "debugpy",
|
||||
"request": "launch",
|
||||
"module": "openhands.core.cli",
|
||||
"justMyCode": false
|
||||
},
|
||||
{
|
||||
"name": "OpenHands WebApp",
|
||||
"type": "debugpy",
|
||||
"request": "launch",
|
||||
"module": "uvicorn",
|
||||
"args": [
|
||||
"openhands.server.listen:app",
|
||||
"--reload",
|
||||
"--reload-exclude",
|
||||
"${workspaceFolder}/workspace",
|
||||
"--port",
|
||||
"3000"
|
||||
],
|
||||
"justMyCode": false
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
より具体的なデバッグ設定では、より多くのパラメータを指定できます。
|
||||
|
||||
```
|
||||
...
|
||||
{
|
||||
"name": "Debug CodeAct",
|
||||
"type": "debugpy",
|
||||
"request": "launch",
|
||||
"module": "openhands.core.main",
|
||||
"args": [
|
||||
"-t",
|
||||
"Ask me what your task is.",
|
||||
"-d",
|
||||
"${workspaceFolder}/workspace",
|
||||
"-c",
|
||||
"CodeActAgent",
|
||||
"-l",
|
||||
"llm.o1",
|
||||
"-n",
|
||||
"prompts"
|
||||
],
|
||||
"justMyCode": false
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
上記のスニペットの値は、以下のように更新できます。
|
||||
|
||||
* *t*: タスク
|
||||
* *d*: openhandsワークスペースディレクトリ
|
||||
* *c*: エージェント
|
||||
* *l*: LLM設定(config.tomlで事前定義)
|
||||
* *n*: セッション名(例:eventstream名)
|
||||
@@ -0,0 +1,277 @@
|
||||
# 評価
|
||||
|
||||
このガイドでは、独自の評価ベンチマークをOpenHandsフレームワークに統合する方法の概要を説明します。
|
||||
|
||||
## 環境のセットアップとLLMの設定
|
||||
|
||||
ローカル開発環境のセットアップ方法については、[こちら](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)の手順に従ってください。
|
||||
開発モードのOpenHandsは、ほとんどの設定を追跡するために`config.toml`を使用します。
|
||||
|
||||
複数のLLMを定義して使用するために使用できる設定ファイルの例を以下に示します。
|
||||
|
||||
```toml
|
||||
[llm]
|
||||
# 重要: ここにAPIキーを追加し、モデルを評価したいものに設定してください
|
||||
model = "claude-3-5-sonnet-20241022"
|
||||
api_key = "sk-XXX"
|
||||
|
||||
[llm.eval_gpt4_1106_preview_llm]
|
||||
model = "gpt-4-1106-preview"
|
||||
api_key = "XXX"
|
||||
temperature = 0.0
|
||||
|
||||
[llm.eval_some_openai_compatible_model_llm]
|
||||
model = "openai/MODEL_NAME"
|
||||
base_url = "https://OPENAI_COMPATIBLE_URL/v1"
|
||||
api_key = "XXX"
|
||||
temperature = 0.0
|
||||
```
|
||||
|
||||
|
||||
## コマンドラインでOpenHandsを使用する方法
|
||||
|
||||
OpenHandsは、以下の形式でコマンドラインから実行できます。
|
||||
|
||||
```bash
|
||||
poetry run python ./openhands/core/main.py \
|
||||
-i <max_iterations> \
|
||||
-t "<task_description>" \
|
||||
-c <agent_class> \
|
||||
-l <llm_config>
|
||||
```
|
||||
|
||||
例:
|
||||
|
||||
```bash
|
||||
poetry run python ./openhands/core/main.py \
|
||||
-i 10 \
|
||||
-t "Write me a bash script that prints hello world." \
|
||||
-c CodeActAgent \
|
||||
-l llm
|
||||
```
|
||||
|
||||
このコマンドは、以下の設定でOpenHandsを実行します:
|
||||
- 最大10回の反復
|
||||
- 指定されたタスクの説明
|
||||
- CodeActAgentを使用
|
||||
- `config.toml`ファイルの`llm`セクションで定義されたLLM設定
|
||||
|
||||
## OpenHandsの動作原理
|
||||
|
||||
OpenHandsのメインエントリーポイントは`openhands/core/main.py`にあります。簡略化された動作の流れは次のとおりです。
|
||||
|
||||
1. コマンドライン引数を解析し、設定を読み込む
|
||||
2. `create_runtime()`を使用して実行時環境を作成する
|
||||
3. 指定されたエージェントを初期化する
|
||||
4. `run_controller()`を使用してコントローラーを実行する
|
||||
- 実行時環境をエージェントにアタッチする
|
||||
- エージェントのタスクを実行する
|
||||
- 完了時に最終状態を返す
|
||||
|
||||
`run_controller()`関数は、OpenHandsの実行の中核です。エージェント、実行時環境、およびタスク間の相互作用を管理し、ユーザー入力シミュレーションやイベント処理などを処理します。
|
||||
|
||||
|
||||
## 最も簡単な開始方法: 既存のベンチマークの探索
|
||||
|
||||
リポジトリの[`evaluation/benchmarks/`ディレクトリ](https://github.com/All-Hands-AI/OpenHands/blob/main/evaluation/benchmarks)にある様々な評価ベンチマークを確認することをお勧めします。
|
||||
|
||||
独自のベンチマークを統合するには、ニーズに最も近いものから始めることをお勧めします。このアプローチは、既存の構造を基にして特定の要件に適応させることで、統合プロセスを大幅に合理化できます。
|
||||
|
||||
## 評価ワークフローの作成方法
|
||||
|
||||
ベンチマークの評価ワークフローを作成するには、次の手順に従います。
|
||||
|
||||
1. 関連するOpenHandsユーティリティをインポートします:
|
||||
```python
|
||||
import openhands.agenthub
|
||||
from evaluation.utils.shared import (
|
||||
EvalMetadata,
|
||||
EvalOutput,
|
||||
make_metadata,
|
||||
prepare_dataset,
|
||||
reset_logger_for_multiprocessing,
|
||||
run_evaluation,
|
||||
)
|
||||
from openhands.controller.state.state import State
|
||||
from openhands.core.config import (
|
||||
AppConfig,
|
||||
SandboxConfig,
|
||||
get_llm_config_arg,
|
||||
parse_arguments,
|
||||
)
|
||||
from openhands.core.logger import openhands_logger as logger
|
||||
from openhands.core.main import create_runtime, run_controller
|
||||
from openhands.events.action import CmdRunAction
|
||||
from openhands.events.observation import CmdOutputObservation, ErrorObservation
|
||||
from openhands.runtime.runtime import Runtime
|
||||
```
|
||||
|
||||
2. 設定を作成します:
|
||||
```python
|
||||
def get_config(instance: pd.Series, metadata: EvalMetadata) -> AppConfig:
|
||||
config = AppConfig(
|
||||
default_agent=metadata.agent_class,
|
||||
runtime='docker',
|
||||
max_iterations=metadata.max_iterations,
|
||||
sandbox=SandboxConfig(
|
||||
base_container_image='your_container_image',
|
||||
enable_auto_lint=True,
|
||||
timeout=300,
|
||||
),
|
||||
)
|
||||
config.set_llm_config(metadata.llm_config)
|
||||
return config
|
||||
```
|
||||
|
||||
3. 実行時環境を初期化し、評価環境をセットアップします:
|
||||
```python
|
||||
def initialize_runtime(runtime: Runtime, instance: pd.Series):
|
||||
# ここで評価環境をセットアップします
|
||||
# 例えば、環境変数の設定、ファイルの準備など
|
||||
pass
|
||||
```
|
||||
|
||||
4. 各インスタンスを処理する関数を作成します:
|
||||
```python
|
||||
from openhands.utils.async_utils import call_async_from_sync
|
||||
def process_instance(instance: pd.Series, metadata: EvalMetadata) -> EvalOutput:
|
||||
config = get_config(instance, metadata)
|
||||
runtime = create_runtime(config)
|
||||
call_async_from_sync(runtime.connect)
|
||||
initialize_runtime(runtime, instance)
|
||||
|
||||
instruction = get_instruction(instance, metadata)
|
||||
|
||||
state = run_controller(
|
||||
config=config,
|
||||
task_str=instruction,
|
||||
runtime=runtime,
|
||||
fake_user_response_fn=your_user_response_function,
|
||||
)
|
||||
|
||||
# エージェントのアクションを評価する
|
||||
evaluation_result = await evaluate_agent_actions(runtime, instance)
|
||||
|
||||
return EvalOutput(
|
||||
instance_id=instance.instance_id,
|
||||
instruction=instruction,
|
||||
test_result=evaluation_result,
|
||||
metadata=metadata,
|
||||
history=compatibility_for_eval_history_pairs(state.history),
|
||||
metrics=state.metrics.get() if state.metrics else None,
|
||||
error=state.last_error if state and state.last_error else None,
|
||||
)
|
||||
```
|
||||
|
||||
5. 評価を実行します:
|
||||
```python
|
||||
metadata = make_metadata(llm_config, dataset_name, agent_class, max_iterations, eval_note, eval_output_dir)
|
||||
output_file = os.path.join(metadata.eval_output_dir, 'output.jsonl')
|
||||
instances = prepare_dataset(your_dataset, output_file, eval_n_limit)
|
||||
|
||||
await run_evaluation(
|
||||
instances,
|
||||
metadata,
|
||||
output_file,
|
||||
num_workers,
|
||||
process_instance
|
||||
)
|
||||
```
|
||||
|
||||
このワークフローでは、設定をセットアップし、実行時環境を初期化し、エージェントを実行して各インスタンスのアクションを評価し、結果を`EvalOutput`オブジェクトに収集します。`run_evaluation`関数は、並列化と進捗状況の追跡を処理します。
|
||||
|
||||
`get_instruction`、`your_user_response_function`、および`evaluate_agent_actions`関数は、特定のベンチマークの要件に応じてカスタマイズすることを忘れないでください。
|
||||
|
||||
この構造に従うことで、OpenHandsフレームワーク内で独自のベンチマークの堅牢な評価ワークフローを作成できます。
|
||||
|
||||
|
||||
## `user_response_fn`の理解
|
||||
|
||||
`user_response_fn`は、OpenHandsの評価ワークフローにおいて重要な役割を果たします。これは、評価プロセス中にエージェントとのユーザー対話をシミュレートし、自動化された応答を可能にします。この関数は、エージェントのクエリやアクションに対して一貫性のある事前定義された応答を提供したい場合に特に役立ちます。
|
||||
|
||||
|
||||
### ワークフローと相互作用
|
||||
|
||||
アクションと`user_response_fn`を処理するための正しいワークフローは次のとおりです。
|
||||
|
||||
1. エージェントがタスクを受け取り、処理を開始する
|
||||
2. エージェントがアクションを発行する
|
||||
3. アクションが実行可能な場合(CmdRunAction、IPythonRunCellActionなど):
|
||||
- 実行時環境がアクションを処理する
|
||||
- 実行時環境が観測結果を返す
|
||||
4. アクションが実行不可能な場合(通常はMessageAction):
|
||||
- `user_response_fn`が呼び出される
|
||||
- シミュレートされたユーザー応答を返す
|
||||
5. エージェントは、観測結果またはシミュレートされた応答のいずれかを受け取る
|
||||
6. ステップ2〜5が、タスクが完了するか最大反復回数に達するまで繰り返される
|
||||
|
||||
より正確な視覚的表現は次のとおりです。
|
||||
|
||||
```
|
||||
[Agent]
|
||||
|
|
||||
v
|
||||
[Emit Action]
|
||||
|
|
||||
v
|
||||
[Is Action Executable?]
|
||||
/ \
|
||||
Yes No
|
||||
| |
|
||||
v v
|
||||
[Runtime] [user_response_fn]
|
||||
| |
|
||||
v v
|
||||
[Return Observation] [Simulated Response]
|
||||
\ /
|
||||
\ /
|
||||
v v
|
||||
[Agent receives feedback]
|
||||
|
|
||||
v
|
||||
[Continue or Complete Task]
|
||||
```
|
||||
|
||||
このワークフローでは:
|
||||
|
||||
- 実行可能なアクション(コマンドの実行やコードの実行など)は、実行時環境によって直接処理される
|
||||
- 実行不可能なアクション(通常、エージェントがコミュニケーションを取ったり、明確化を求めたりする場合)は、`user_response_fn`によって処理される
|
||||
- エージェントは、実行時環境からの観測結果または`user_response_fn`からのシミュレートされた応答のいずれかのフィードバックを処理する
|
||||
|
||||
このアプローチにより、具体的なアクションとシミュレートされたユーザー対話の両方を自動的に処理できるため、人的介入を最小限に抑えてエージェントのタスク完了能力をテストしたい評価シナリオに適しています。
|
||||
|
||||
### 実装例
|
||||
|
||||
SWE-Benchの評価で使用される`user_response_fn`の例を以下に示します。
|
||||
|
||||
```python
|
||||
def codeact_user_response(state: State | None) -> str:
|
||||
msg = (
|
||||
'Please continue working on the task on whatever approach you think is suitable.\n'
|
||||
'If you think you have solved the task, please first send your answer to user through message and then <execute_bash> exit </execute_bash>.\n'
|
||||
'IMPORTANT: YOU SHOULD NEVER ASK FOR HUMAN HELP.\n'
|
||||
)
|
||||
|
||||
if state and state.history:
|
||||
# check if the agent has tried to talk to the user 3 times, if so, let the agent know it can give up
|
||||
user_msgs = [
|
||||
event
|
||||
for event in state.history
|
||||
if isinstance(event, MessageAction) and event.source == 'user'
|
||||
]
|
||||
if len(user_msgs) >= 2:
|
||||
# let the agent know that it can give up when it has tried 3 times
|
||||
return (
|
||||
msg
|
||||
+ 'If you want to give up, run: <execute_bash> exit </execute_bash>.\n'
|
||||
)
|
||||
return msg
|
||||
```
|
||||
|
||||
この関数は次のことを行います。
|
||||
|
||||
1. エージェントに作業を続けるよう促す標準メッセージを提供する
|
||||
2. エージェントがユーザーとのコミュニケーションを試みた回数をチェックする
|
||||
3. エージェントが複数回試行した場合、諦めるオプションを提供する
|
||||
|
||||
この関数を使用することで、複数の評価実行全体で一貫した動作を確保し、エージェントが人間の入力を待って停止するのを防ぐことができます。
|
||||
@@ -0,0 +1,50 @@
|
||||
# OpenHands GitHub Actionの使用方法
|
||||
|
||||
このガイドでは、OpenHands自体のリポジトリ内および独自のプロジェクトの両方で、OpenHands GitHub Actionを使用する方法について説明します。
|
||||
|
||||
## OpenHands リポジトリ内でのActionの使用
|
||||
|
||||
リポジトリ内でOpenHands GitHub Actionを使用するには、以下の手順を実行します。
|
||||
|
||||
1. リポジトリ内にissueを作成します。
|
||||
2. issueに`fix-me`ラベルを追加するか、`@openhands-agent`で始まるコメントをissueに残します。
|
||||
|
||||
アクションは自動的にトリガーされ、issueの解決を試みます。
|
||||
|
||||
## 新しいリポジトリへのActionのインストール
|
||||
|
||||
独自のリポジトリにOpenHands GitHub Actionをインストールするには、[OpenHands Resolverの README](https://github.com/All-Hands-AI/OpenHands/blob/main/openhands/resolver/README.md)に従ってください。
|
||||
|
||||
## 使用のヒント
|
||||
|
||||
### 反復的な解決
|
||||
|
||||
1. リポジトリ内にissueを作成します。
|
||||
2. issueに`fix-me`ラベルを追加するか、`@openhands-agent`で始まるコメントを残します。
|
||||
3. プルリクエストを確認して、issueを解決する試みをレビューします。
|
||||
4. 一般的なコメント、レビューコメント、またはインラインスレッドコメントを通じてフィードバックをフォローアップします。
|
||||
5. プルリクエストに`fix-me`ラベルを追加するか、`@openhands-agent`で始まる特定のコメントに対処します。
|
||||
|
||||
### ラベルとマクロ
|
||||
|
||||
- ラベル(`fix-me`):OpenHandsに**全体の** issueまたはプルリクエストへの対処を要求します。
|
||||
- マクロ(`@openhands-agent`):OpenHandsにissue/プルリクエストの説明と**特定のコメント**のみを考慮するように要求します。
|
||||
|
||||
## 高度な設定
|
||||
|
||||
### カスタムリポジトリ設定の追加
|
||||
|
||||
[resolverのREADME](https://github.com/All-Hands-AI/OpenHands/blob/main/openhands/resolver/README.md#providing-custom-instructions)に従って、OpenHandsにカスタムの指示を提供できます。
|
||||
|
||||
### カスタム構成
|
||||
|
||||
GitHub resolverは、自動的に有効な[リポジトリシークレット](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions?tool=webui#creating-secrets-for-a-repository)または[リポジトリ変数](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-a-repository)をチェックして、その動作をカスタマイズします。
|
||||
設定可能なカスタマイズオプションは次のとおりです。
|
||||
|
||||
| **属性名** | **タイプ** | **目的** | **例** |
|
||||
| -------------------------------- | -------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
|
||||
| `LLM_MODEL` | Variable | OpenHandsで使用するLLMを設定 | `LLM_MODEL="anthropic/claude-3-5-sonnet-20241022"` |
|
||||
| `OPENHANDS_MAX_ITER` | Variable | エージェントの反復の最大制限を設定 | `OPENHANDS_MAX_ITER=10` |
|
||||
| `OPENHANDS_MACRO` | Variable | リゾルバを呼び出すためのデフォルトマクロをカスタマイズ | `OPENHANDS_MACRO=@resolveit` |
|
||||
| `OPENHANDS_BASE_CONTAINER_IMAGE` | Variable | カスタムSandbox([詳細](https://docs.all-hands.dev/modules/usage/how-to/custom-sandbox-guide)) | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` |
|
||||
| `TARGET_BRANCH` | Variable | `main`以外のブランチにマージ | `TARGET_BRANCH="dev"` |
|
||||
@@ -0,0 +1,160 @@
|
||||
# GUIモード
|
||||
|
||||
OpenHandsは、AI アシスタントとやり取りするためのグラフィカルユーザーインターフェース(GUI)モードを提供しています。
|
||||
|
||||
## インストールとセットアップ
|
||||
|
||||
1. インストール手順に従って、OpenHandsをインストールします。
|
||||
2. コマンドを実行した後、[http://localhost:3000](http://localhost:3000)でOpenHandsにアクセスします。
|
||||
|
||||
## GUIでのやり取り
|
||||
|
||||
### 初期設定
|
||||
|
||||
1. 初回起動時に、設定ページが表示されます。
|
||||
2. ドロップダウンメニューから`LLM Provider`と`LLM Model`を選択します。必要なモデルがリストにない場合は、`Advanced`オプションを切り替えて、正しいプレフィックスを付けて`Custom Model`テキストボックスに入力します。
|
||||
3. 選択したプロバイダーに対応する`API Key`を入力します。
|
||||
4. `Save Changes`をクリックして設定を適用します。
|
||||
|
||||
### バージョン管理トークン
|
||||
|
||||
OpenHandsは複数のバージョン管理プロバイダーをサポートしています。複数のプロバイダーのトークンを同時に設定できます。
|
||||
|
||||
#### GitHubトークンの設定
|
||||
|
||||
OpenHandsは、利用可能な場合、自動的に`GITHUB_TOKEN`をシェル環境にエクスポートします。これは2つの方法で行われます。
|
||||
|
||||
**ローカルインストール**: ユーザーが直接GitHubトークンを入力します。
|
||||
<details>
|
||||
<summary>GitHubトークンの設定</summary>
|
||||
|
||||
1. **Personal Access Token(PAT)の生成**:
|
||||
- GitHubで、Settings > Developer Settings > Personal Access Tokens > Tokens (classic)に移動します。
|
||||
- **New token (classic)**
|
||||
- 必要なスコープ:
|
||||
- `repo`(プライベートリポジトリの完全な制御)
|
||||
- **Fine-Grained Tokens**
|
||||
- All Repositories(特定のリポジトリを選択できますが、これはリポジトリ検索の結果に影響します)
|
||||
- Minimal Permissions(検索用に**Meta Data = Read-only**を選択し、ブランチ作成用に**Pull Requests = Read and Write**、**Content = Read and Write**を選択します)
|
||||
2. **OpenHandsにトークンを入力**:
|
||||
- 設定ボタン(歯車アイコン)をクリックします。
|
||||
- `Git Provider Settings`セクションに移動します。
|
||||
- `GitHub Token`フィールドにトークンを貼り付けます。
|
||||
- `Save Changes`をクリックして変更を適用します。
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>組織のトークンポリシー</summary>
|
||||
|
||||
組織のリポジトリを使用する場合は、追加の設定が必要になる場合があります。
|
||||
|
||||
1. **組織の要件を確認**:
|
||||
- 組織の管理者は、特定のトークンポリシーを適用することがあります。
|
||||
- 一部の組織では、SSOを有効にしてトークンを作成する必要があります。
|
||||
- 組織の[トークンポリシー設定](https://docs.github.com/en/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization)を確認してください。
|
||||
2. **組織へのアクセスを確認**:
|
||||
- GitHubのトークン設定に移動します。
|
||||
- `Organization access`の下で組織を探します。
|
||||
- 必要に応じて、組織の横にある`Enable SSO`をクリックします。
|
||||
- SSOの認証プロセスを完了します。
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>トラブルシューティング</summary>
|
||||
|
||||
一般的な問題と解決策:
|
||||
|
||||
- **トークンが認識されない**:
|
||||
- トークンが設定に正しく保存されていることを確認します。
|
||||
- トークンの有効期限が切れていないことを確認します。
|
||||
- トークンに必要なスコープがあることを確認します。
|
||||
- トークンを再生成してみてください。
|
||||
|
||||
- **組織へのアクセスが拒否された**:
|
||||
- SSOが必要だが有効になっていないかどうかを確認します。
|
||||
- 組織のメンバーシップを確認します。
|
||||
- トークンポリシーがアクセスをブロックしている場合は、組織の管理者に連絡してください。
|
||||
|
||||
- **トークンが機能することを確認**:
|
||||
- トークンが有効な場合、アプリにグリーンのチェックマークが表示されます。
|
||||
- リポジトリにアクセスして、権限を確認してみてください。
|
||||
- ブラウザのコンソールでエラーメッセージを確認してください。
|
||||
</details>
|
||||
|
||||
**OpenHands Cloud**: トークンはGitHub OAuth認証を通じて取得されます。
|
||||
|
||||
<details>
|
||||
<summary>OAuth認証</summary>
|
||||
|
||||
OpenHands Cloudを使用する場合、GitHub OAuthフローは以下の権限を要求します:
|
||||
- リポジトリアクセス(読み取り/書き込み)
|
||||
- ワークフロー管理
|
||||
- 組織の読み取りアクセス
|
||||
|
||||
OpenHandsを認証するには:
|
||||
- プロンプトが表示されたら、`Sign in with GitHub`をクリックします。
|
||||
- 要求された権限を確認します。
|
||||
- OpenHandsがGitHubアカウントにアクセスすることを承認します。
|
||||
- 組織を使用している場合は、プロンプトが表示されたら組織へのアクセスを承認します。
|
||||
</details>
|
||||
|
||||
#### GitLabトークンの設定
|
||||
|
||||
OpenHandsは、利用可能な場合、ローカルインストールのみ、自動的に`GITLAB_TOKEN`をシェル環境にエクスポートします。
|
||||
|
||||
<details>
|
||||
<summary>GitLabトークンの設定</summary>
|
||||
|
||||
1. **Personal Access Token(PAT)の生成**:
|
||||
- GitLabで、User Settings > Access Tokensに移動します。
|
||||
- 以下のスコープを持つ新しいトークンを作成します:
|
||||
- `api`(APIアクセス)
|
||||
- `read_user`(ユーザー情報の読み取り)
|
||||
- `read_repository`(リポジトリ読み取り)
|
||||
- `write_repository`(リポジトリ書き込み)
|
||||
- 有効期限を設定するか、無期限トークンの場合は空白のままにします。
|
||||
2. **OpenHandsにトークンを入力**:
|
||||
- 設定ボタン(歯車アイコン)をクリックします。
|
||||
- `Git Provider Settings`セクションに移動します。
|
||||
- `GitLab Token`フィールドにトークンを貼り付けます。
|
||||
- セルフホスト型GitLabを使用している場合は、GitLabインスタンスのURLを入力します。
|
||||
- `Save Changes`をクリックして変更を適用します。
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>トラブルシューティング</summary>
|
||||
|
||||
一般的な問題と解決策:
|
||||
|
||||
- **トークンが認識されない**:
|
||||
- トークンが設定に正しく保存されていることを確認します。
|
||||
- トークンの有効期限が切れていないことを確認します。
|
||||
- トークンに必要なスコープがあることを確認します。
|
||||
- セルフホスト型インスタンスの場合は、正しいインスタンスURLを確認します。
|
||||
|
||||
- **アクセスが拒否された**:
|
||||
- プロジェクトのアクセス権限を確認します。
|
||||
- トークンに必要なスコープがあるかどうかを確認します。
|
||||
- グループ/組織のリポジトリの場合は、適切なアクセス権があることを確認します。
|
||||
</details>
|
||||
|
||||
### 高度な設定
|
||||
|
||||
1. 設定ページ内で、`Advanced`オプションを切り替えて追加の設定にアクセスします。
|
||||
2. `Custom Model`テキストボックスを使用して、リストにないモデルを手動で入力します。
|
||||
3. LLMプロバイダーで必要な場合は、`Base URL`を指定します。
|
||||
|
||||
### AIとのやり取り
|
||||
|
||||
1. 入力ボックスにプロンプトを入力します。
|
||||
2. 送信ボタンをクリックするか、Enterキーを押してメッセージを送信します。
|
||||
3. AIは入力を処理し、チャットウィンドウに応答を提供します。
|
||||
4. フォローアップの質問をしたり、追加情報を提供したりして、会話を続けることができます。
|
||||
|
||||
## 効果的な使用のためのヒント
|
||||
|
||||
- [プロンプトのベストプラクティス](../prompting/prompting-best-practices)で説明されているように、要求を具体的にすることで、最も正確で役立つ応答を得ることができます。
|
||||
- ワークスペースパネルを使用して、プロジェクト構造を探索します。
|
||||
- [LLMsセクション](usage/llms/llms.md)で説明されているように、推奨モデルの1つを使用します。
|
||||
|
||||
OpenHandsのGUIモードは、AIアシスタントとのやり取りをできるだけスムーズで直感的にすることを目的としています。生産性を最大限に高めるために、ぜひその機能を探ってみてください。
|
||||
@@ -0,0 +1,55 @@
|
||||
# ヘッドレスモード
|
||||
|
||||
OpenHandsは、Webアプリケーションを起動せずに、単一のコマンドで実行できます。
|
||||
これにより、OpenHandsを使用してスクリプトを作成したり、タスクを自動化したりするのが簡単になります。
|
||||
|
||||
これは、インタラクティブで、アクティブな開発に適した[CLIモード](cli-mode)とは異なります。
|
||||
|
||||
## Pythonを使用する場合
|
||||
|
||||
PythonでOpenHandsをヘッドレスモードで実行するには:
|
||||
1. [開発セットアップの手順](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)に従っていることを確認してください。
|
||||
2. 以下のコマンドを実行します:
|
||||
```bash
|
||||
poetry run python -m openhands.core.main -t "write a bash script that prints hi"
|
||||
```
|
||||
|
||||
モデル、APIキー、その他の設定は、環境変数[または`config.toml`ファイル](https://github.com/All-Hands-AI/OpenHands/blob/main/config.template.toml)を介して設定する必要があります。
|
||||
|
||||
## Dockerを使用する場合
|
||||
|
||||
DockerでOpenHandsをヘッドレスモードで実行するには:
|
||||
|
||||
1. ターミナルで以下の環境変数を設定します:
|
||||
|
||||
- `WORKSPACE_BASE`をOpenHandsが編集するディレクトリに設定 (例: `export WORKSPACE_BASE=$(pwd)/workspace`)。
|
||||
- `LLM_MODEL`を使用するモデルに設定 (例: `export LLM_MODEL="anthropic/claude-3-5-sonnet-20241022"`)。
|
||||
- `LLM_API_KEY`をAPIキーに設定 (例: `export LLM_API_KEY="sk_test_12345"`)。
|
||||
|
||||
2. 以下のDockerコマンドを実行します:
|
||||
|
||||
```bash
|
||||
docker run -it \
|
||||
--pull=always \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik \
|
||||
-e SANDBOX_USER_ID=$(id -u) \
|
||||
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
|
||||
-e LLM_API_KEY=$LLM_API_KEY \
|
||||
-e LLM_MODEL=$LLM_MODEL \
|
||||
-e LOG_ALL_EVENTS=true \
|
||||
-v $WORKSPACE_BASE:/opt/workspace_base \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-v ~/.openhands-state:/.openhands-state \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
--name openhands-app-$(date +%Y%m%d%H%M%S) \
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.34 \
|
||||
python -m openhands.core.main -t "write a bash script that prints hi"
|
||||
```
|
||||
|
||||
## 高度なヘッドレス設定
|
||||
|
||||
ヘッドレスモードで利用可能なすべての設定オプションを表示するには、`--help`フラグを付けてPythonコマンドを実行します。
|
||||
|
||||
### 追加のログ
|
||||
|
||||
ヘッドレスモードでエージェントのすべてのアクションをログに記録するには、ターミナルで`export LOG_ALL_EVENTS=true`を実行します。
|
||||
@@ -0,0 +1,18 @@
|
||||
|
||||
|
||||
# Persistance des données de session
|
||||
|
||||
Avec l'installation standard, les données de session sont stockées en mémoire. Actuellement, si le service OpenHands est redémarré,
|
||||
les sessions précédentes deviennent invalides (un nouveau secret est généré) et ne sont donc pas récupérables.
|
||||
|
||||
## Comment persister les données de session
|
||||
|
||||
### Workflow de développement
|
||||
Dans le fichier `config.toml`, spécifiez ce qui suit :
|
||||
```
|
||||
[core]
|
||||
...
|
||||
file_store="local"
|
||||
file_store_path="/absolute/path/to/openhands/cache/directory"
|
||||
jwt_secret="secretpass"
|
||||
```
|
||||
@@ -0,0 +1,55 @@
|
||||
# OpenHandsの実行
|
||||
|
||||
## システム要件
|
||||
|
||||
* Docker バージョン26.0.0+またはDocker Desktop 4.31.0+
|
||||
* LinuxまたはMac OSを使用する必要があります
|
||||
* Windowsを使用している場合は、[WSL](https://learn.microsoft.com/en-us/windows/wsl/install)を使用する必要があります
|
||||
|
||||
## アプリケーションの起動
|
||||
|
||||
OpenHandsを実行する最も簡単な方法は、Dockerを使用することです。
|
||||
|
||||
```bash
|
||||
docker pull docker.all-hands.dev/all-hands-ai/runtime:0.29-nikolaik
|
||||
|
||||
docker run -it --rm --pull=always \
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.29-nikolaik \
|
||||
-e LOG_ALL_EVENTS=true \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-p 3000:3000 \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
--name openhands-app \
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.29
|
||||
```
|
||||
|
||||
また、[ヘッドレススクリプトモード](https://docs.all-hands.dev/modules/usage/how-to/headless-mode)、[対話型CLI](https://docs.all-hands.dev/modules/usage/how-to/cli-mode)、または[OpenHands GitHub Action](https://docs.all-hands.dev/modules/usage/how-to/github-action)としても実行できます。
|
||||
|
||||
## 設定
|
||||
|
||||
上記のコマンドを実行すると、OpenHandsは[http://localhost:3000](http://localhost:3000)で動作します。
|
||||
|
||||
OpenHandsを起動すると、設定モーダルウィンドウが表示されます。`LLMプロバイダー`と`LLMモデル`を選択し、対応する`APIキー`を入力する**必要があります**。
|
||||
これらの設定は、UIの`設定`ボタン(歯車アイコン)を選択することでいつでも変更できます。
|
||||
|
||||
必要な`LLMモデル`がリストに存在しない場合は、`詳細オプション`を有効にして、
|
||||
`カスタムモデル`テキストボックスに適切なプレフィックスを付けて手動で入力できます。
|
||||
`詳細オプション`では、必要に応じて`ベースURL`も指定できます。
|
||||
|
||||
<div style={{ display: 'flex', justifyContent: 'center', gap: '20px' }}>
|
||||
<img src="/img/settings-screenshot.png" alt="settings-modal" width="340" />
|
||||
<img src="/img/settings-advanced.png" alt="settings-modal" width="335" />
|
||||
</div>
|
||||
|
||||
## バージョン
|
||||
|
||||
上記のコマンドは、OpenHandsの最新の安定版を取得します。他のオプションもあります:
|
||||
- 特定のバージョンを使用する場合は、`docker.all-hands.dev/all-hands-ai/openhands:$VERSION`を使用し、$VERSIONをバージョン番号に置き換えてください。
|
||||
- semverを使用しており、メジャー、マイナー、パッチバージョンのタグを公開しています。したがって、`0.9`は最新の`0.9.x`バージョンを、`0`は最新の`0.x.x`バージョンを指します。
|
||||
- 最新の開発バージョンを使用する場合は、`docker.all-hands.dev/all-hands-ai/openhands:main`を使用できます。このバージョンは不安定で、テストまたは開発目的でのみ推奨されます。
|
||||
|
||||
安定性要件と必要な機能に応じて、最適なタグを選択できます。
|
||||
|
||||
開発ワークフローについては、[Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)を参照してください。
|
||||
|
||||
問題がありますか?[トラブルシューティングガイド](https://docs.all-hands.dev/modules/usage/troubleshooting)をご確認ください。
|
||||
@@ -0,0 +1,109 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# 💻 OpenHands
|
||||
|
||||
OpenHandsは、複雑なエンジニアリングタスクを実行し、ソフトウェア開発プロジェクトでユーザーと積極的に協力できる**自律型AIソフトウェアエンジニア**です。
|
||||
このプロジェクトは完全にオープンソースなので、自由に使用・改変することができます。
|
||||
|
||||
:::tip
|
||||
OpenHandsのソースコードを[GitHub](https://github.com/All-Hands-AI/OpenHands)で確認するか、コミュニティに参加してください!
|
||||
|
||||
<a href="https://github.com/All-Hands-AI/OpenHands/graphs/contributors">
|
||||
<img
|
||||
src="https://img.shields.io/github/contributors/All-Hands-AI/OpenHands?style=for-the-badge"
|
||||
alt="Contributors"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/All-Hands-AI/OpenHands/network/members">
|
||||
<img
|
||||
src="https://img.shields.io/github/forks/All-Hands-AI/OpenHands?style=for-the-badge"
|
||||
alt="Forks"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/All-Hands-AI/OpenHands/stargazers">
|
||||
<img
|
||||
src="https://img.shields.io/github/stars/All-Hands-AI/OpenHands?style=for-the-badge"
|
||||
alt="Stargazers"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/All-Hands-AI/OpenHands/issues">
|
||||
<img
|
||||
src="https://img.shields.io/github/issues/All-Hands-AI/OpenHands?style=for-the-badge"
|
||||
alt="Issues"
|
||||
/>
|
||||
</a>
|
||||
<br></br>
|
||||
<a href="https://github.com/All-Hands-AI/OpenHands/blob/main/LICENSE">
|
||||
<img
|
||||
src="https://img.shields.io/github/license/All-Hands-AI/OpenHands?style=for-the-badge"
|
||||
alt="MIT License"
|
||||
/>
|
||||
</a>
|
||||
<br></br>
|
||||
<a href="https://join.slack.com/t/openhands-ai/shared_invite/zt-2ngejmfw6-9gW4APWOC9XUp1n~SiQ6iw">
|
||||
<img
|
||||
src="https://img.shields.io/badge/Slack-Join%20Us-red?logo=slack&logoColor=white&style=for-the-badge"
|
||||
alt="Slackコミュニティに参加"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://discord.gg/ESHStjSjD4">
|
||||
<img
|
||||
src="https://img.shields.io/badge/Discord-Join%20Us-purple?logo=discord&logoColor=white&style=for-the-badge"
|
||||
alt="Discordコミュニティに参加"
|
||||
/>
|
||||
</a>
|
||||
:::
|
||||
|
||||
## 🛠️ はじめに
|
||||
|
||||
OpenHandsを実行する最も簡単な方法は、Dockerコンテナ内で実行することです。最新バージョンのDocker(`26.0.0`)で最もよく動作します。
|
||||
Linux、Mac OS、またはWindows上のWSLを使用する必要があります。
|
||||
|
||||
OpenHandsをDockerコンテナで起動するには、ターミナルで以下のコマンドを実行します:
|
||||
|
||||
:::warning
|
||||
以下のコマンドを実行すると、`./workspace`内のファイルが変更または削除される可能性があります。
|
||||
:::
|
||||
|
||||
```bash
|
||||
WORKSPACE_BASE=$(pwd)/workspace
|
||||
docker run -it \
|
||||
--pull=always \
|
||||
-e SANDBOX_USER_ID=$(id -u) \
|
||||
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
|
||||
-v $WORKSPACE_BASE:/opt/workspace_base \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-p 3000:3000 \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
--name openhands-app-$(date +%Y%m%d%H%M%S) \
|
||||
ghcr.io/all-hands-ai/openhands:main
|
||||
```
|
||||
|
||||
OpenHandsは[http://localhost:3000](http://localhost:3000)で動作し、`./workspace`にアクセスできます。OpenHandsにコードを操作させるには、そのコードを`./workspace`に配置してください。
|
||||
|
||||
OpenHandsはこのワークスペースフォルダにのみアクセスできます。Dockerの安全なサンドボックス内で実行されるため、システムの他の部分には影響を与えません。
|
||||
|
||||
:::tip
|
||||
最新の**(不安定!)**バージョンを使用したい場合は、イメージとして`ghcr.io/all-hands-ai/openhands:main`を使用できます(最後の行)。
|
||||
:::
|
||||
|
||||
開発ワークフローについては、[Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)を参照してください。
|
||||
|
||||
問題がありますか?[トラブルシューティングガイド](https://docs.all-hands.dev/modules/usage/troubleshooting)をご確認ください。
|
||||
|
||||
:::warning
|
||||
OpenHandsは現在開発中ですが、アルファ版を実行してエンドツーエンドのシステムを動作させることができます。
|
||||
:::
|
||||
|
||||
[contributors-shield]: https://img.shields.io/github/contributors/All-Hands-AI/OpenHands?style=for-the-badge
|
||||
[contributors-url]: https://github.com/All-Hands-AI/OpenHands/graphs/contributors
|
||||
[forks-shield]: https://img.shields.io/github/forks/All-Hands-AI/OpenHands?style=for-the-badge
|
||||
[forks-url]: https://github.com/All-Hands-AI/OpenHands/network/members
|
||||
[stars-shield]: https://img.shields.io/github/stars/All-Hands-AI/OpenHands?style=for-the-badge
|
||||
[stars-url]: https://github.com/All-Hands-AI/OpenHands/stargazers
|
||||
[issues-shield]: https://img.shields.io/github/issues/All-Hands-AI/OpenHands?style=for-the-badge
|
||||
[issues-url]: https://github.com/All-Hands-AI/OpenHands/issues
|
||||
[license-shield]: https://img.shields.io/github/license/All-Hands-AI/OpenHands?style=for-the-badge
|
||||
[license-url]: https://github.com/All-Hands-AI/OpenHands/blob/main/LICENSE
|
||||
@@ -0,0 +1,72 @@
|
||||
# 主な機能
|
||||
|
||||

|
||||
|
||||
## 1. ワークスペース
|
||||
|
||||
ワークスペース機能は、以下の主要な機能を備えた包括的な開発環境を提供します:
|
||||
|
||||
* ファイルエクスプローラー:プロジェクトのファイルとディレクトリの閲覧、表示、管理
|
||||
* プロジェクト管理:異なるプロジェクトのインポート、作成、ナビゲーション
|
||||
* 統合開発ツール:様々な開発ワークフローとのシームレスな統合
|
||||
* ファイル操作:
|
||||
* ファイル内容の表示
|
||||
* 新規ファイルとフォルダの作成
|
||||
* ファイルのアップロードとダウンロード
|
||||
* 基本的なファイル操作
|
||||
|
||||
## 2. Jupyterノートブック
|
||||
|
||||
Jupyterノートブック機能は、インタラクティブなコーディングとデータ分析環境を提供します:
|
||||
|
||||
* インタラクティブなコードセル:セルベースのインターフェースでPythonコードを実行
|
||||
* 入出力の追跡:コード入力とその出力の履歴を保持
|
||||
* 永続的なセッション:セル間でコード実行コンテキストを保持
|
||||
* 様々なPython操作とデータ分析タスクをサポート
|
||||
* リアルタイムのコード実行と結果の可視化
|
||||
|
||||
## 3. ブラウザ(ベータ)
|
||||
|
||||
ブラウザ機能は、Web操作機能を提供します:
|
||||
|
||||
* Webページナビゲーション:アプリケーション内でウェブサイトを開いて閲覧
|
||||
* スクリーンショット取得:Webページのスクリーンショットを自動生成
|
||||
* インタラクション機能:
|
||||
* 要素のクリック
|
||||
* フォームの入力
|
||||
* ページのスクロール
|
||||
* Web内容のナビゲーション
|
||||
* 15種類のブラウザ操作機能をサポート
|
||||
|
||||
## 4. ターミナル
|
||||
|
||||
ターミナル機能は、アプリケーション内でコマンドラインインターフェースを提供します:
|
||||
|
||||
* シェルコマンドの実行:bashとシステムコマンドを実行
|
||||
* コマンド履歴:過去のコマンドを追跡して呼び出し
|
||||
* 環境との対話:システムのコマンドラインと直接対話
|
||||
* 様々なプログラミングとシステム管理タスクをサポート
|
||||
|
||||
## 5. チャット / AI会話
|
||||
|
||||
チャットインターフェースは、AIを活用した会話体験を提供します:
|
||||
|
||||
* インタラクティブなAIアシスタント:自然言語での会話に参加
|
||||
* コンテキストを理解した応答:開発関連の質問を理解して応答
|
||||
* アクション提案:タスクに対する実行可能な推奨事項を提供
|
||||
* 会話管理:異なる会話スレッドの作成、削除、管理
|
||||
|
||||
## 6. アプリケーション(ベータ)
|
||||
|
||||
メインアプリケーションインターフェースは、これらすべての機能を統合します:
|
||||
|
||||
* 統合ワークスペース:ワークスペース、ブラウザ、ターミナル、AIチャットのシームレスな統合
|
||||
* カスタマイズ可能なレイアウト:異なる機能パネルの配置をカスタマイズ
|
||||
* 状態管理:異なる機能間でコンテキストと状態を維持
|
||||
* セキュリティとプライバシー制御:アプリケーションの設定と権限を管理
|
||||
|
||||
### 追加情報
|
||||
|
||||
* アプリケーションは現在ベータ版で、継続的な改善と機能追加が行われています
|
||||
* 様々な開発ワークフローとAIアシストコーディングをサポート
|
||||
* 統合ツールとAIアシスタンスを通じて開発者の生産性を向上するように設計
|
||||
@@ -0,0 +1,82 @@
|
||||
# 🤖 LLMバックエンド
|
||||
|
||||
OpenHandsは、LiteLLMがサポートするすべてのLLMに接続できます。ただし、機能するには強力なモデルが必要です。
|
||||
|
||||
## モデルの推奨事項
|
||||
|
||||
コーディングタスクに対する言語モデルの評価(SWE-benchデータセットを使用)に基づいて、モデル選択に関するいくつかの推奨事項を提供できます。分析の一部は、[LLMを比較したこのブログ記事](https://www.all-hands.dev/blog/evaluation-of-llms-as-coding-agents-on-swe-bench-at-30x-speed)と[より最近の結果を含むこのブログ記事](https://www.all-hands.dev/blog/openhands-codeact-21-an-open-state-of-the-art-software-development-agent)で確認できます。
|
||||
|
||||
モデルを選択する際は、出力の品質とコストの両方を考慮してください。結果の要約は以下の通りです:
|
||||
|
||||
* Claude 3.5 Sonnetが圧倒的に優れており、OpenHandsのデフォルトエージェントでSWE-Bench Verifiedの53%の解決率を達成しています。
|
||||
* GPT-4oは遅れを取っており、o1-miniは実際にGPT-4oよりもわずかに低いパフォーマンスを示しました。結果を少し分析したところ、o1は時々「考えすぎ」て、タスクを完了できるのに追加の環境設定タスクを実行していたようです。
|
||||
* 最後に、最も強力なオープンモデルはLlama 3.1 405 BとDeepseek-v2.5で、合理的なパフォーマンスを示し、一部のクローズドモデルを上回りました。
|
||||
|
||||
詳細については、[完全な記事](https://www.all-hands.dev/blog/evaluation-of-llms-as-coding-agents-on-swe-bench-at-30x-speed)を参照してください。
|
||||
|
||||
これらの結果とコミュニティからのフィードバックに基づいて、以下のモデルがOpenHandsで合理的に機能することが確認されています:
|
||||
|
||||
* claude-3-5-sonnet(推奨)
|
||||
* gpt-4 / gpt-4o
|
||||
* llama-3.1-405b
|
||||
* deepseek-v2.5
|
||||
|
||||
:::warning prudence
|
||||
OpenHandsは、設定したLLMに多くのプロンプトを送信します。これらのLLMのほとんどは有料なので、支出制限を設定し、使用状況を監視してください。
|
||||
:::
|
||||
|
||||
リストにない特定のLLMでOpenHandsの実行に成功した場合は、検証済みリストに追加してください。また、同じプロバイダーとLLMを使用する他のユーザーを支援するため、設定プロセスを共有するPRを開くことをお勧めします!
|
||||
|
||||
利用可能なプロバイダーとモデルの完全なリストについては、[litellmのドキュメント](https://docs.litellm.ai/docs/providers)を参照してください。
|
||||
|
||||
:::note remarque
|
||||
現在のほとんどのローカルおよびオープンソースモデルは、それほど強力ではありません。このようなモデルを使用する場合、メッセージ間の長い待機時間、品質の低い応答、または不正なJSONに関するエラーが発生する可能性があります。OpenHandsは、それを駆動するモデルと同じくらい強力にしかなりません。ただし、機能するモデルを見つけた場合は、上記の検証済みリストに追加してください。
|
||||
:::
|
||||
|
||||
## LLM設定
|
||||
|
||||
以下の項目は、OpenHandsのUIで設定メニューから設定できます:
|
||||
|
||||
* `LLMプロバイダー`
|
||||
* `LLMモデル`
|
||||
* `APIキー`
|
||||
* `ベースURL`(`詳細設定`から)
|
||||
|
||||
一部のLLM/プロバイダーで必要となる可能性があるが、UIでは設定できないパラメータがあります。これらは代わりに、[docker runコマンド](./installation#start-the-app)に`-e`を使用して環境変数として渡すことができます:
|
||||
|
||||
* `LLM_API_VERSION`
|
||||
* `LLM_EMBEDDING_MODEL`
|
||||
* `LLM_EMBEDDING_DEPLOYMENT_NAME`
|
||||
* `LLM_DROP_PARAMS`
|
||||
* `LLM_DISABLE_VISION`
|
||||
* `LLM_CACHING_PROMPT`
|
||||
|
||||
特定のモデルプロバイダーでOpenHandsを実行するためのガイドがいくつかあります:
|
||||
|
||||
* [Azure](./llms/azure-llms)
|
||||
* [Google](./llms/google-llms)
|
||||
* [Groq](./llms/groq)
|
||||
* [LiteLLM Proxy](./llms/litellm-proxy)
|
||||
* [OpenAI](./llms/openai-llms)
|
||||
* [OpenRouter](./llms/openrouter)
|
||||
|
||||
### APIリトライとレート制限
|
||||
|
||||
LLMプロバイダーは通常、レート制限を持っており、時には非常に低い制限で、リトライが必要になる場合があります。OpenHandsは、レート制限エラー(エラーコード429)、API接続エラー、またはその他の一時的なエラーを受信した場合、自動的にリクエストを再試行します。
|
||||
|
||||
使用しているプロバイダーのニーズに応じて、これらのオプションをカスタマイズできます。プロバイダーのドキュメントを確認し、以下の環境変数を設定してリトライ回数とリトライ間の待機時間を制御してください:
|
||||
|
||||
* `LLM_NUM_RETRIES`(デフォルト8)
|
||||
* `LLM_RETRY_MIN_WAIT`(デフォルト15秒)
|
||||
* `LLM_RETRY_MAX_WAIT`(デフォルト120秒)
|
||||
* `LLM_RETRY_MULTIPLIER`(デフォルト2)
|
||||
|
||||
OpenHandsを開発モードで実行している場合、これらのオプションを`config.toml`ファイルで設定することもできます:
|
||||
|
||||
```toml
|
||||
[llm]
|
||||
num_retries = 8
|
||||
retry_min_wait = 15
|
||||
retry_max_wait = 120
|
||||
retry_multiplier = 2
|
||||
```
|
||||
@@ -0,0 +1,38 @@
|
||||
# Azure
|
||||
|
||||
OpenHands は LiteLLM を使用して Azure のチャットモデルを呼び出します。Azure をプロバイダとして使用する方法については、[こちら](https://docs.litellm.ai/docs/providers/azure)のドキュメントをご覧ください。
|
||||
|
||||
## Azure OpenAI 設定
|
||||
|
||||
OpenHands を実行する際には、以下の環境変数を [docker run コマンド](../installation#running-openhands) で `-e` を使用して設定する必要があります。
|
||||
|
||||
```
|
||||
LLM_API_VERSION="<api-version>" # 例: "2023-05-15"
|
||||
```
|
||||
|
||||
例:
|
||||
```bash
|
||||
docker run -it --pull=always \
|
||||
-e LLM_API_VERSION="2023-05-15"
|
||||
...
|
||||
```
|
||||
|
||||
その後、OpenHands UI の設定で以下を行います。
|
||||
|
||||
:::note
|
||||
Azure の deployments ページで ChatGPT のデプロイメント名を確認する必要があります。以下では <deployment-name> と表記しています。
|
||||
:::
|
||||
|
||||
1. `Advanced` オプションを有効にします。
|
||||
2. 以下を設定します:
|
||||
- `Custom Model` を azure/<deployment-name> に設定
|
||||
- `Base URL` を Azure API の Base URL に設定 (例: `https://example-endpoint.openai.azure.com`)
|
||||
- `API Key` を Azure API キーに設定
|
||||
|
||||
### Azure OpenAI 設定
|
||||
|
||||
OpenHands を実行する際には、以下の環境変数を [docker run コマンド](../installation#running-openhands) で `-e` を使用して設定します。
|
||||
|
||||
```
|
||||
LLM_API_VERSION="<api-version>" # 例: "2024-02-15-preview"
|
||||
```
|
||||
@@ -0,0 +1,37 @@
|
||||
# Azure OpenAI LLM
|
||||
|
||||
## 補完
|
||||
|
||||
OpenHandsはLiteLLMを使用して補完リクエストを行います。Azureに関するドキュメントは[こちら](https://docs.litellm.ai/docs/providers/azure)にあります。
|
||||
|
||||
### Azure OpenAI の設定
|
||||
|
||||
OpenHands Dockerイメージを実行する際には、以下の環境変数を `-e` を使用して設定する必要があります:
|
||||
|
||||
```
|
||||
LLM_BASE_URL="<azure-api-base-url>" # 例: "https://openai-gpt-4-test-v-1.openai.azure.com/"
|
||||
LLM_API_KEY="<azure-api-key>"
|
||||
LLM_MODEL="azure/<your-gpt-deployment-name>"
|
||||
LLM_API_VERSION = "<api-version>" # 例: "2024-02-15-preview"
|
||||
```
|
||||
|
||||
:::note
|
||||
ChatGPTデプロイメント名は、Azureのデプロイメントページで確認できます。デフォルトまたは初期状態では、チャットモデル名(例えば'GPT4-1106-preview')と同じ場合がありますが、必ずしもそうである必要はありません。OpenHandsを実行し、ブラウザに読み込まれたら、設定に移動し、モデルを次のように設定します:"azure/<your-actual-gpt-deployment-name>"。リストにない場合は、独自のテキストを入力して保存します。
|
||||
:::
|
||||
|
||||
## Embeddings
|
||||
|
||||
OpenHandsはllama-indexを使用してembeddingsを生成します。Azureに関するドキュメントは[こちら](https://docs.llamaindex.ai/en/stable/api_reference/embeddings/azure_openai/)にあります。
|
||||
|
||||
### Azure OpenAI の設定
|
||||
|
||||
Azure OpenAI embeddingsで使用されるモデルは "text-embedding-ada-002" です。
|
||||
Azureアカウントでこのモデルの正しいデプロイメント名が必要です。
|
||||
|
||||
DockerでOpenHandsを実行する際には、以下の環境変数を `-e` を使用して設定してください:
|
||||
|
||||
```
|
||||
LLM_EMBEDDING_MODEL="azureopenai"
|
||||
LLM_EMBEDDING_DEPLOYMENT_NAME = "<your-embedding-deployment-name>" # 例: "TextEmbedding...<etc>"
|
||||
LLM_API_VERSION = "<api-version>" # 例: "2024-02-15-preview"
|
||||
```
|
||||
@@ -0,0 +1,106 @@
|
||||
# カスタムLLM設定
|
||||
|
||||
OpenHandsでは、`config.toml`ファイルで複数の名前付きLLM設定を定義できます。この機能により、高品質な応答が不要なタスクには低コストのモデルを使用したり、特定のエージェントに対して異なるパラメータを持つ異なるモデルを使用したりするなど、異なる用途に応じて異なるLLM設定を使用できます。
|
||||
|
||||
## 仕組み
|
||||
|
||||
名前付きLLM設定は、`config.toml`ファイルで`llm.`で始まるセクションを使用して定義されます。例:
|
||||
|
||||
```toml
|
||||
# デフォルトのLLM設定
|
||||
[llm]
|
||||
model = "gpt-4"
|
||||
api_key = "あなたのAPIキー"
|
||||
temperature = 0.0
|
||||
|
||||
# 低コストモデル用のカスタムLLM設定
|
||||
[llm.gpt3]
|
||||
model = "gpt-3.5-turbo"
|
||||
api_key = "あなたのAPIキー"
|
||||
temperature = 0.2
|
||||
|
||||
# 異なるパラメータを持つ別のカスタム設定
|
||||
[llm.high-creativity]
|
||||
model = "gpt-4"
|
||||
api_key = "あなたのAPIキー"
|
||||
temperature = 0.8
|
||||
top_p = 0.9
|
||||
```
|
||||
|
||||
各名前付き設定は、デフォルトの`[llm]`セクションからすべてのパラメータを継承し、これらのパラメータを上書きできます。必要な数のカスタム設定を定義できます。
|
||||
|
||||
## カスタム設定の使用
|
||||
|
||||
### エージェントでの使用
|
||||
|
||||
エージェントの設定セクションで`llm_config`パラメータを設定することで、エージェントが使用するLLM設定を指定できます:
|
||||
|
||||
```toml
|
||||
[agent.RepoExplorerAgent]
|
||||
# このエージェントには低コストのGPT-3設定を使用
|
||||
llm_config = 'gpt3'
|
||||
|
||||
[agent.CodeWriterAgent]
|
||||
# このエージェントには高創造性の設定を使用
|
||||
llm_config = 'high-creativity'
|
||||
```
|
||||
|
||||
### 設定オプション
|
||||
|
||||
各名前付きLLM設定は、デフォルトのLLM設定と同じすべてのオプションをサポートしています。これらには以下が含まれます:
|
||||
|
||||
- モデルの選択(`model`)
|
||||
- API設定(`api_key`、`base_url`など)
|
||||
- モデルパラメータ(`temperature`、`top_p`など)
|
||||
- リトライパラメータ(`num_retries`、`retry_multiplier`など)
|
||||
- トークン制限(`max_input_tokens`、`max_output_tokens`)
|
||||
- その他すべてのLLM設定オプション
|
||||
|
||||
利用可能なオプションの完全なリストについては、[設定オプション](../configuration-options)のドキュメントのLLM設定セクションを参照してください。
|
||||
|
||||
## ユースケース
|
||||
|
||||
カスタムLLM設定は、以下のようなシナリオで特に有用です:
|
||||
|
||||
- **コスト最適化**:リポジトリの探索やシンプルなファイル操作など、高品質な応答が不要なタスクには低コストのモデルを使用
|
||||
- **タスク固有の調整**:異なるレベルの創造性や決定論的な応答が必要なタスクに対して、異なるtemperatureやtop_p値を設定
|
||||
- **異なるプロバイダー**:異なるタスクに対して異なるLLMプロバイダーやAPIエンドポイントを使用
|
||||
- **テストと開発**:開発とテスト中に異なるモデル設定を簡単に切り替え
|
||||
|
||||
## 例:コスト最適化
|
||||
|
||||
コスト最適化のためのカスタムLLM設定の実践的な例:
|
||||
|
||||
```toml
|
||||
# 高品質な応答用のGPT-4を使用するデフォルト設定
|
||||
[llm]
|
||||
model = "gpt-4"
|
||||
api_key = "あなたのAPIキー"
|
||||
temperature = 0.0
|
||||
|
||||
# リポジトリ探索用の低コスト設定
|
||||
[llm.repo-explorer]
|
||||
model = "gpt-3.5-turbo"
|
||||
temperature = 0.2
|
||||
|
||||
# コード生成用の設定
|
||||
[llm.code-gen]
|
||||
model = "gpt-4"
|
||||
temperature = 0.0
|
||||
max_output_tokens = 2000
|
||||
|
||||
[agent.RepoExplorerAgent]
|
||||
llm_config = 'repo-explorer'
|
||||
|
||||
[agent.CodeWriterAgent]
|
||||
llm_config = 'code-gen'
|
||||
```
|
||||
|
||||
この例では:
|
||||
- リポジトリ探索は主にコードの理解とナビゲーションなので、低コストモデルを使用
|
||||
- コード生成は、より大きなコードブロックを生成するためにGPT-4とより高いトークン制限を使用
|
||||
- デフォルト設定は他のタスクで引き続き利用可能
|
||||
|
||||
:::note
|
||||
カスタムLLM設定は、`main.py`または`cli.py`を介して開発モードでOpenHandsを使用する場合にのみ利用可能です。`docker run`を介して実行する場合は、標準の設定オプションを使用してください。
|
||||
:::
|
||||
@@ -0,0 +1,31 @@
|
||||
以下は、指定されたコンテンツの日本語訳です。
|
||||
|
||||
# Google Gemini/Vertex
|
||||
|
||||
OpenHandsはLiteLLMを使用して、Googleのチャットモデルを呼び出します。Googleをプロバイダとして使用する方法については、以下のドキュメントを参照してください。
|
||||
|
||||
- [Gemini - Google AI Studio](https://docs.litellm.ai/docs/providers/gemini)
|
||||
- [VertexAI - Google Cloud Platform](https://docs.litellm.ai/docs/providers/vertex)
|
||||
|
||||
## Gemini - Google AI Studio の設定
|
||||
|
||||
OpenHandsを実行する際、設定画面で以下を設定する必要があります。
|
||||
- `LLM Provider` を `Gemini` に設定
|
||||
- `LLM Model` を使用するモデルに設定
|
||||
モデルがリストにない場合は、`Advanced` オプションを切り替えて、`Custom Model` に入力します(例: `gemini/gemini-2.0-flash` のように gemini/<model-name>)。
|
||||
- `API Key` を Gemini API キーに設定
|
||||
|
||||
## VertexAI - Google Cloud Platform の設定
|
||||
|
||||
Google Cloud Platform 経由で Vertex AI を使用して OpenHands を実行するには、[docker run コマンド](../installation#running-openhands)で `-e` を使用して以下の環境変数を設定する必要があります。
|
||||
|
||||
```
|
||||
GOOGLE_APPLICATION_CREDENTIALS="<json-dump-of-gcp-service-account-json>"
|
||||
VERTEXAI_PROJECT="<your-gcp-project-id>"
|
||||
VERTEXAI_LOCATION="<your-gcp-location>"
|
||||
```
|
||||
|
||||
その後、設定画面で以下を設定します。
|
||||
- `LLM Provider` を `VertexAI` に設定
|
||||
- `LLM Model` を使用するモデルに設定
|
||||
モデルがリストにない場合は、`Advanced` オプションを切り替えて、`Custom Model` に入力します(例: vertex_ai/<model-name>)。
|
||||
@@ -0,0 +1,28 @@
|
||||
# Google Gemini/Vertex LLM
|
||||
|
||||
## 補完
|
||||
|
||||
OpenHandsはLiteLLMを使用して補完リクエストを行います。以下のリソースは、OpenHandsをGoogleのLLMと一緒に使用する際に関連があります。
|
||||
|
||||
- [Gemini - Google AI Studio](https://docs.litellm.ai/docs/providers/gemini)
|
||||
- [VertexAI - Google Cloud Platform](https://docs.litellm.ai/docs/providers/vertex)
|
||||
|
||||
### Gemini - Google AI Studioの設定
|
||||
|
||||
OpenHandsのDockerイメージを実行する際にGoogle AI Studio経由でGeminiを使用するには、以下の環境変数を`-e`を使って設定する必要があります。
|
||||
|
||||
```
|
||||
GEMINI_API_KEY="<your-google-api-key>"
|
||||
LLM_MODEL="gemini/gemini-1.5-pro"
|
||||
```
|
||||
|
||||
### Vertex AI - Google Cloud Platformの設定
|
||||
|
||||
OpenHandsのDockerイメージを実行する際にGoogle Cloud Platform経由でVertex AIを使用するには、以下の環境変数を`-e`を使って設定する必要があります。
|
||||
|
||||
```
|
||||
GOOGLE_APPLICATION_CREDENTIALS="<gcp-service-account-json-dump>"
|
||||
VERTEXAI_PROJECT="<your-gcp-project-id>"
|
||||
VERTEXAI_LOCATION="<your-gcp-location>"
|
||||
LLM_MODEL="vertex_ai/<desired-llm-model>"
|
||||
```
|
||||
@@ -0,0 +1,20 @@
|
||||
# Groq
|
||||
|
||||
OpenHandsは、GroqのチャットモデルへのAPIコールにLiteLLMを使用します。Groqをプロバイダーとして使用する方法については、[こちら](https://docs.litellm.ai/docs/providers/groq)のドキュメントを参照してください。
|
||||
|
||||
## 設定
|
||||
|
||||
OpenHandsを実行する際、OpenHandsのUIで設定メニューから以下の項目を設定する必要があります:
|
||||
|
||||
* `LLMプロバイダー`を`Groq`に設定
|
||||
* `LLMモデル`を使用するモデルに設定。[Groqがホストするモデルのリストはこちら](https://console.groq.com/docs/models)を参照してください。モデルがリストにない場合は、`詳細設定`を有効にし、`カスタムモデル`に入力してください(例:groq/<model-name>として`groq/llama3-70b-8192`)。
|
||||
* `APIキー`をGroq APIキーに設定。Groq APIキーの確認または作成については、[こちら](https://console.groq.com/keys)を参照してください。
|
||||
|
||||
## OpenAI互換エンドポイントとしてのGroqの使用
|
||||
|
||||
Groqのチャット補完エンドポイントは[主にOpenAI互換](https://console.groq.com/docs/openai)です。そのため、他のOpenAI互換エンドポイントと同様の方法でGroqのモデルにアクセスできます。OpenHandsのUIで設定メニューから以下の項目を設定します:
|
||||
|
||||
* `詳細設定`を有効にする
|
||||
* `カスタムモデル`にプレフィックス`openai/`と使用するモデルを設定(例:`openai/llama3-70b-8192`)
|
||||
* `ベースURL`を`https://api.groq.com/openai/v1`に設定
|
||||
* `APIキー`をGroq APIキーに設定
|
||||
@@ -0,0 +1,20 @@
|
||||
# LiteLLM プロキシ
|
||||
|
||||
OpenHandsは、様々なLLMプロバイダーにアクセスするために[LiteLLMプロキシ](https://docs.litellm.ai/docs/proxy/quick_start)の使用をサポートしています。
|
||||
|
||||
## 設定
|
||||
|
||||
OpenHandsでLiteLLMプロキシを使用するには、以下の手順が必要です:
|
||||
|
||||
1. LiteLLMプロキシサーバーを設定する([LiteLLMのドキュメント](https://docs.litellm.ai/docs/proxy/quick_start)を参照)
|
||||
2. OpenHandsを実行する際、OpenHandsのUIで設定メニューから以下の項目を設定する必要があります:
|
||||
* `詳細設定`を有効にする
|
||||
* `カスタムモデル`にプレフィックス`litellm_proxy/`と使用するモデルを設定(例:`litellm_proxy/anthropic.claude-3-5-sonnet-20241022-v2:0`)
|
||||
* `ベースURL`をLiteLLMプロキシのURL(例:`https://your-litellm-proxy.com`)に設定
|
||||
* `APIキー`をLiteLLMプロキシのAPIキーに設定
|
||||
|
||||
## サポートされているモデル
|
||||
|
||||
サポートされているモデルは、LiteLLMプロキシの設定に依存します。OpenHandsは、LiteLLMプロキシが処理するように設定されているすべてのモデルをサポートします。
|
||||
|
||||
利用可能なモデルとその名前のリストについては、LiteLLMプロキシの設定を参照してください。
|
||||
@@ -0,0 +1,82 @@
|
||||
# 🤖 LLMバックエンド
|
||||
|
||||
OpenHandsは、LiteLLMがサポートするすべてのLLMに接続できます。ただし、機能するには強力なモデルが必要です。
|
||||
|
||||
## モデルの推奨事項
|
||||
|
||||
コーディングタスクに対する言語モデルの評価(SWE-benchデータセットを使用)に基づいて、モデル選択に関するいくつかの推奨事項を提供できます。分析の一部は、[LLMを比較したこのブログ記事](https://www.all-hands.dev/blog/evaluation-of-llms-as-coding-agents-on-swe-bench-at-30x-speed)と[より最近の結果を含むこのブログ記事](https://www.all-hands.dev/blog/openhands-codeact-21-an-open-state-of-the-art-software-development-agent)で確認できます。
|
||||
|
||||
モデルを選択する際は、出力の品質とコストの両方を考慮してください。結果の要約は以下の通りです:
|
||||
|
||||
- Claude 3.5 Sonnetが圧倒的に優れており、OpenHandsのデフォルトエージェントでSWE-Bench Verifiedの53%の解決率を達成しています。
|
||||
- GPT-4oは遅れを取っており、o1-miniは実際にGPT-4oよりもわずかに低いパフォーマンスを示しました。結果を少し分析したところ、o1は時々「考えすぎ」て、タスクを完了できるのに追加の環境設定タスクを実行していたようです。
|
||||
- 最後に、最も強力なオープンモデルはLlama 3.1 405 BとDeepseek-v2.5で、合理的なパフォーマンスを示し、一部のクローズドモデルを上回りました。
|
||||
|
||||
詳細については、[完全な記事](https://www.all-hands.dev/blog/evaluation-of-llms-as-coding-agents-on-swe-bench-at-30x-speed)を参照してください。
|
||||
|
||||
これらの結果とコミュニティからのフィードバックに基づいて、以下のモデルがOpenHandsで合理的に機能することが確認されています:
|
||||
|
||||
- claude-3-5-sonnet(推奨)
|
||||
- gpt-4 / gpt-4o
|
||||
- llama-3.1-405b
|
||||
- deepseek-v2.5
|
||||
|
||||
:::warning
|
||||
OpenHandsは、設定したLLMに多くのプロンプトを送信します。これらのLLMのほとんどは有料なので、支出制限を設定し、使用状況を監視してください。
|
||||
:::
|
||||
|
||||
リストにない特定のLLMでOpenHandsの実行に成功した場合は、検証済みリストに追加してください。また、同じプロバイダーとLLMを使用する他のユーザーを支援するため、設定プロセスを共有するPRを開くことをお勧めします!
|
||||
|
||||
利用可能なプロバイダーとモデルの完全なリストについては、[litellmのドキュメント](https://docs.litellm.ai/docs/providers)を参照してください。
|
||||
|
||||
:::note
|
||||
現在のほとんどのローカルおよびオープンソースモデルは、それほど強力ではありません。このようなモデルを使用する場合、メッセージ間の長い待機時間、品質の低い応答、または不正なJSONに関するエラーが発生する可能性があります。OpenHandsは、それを駆動するモデルと同じくらい強力にしかなりません。ただし、機能するモデルを見つけた場合は、上記の検証済みリストに追加してください。
|
||||
:::
|
||||
|
||||
## LLM設定
|
||||
|
||||
以下の項目は、OpenHandsのUIで設定メニューから設定できます:
|
||||
|
||||
- `LLMプロバイダー`
|
||||
- `LLMモデル`
|
||||
- `APIキー`
|
||||
- `ベースURL`(`詳細設定`から)
|
||||
|
||||
一部のLLM/プロバイダーで必要となる可能性があるが、UIでは設定できないパラメータがあります。これらは代わりに、[docker runコマンド](/modules/usage/installation#start-the-app)に`-e`を使用して環境変数として渡すことができます:
|
||||
|
||||
- `LLM_API_VERSION`
|
||||
- `LLM_EMBEDDING_MODEL`
|
||||
- `LLM_EMBEDDING_DEPLOYMENT_NAME`
|
||||
- `LLM_DROP_PARAMS`
|
||||
- `LLM_DISABLE_VISION`
|
||||
- `LLM_CACHING_PROMPT`
|
||||
|
||||
特定のモデルプロバイダーでOpenHandsを実行するためのガイドがいくつかあります:
|
||||
|
||||
- [Azure](llms/azure-llms)
|
||||
- [Google](llms/google-llms)
|
||||
- [Groq](llms/groq)
|
||||
- [LiteLLM Proxy](llms/litellm-proxy)
|
||||
- [OpenAI](llms/openai-llms)
|
||||
- [OpenRouter](llms/openrouter)
|
||||
|
||||
### APIリトライとレート制限
|
||||
|
||||
LLMプロバイダーは通常、レート制限を持っており、時には非常に低い制限で、リトライが必要になる場合があります。OpenHandsは、レート制限エラー(エラーコード429)、API接続エラー、またはその他の一時的なエラーを受信した場合、自動的にリクエストを再試行します。
|
||||
|
||||
使用しているプロバイダーのニーズに応じて、これらのオプションをカスタマイズできます。プロバイダーのドキュメントを確認し、以下の環境変数を設定してリトライ回数とリトライ間の待機時間を制御してください:
|
||||
|
||||
- `LLM_NUM_RETRIES`(デフォルト8)
|
||||
- `LLM_RETRY_MIN_WAIT`(デフォルト15秒)
|
||||
- `LLM_RETRY_MAX_WAIT`(デフォルト120秒)
|
||||
- `LLM_RETRY_MULTIPLIER`(デフォルト2)
|
||||
|
||||
OpenHandsを開発モードで実行している場合、これらのオプションを`config.toml`ファイルで設定することもできます:
|
||||
|
||||
```toml
|
||||
[llm]
|
||||
num_retries = 8
|
||||
retry_min_wait = 15
|
||||
retry_max_wait = 120
|
||||
retry_multiplier = 2
|
||||
```
|
||||
@@ -0,0 +1,190 @@
|
||||
# ローカルLLMとOllama
|
||||
|
||||
:::warning
|
||||
ローカルLLMを使用する場合、OpenHandsの機能が制限される可能性があります。
|
||||
:::
|
||||
|
||||
Ollamaサーバーが起動し、実行中であることを確認してください。
|
||||
詳細な起動手順については、[こちら](https://github.com/ollama/ollama)を参照してください。
|
||||
|
||||
このガイドでは、`ollama serve`でollamaを起動したことを前提としています。ollamaを別の方法で実行している場合(例:dockerの中で)、手順を変更する必要があるかもしれません。WSLを実行している場合、デフォルトのollama設定ではdockerコンテナからのリクエストがブロックされることに注意してください。[こちら](#configuring-ollama-service-wsl-ja)を参照してください。
|
||||
|
||||
## モデルのプル
|
||||
|
||||
Ollamaモデル名は[こちら](https://ollama.com/library)で確認できます。小さな例として、`codellama:7b`モデルを使用できます。一般的に、より大きなモデルの方が性能が良くなります。
|
||||
|
||||
```bash
|
||||
ollama pull codellama:7b
|
||||
```
|
||||
|
||||
ダウンロードしたモデルは以下のように確認できます:
|
||||
|
||||
```bash
|
||||
~$ ollama list
|
||||
NAME ID SIZE MODIFIED
|
||||
codellama:7b 8fdf8f752f6e 3.8 GB 6 weeks ago
|
||||
mistral:7b-instruct-v0.2-q4_K_M eb14864c7427 4.4 GB 2 weeks ago
|
||||
starcoder2:latest f67ae0f64584 1.7 GB 19 hours ago
|
||||
```
|
||||
|
||||
## DockerでOpenHandsを実行
|
||||
|
||||
### OpenHandsの起動
|
||||
[こちら](../getting-started)の手順を使用して、DockerでOpenHandsを起動します。
|
||||
ただし、`docker run`を実行する際に、いくつかの引数を追加する必要があります:
|
||||
|
||||
```bash
|
||||
docker run # ...
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
-e LLM_OLLAMA_BASE_URL="http://host.docker.internal:11434" \
|
||||
# ...
|
||||
```
|
||||
|
||||
LLM_OLLAMA_BASE_URLはオプションです。設定すると、UIでインストール済みの利用可能なモデルを表示するために使用されます。
|
||||
|
||||
|
||||
### Webアプリケーションの設定
|
||||
|
||||
`openhands`を実行する際、OpenHands UIの設定で以下を設定する必要があります:
|
||||
- モデルを"ollama/<model-name>"に
|
||||
- ベースURLを`http://host.docker.internal:11434`に
|
||||
- APIキーはオプションで、`ollama`などの任意の文字列を使用できます。
|
||||
|
||||
|
||||
## 開発モードでOpenHandsを実行
|
||||
|
||||
### ソースからビルド
|
||||
|
||||
[Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)の手順を使用して、OpenHandsをビルドします。
|
||||
`make setup-config`を実行して`config.toml`が存在することを確認してください。これにより、設定ファイルが作成されます。`config.toml`に以下を入力します:
|
||||
|
||||
```
|
||||
[core]
|
||||
workspace_base="./workspace"
|
||||
|
||||
[llm]
|
||||
embedding_model="local"
|
||||
ollama_base_url="http://localhost:11434"
|
||||
|
||||
```
|
||||
|
||||
これで完了です!`make run`でOpenHandsを起動できるようになりました。`http://localhost:3000/`に接続できるはずです。
|
||||
|
||||
### Webアプリケーションの設定
|
||||
|
||||
OpenHands UIで、左下の設定ホイールをクリックします。
|
||||
次に、`Model`入力に`ollama/codellama:7b`、または先ほどプルしたモデルの名前を入力します。
|
||||
ドロップダウンに表示されない場合は、`Advanced Settings`を有効にして入力してください。注意:`ollama list`で表示されるモデル名に、接頭辞`ollama/`を付ける必要があります。
|
||||
|
||||
APIキーフィールドには、特定のキーが不要なので、`ollama`または任意の値を入力します。
|
||||
|
||||
ベースURLフィールドには、`http://localhost:11434`を入力します。
|
||||
|
||||
これで準備完了です!
|
||||
|
||||
## ollamaサービスの設定(WSL) {#configuring-ollama-service-wsl-ja}
|
||||
|
||||
WSLのollamaのデフォルト設定では、localhostのみにサービスを提供します。つまり、dockerコンテナからアクセスできません。例えば、OpenHandsでは動作しません。まず、ollamaが正しく実行されていることをテストしましょう。
|
||||
|
||||
```bash
|
||||
ollama list # インストール済みモデルのリストを取得
|
||||
curl http://localhost:11434/api/generate -d '{"model":"[NAME]","prompt":"hi"}'
|
||||
#例 curl http://localhost:11434/api/generate -d '{"model":"codellama:7b","prompt":"hi"}'
|
||||
#例 curl http://localhost:11434/api/generate -d '{"model":"codellama","prompt":"hi"}' #タグは1つしかない場合はオプション
|
||||
```
|
||||
|
||||
完了したら、dockerコンテナ内からの「外部」リクエストを許可するかテストします。
|
||||
|
||||
```bash
|
||||
docker ps # 実行中のdockerコンテナのリストを取得。最も正確なテストのためにOpenHandsサンドボックスコンテナを選択。
|
||||
docker exec [CONTAINER ID] curl http://host.docker.internal:11434/api/generate -d '{"model":"[NAME]","prompt":"hi"}'
|
||||
#例 docker exec cd9cc82f7a11 curl http://host.docker.internal:11434/api/generate -d '{"model":"codellama","prompt":"hi"}'
|
||||
```
|
||||
|
||||
## 修正方法
|
||||
|
||||
それでは、動作するようにしましょう。sudo権限で/etc/systemd/system/ollama.serviceを編集します。(パスはLinuxの種類によって異なる場合があります)
|
||||
|
||||
```bash
|
||||
sudo vi /etc/systemd/system/ollama.service
|
||||
```
|
||||
|
||||
または
|
||||
|
||||
```bash
|
||||
sudo nano /etc/systemd/system/ollama.service
|
||||
```
|
||||
|
||||
[Service]ブラケットにこれらの行を追加します
|
||||
|
||||
```
|
||||
Environment="OLLAMA_HOST=0.0.0.0:11434"
|
||||
Environment="OLLAMA_ORIGINS=*"
|
||||
```
|
||||
|
||||
そして保存し、設定をリロードしてサービスを再起動します。
|
||||
|
||||
```bash
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl restart ollama
|
||||
```
|
||||
|
||||
最後に、コンテナ内からollamaにアクセスできることをテストします
|
||||
|
||||
```bash
|
||||
ollama list # インストール済みモデルのリストを取得
|
||||
docker ps # 実行中のdockerコンテナのリストを取得。最も正確なテストのためにOpenHandsサンドボックスコンテナを選択。
|
||||
docker exec [CONTAINER ID] curl http://host.docker.internal:11434/api/generate -d '{"model":"[NAME]","prompt":"hi"}'
|
||||
```
|
||||
|
||||
|
||||
# ローカルLLMとLM Studio
|
||||
|
||||
LM Studioのセットアップ手順:
|
||||
1. LM Studioを開きます
|
||||
2. ローカルサーバータブに移動します。
|
||||
3. 「サーバーを起動」ボタンをクリックします。
|
||||
4. ドロップダウンから使用するモデルを選択します。
|
||||
|
||||
|
||||
以下の設定を行います:
|
||||
```bash
|
||||
LLM_MODEL="openai/lmstudio"
|
||||
LLM_BASE_URL="http://localhost:1234/v1"
|
||||
CUSTOM_LLM_PROVIDER="openai"
|
||||
```
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
docker run # ...
|
||||
-e LLM_MODEL="openai/lmstudio" \
|
||||
-e LLM_BASE_URL="http://host.docker.internal:1234/v1" \
|
||||
-e CUSTOM_LLM_PROVIDER="openai" \
|
||||
# ...
|
||||
```
|
||||
|
||||
これで、`http://localhost:3000/`に接続できるはずです。
|
||||
|
||||
開発環境では、`config.toml`ファイルに以下の設定を行うことができます:
|
||||
|
||||
```
|
||||
[core]
|
||||
workspace_base="./workspace"
|
||||
|
||||
[llm]
|
||||
model="openai/lmstudio"
|
||||
base_url="http://localhost:1234/v1"
|
||||
custom_llm_provider="openai"
|
||||
```
|
||||
|
||||
完了です!これで、Dockerなしで`make run`を実行してOpenHandsを起動できます。`http://localhost:3000/`に接続できるはずです。
|
||||
|
||||
# 注意
|
||||
|
||||
WSLの場合、cmdで以下のコマンドを実行して、ネットワークモードをミラーに設定します:
|
||||
|
||||
```
|
||||
python -c "print('[wsl2]\nnetworkingMode=mirrored',file=open(r'%UserProfile%\.wslconfig','w'))"
|
||||
wsl --shutdown
|
||||
```
|
||||
@@ -0,0 +1,140 @@
|
||||
# Ollama を使用したローカル LLM
|
||||
|
||||
Ollama サーバーが実行中であることを確認してください。
|
||||
詳細な起動手順については、[こちら](https://github.com/ollama/ollama)を参照してください。
|
||||
|
||||
このガイドでは、`ollama serve` で ollama を起動していることを前提としています。ollama を別の方法で実行している場合(例えば、docker 内で実行している場合)、手順を変更する必要があるかもしれません。WSL を使用している場合、ollama のデフォルト設定では docker コンテナからのリクエストがブロックされることに注意してください。[こちら](#configuring-ollama-service-ja)を参照してください。
|
||||
|
||||
## モデルのダウンロード
|
||||
|
||||
Ollama のモデル名は[こちら](https://ollama.com/library)で確認できます。小さなサンプルとしては、`codellama:7b` モデルを使用できます。一般的に、より大きなモデルの方がパフォーマンスが良くなります。
|
||||
|
||||
```bash
|
||||
ollama pull codellama:7b
|
||||
```
|
||||
|
||||
ダウンロードしたモデルは以下のように確認できます:
|
||||
|
||||
```bash
|
||||
~$ ollama list
|
||||
NAME ID SIZE MODIFIED
|
||||
codellama:7b 8fdf8f752f6e 3.8 GB 6 weeks ago
|
||||
mistral:7b-instruct-v0.2-q4_K_M eb14864c7427 4.4 GB 2 weeks ago
|
||||
starcoder2:latest f67ae0f64584 1.7 GB 19 hours ago
|
||||
```
|
||||
|
||||
## OpenHands の起動
|
||||
|
||||
### Docker
|
||||
|
||||
[こちら](../intro)の手順を使用して、Docker で OpenHands を起動します。
|
||||
ただし、`docker run` を実行する際に、いくつかの追加引数が必要になります:
|
||||
|
||||
```bash
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
-e LLM_API_KEY="ollama" \
|
||||
-e LLM_BASE_URL="http://host.docker.internal:11434" \
|
||||
```
|
||||
|
||||
例:
|
||||
|
||||
```bash
|
||||
# OpenHands に変更させたいディレクトリ。絶対パスでなければなりません!
|
||||
export WORKSPACE_BASE=$(pwd)/workspace
|
||||
|
||||
docker run \
|
||||
-it \
|
||||
--pull=always \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
-e SANDBOX_USER_ID=$(id -u) \
|
||||
-e LLM_API_KEY="ollama" \
|
||||
-e LLM_BASE_URL="http://host.docker.internal:11434" \
|
||||
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
|
||||
-v $WORKSPACE_BASE:/opt/workspace_base \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-p 3000:3000 \
|
||||
ghcr.io/all-hands-ai/openhands:main
|
||||
```
|
||||
|
||||
これで `http://localhost:3000/` に接続できるはずです。
|
||||
|
||||
### ソースからのビルド
|
||||
|
||||
[Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md) の手順を使用して、OpenHands をビルドします。
|
||||
`make setup-config` を実行して `config.toml` が存在することを確認してください。これにより、`config.toml` が作成されます。`config.toml` に以下を入力します:
|
||||
|
||||
```
|
||||
LLM_MODEL="ollama/codellama:7b"
|
||||
LLM_API_KEY="ollama"
|
||||
LLM_EMBEDDING_MODEL="local"
|
||||
LLM_BASE_URL="http://localhost:11434"
|
||||
WORKSPACE_BASE="./workspace"
|
||||
WORKSPACE_DIR="$(pwd)/workspace"
|
||||
```
|
||||
|
||||
必要に応じて、`LLM_MODEL` を選択したものに置き換えてください。
|
||||
|
||||
以上で完了です!これで、Docker なしで `make run` を使用して OpenHands を起動できます。`http://localhost:3000/` に接続できるはずです。
|
||||
|
||||
## モデルの選択
|
||||
|
||||
OpenHands のインターフェースで、左下の設定アイコンをクリックします。
|
||||
次に、`Model` の入力欄に `ollama/codellama:7b` または先ほどダウンロードしたモデル名を入力します。
|
||||
ドロップダウンメニューに表示されなくても問題ありません。そのまま入力してください。完了したら、保存をクリックします。
|
||||
|
||||
これで、開始する準備が整いました!
|
||||
|
||||
## ollama サービスの設定 (WSL){#configuring-ollama-service-ja}
|
||||
|
||||
WSL 上の ollama のデフォルト設定では、localhost のみが提供されます。つまり、docker コンテナなどから到達できないため、OpenHands では動作しません。まず、ollama が正しく実行されているかテストしてみましょう。
|
||||
|
||||
```bash
|
||||
ollama list # インストールされているモデルのリストを取得
|
||||
curl http://localhost:11434/api/generate -d '{"model":"[NAME]","prompt":"hi"}'
|
||||
#例 curl http://localhost:11434/api/generate -d '{"model":"codellama:7b","prompt":"hi"}'
|
||||
#例 curl http://localhost:11434/api/generate -d '{"model":"codellama","prompt":"hi"}' #タグは1つしかない場合はオプション
|
||||
```
|
||||
|
||||
これが完了したら、docker コンテナなどからの「外部」リクエストを受け入れるかどうかをテストします。
|
||||
|
||||
```bash
|
||||
docker ps # 実行中の docker コンテナのリストを取得。最も正確なテストのために OpenHands サンドボックスコンテナを選択。
|
||||
docker exec [CONTAINER ID] curl http://host.docker.internal:11434/api/generate -d '{"model":"[NAME]","prompt":"hi"}'
|
||||
#例 docker exec cd9cc82f7a11 curl http://host.docker.internal:11434/api/generate -d '{"model":"codellama","prompt":"hi"}'
|
||||
```
|
||||
|
||||
## 修正
|
||||
|
||||
これで動作するようにしましょう。sudo 権限で /etc/systemd/system/ollama.service を編集します。(パスは Linux ディストリビューションによって異なる場合があります)
|
||||
|
||||
```bash
|
||||
sudo vi /etc/systemd/system/ollama.service
|
||||
```
|
||||
|
||||
または
|
||||
|
||||
```bash
|
||||
sudo nano /etc/systemd/system/ollama.service
|
||||
```
|
||||
|
||||
[Service] セクションに、以下の行を追加します
|
||||
|
||||
```
|
||||
Environment="OLLAMA_HOST=0.0.0.0:11434"
|
||||
Environment="OLLAMA_ORIGINS=*"
|
||||
```
|
||||
|
||||
次に、保存し、設定をリロードしてサービスを再起動します。
|
||||
|
||||
```bash
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl restart ollama
|
||||
```
|
||||
|
||||
最後に、コンテナから ollama にアクセスできることをテストします
|
||||
|
||||
```bash
|
||||
ollama list # インストールされているモデルのリストを取得
|
||||
docker ps # 実行中の docker コンテナのリストを取得。最も正確なテストのために OpenHands サンドボックスコンテナを選択。
|
||||
docker exec [CONTAINER ID] curl http://host.docker.internal:11434/api/generate -d '{"model":"[NAME]","prompt":"hi"}'
|
||||
```
|
||||
@@ -0,0 +1,26 @@
|
||||
# OpenAI
|
||||
|
||||
OpenHandsは、OpenAIのチャットモデルへのAPIコールにLiteLLMを使用します。OpenAIをプロバイダーとして使用する方法については、[こちら](https://docs.litellm.ai/docs/providers/openai)のドキュメントを参照してください。
|
||||
|
||||
## 設定
|
||||
|
||||
OpenHandsを実行する際、OpenHandsのUIで設定メニューから以下の項目を設定する必要があります:
|
||||
|
||||
* `LLMプロバイダー`を`OpenAI`に設定
|
||||
* `LLMモデル`を使用するモデルに設定。
|
||||
[LiteLLMがサポートするOpenAIモデルの完全なリストはこちら](https://docs.litellm.ai/docs/providers/openai#openai-chat-completion-models)を参照してください。
|
||||
モデルがリストにない場合は、`詳細設定`を有効にし、`カスタムモデル`に入力してください(例:openai/<model-name>として`openai/gpt-4o`)。
|
||||
* `APIキー`をOpenAI APIキーに設定。OpenAIプロジェクトのAPIキーの確認または作成については、[こちら](https://platform.openai.com/api-keys)を参照してください。
|
||||
|
||||
## OpenAI互換エンドポイントの使用
|
||||
|
||||
OpenAIのチャット補完と同様に、OpenAI互換エンドポイントにもLiteLLMを使用します。この件に関する完全なドキュメントは[こちら](https://docs.litellm.ai/docs/providers/openai_compatible)を参照してください。
|
||||
|
||||
## OpenAIプロキシの使用
|
||||
|
||||
OpenAIプロキシを使用する場合、OpenHandsのUIで設定メニューから以下の項目を設定する必要があります:
|
||||
|
||||
* `詳細設定`を有効にする
|
||||
* `カスタムモデル`をopenai/<model-name>に設定(例:`openai/gpt-4o`またはopenai/<proxy-prefix>/<model-name>)
|
||||
* `ベースURL`をOpenAIプロキシのURLに設定
|
||||
* `APIキー`をOpenAI APIキーに設定
|
||||
@@ -0,0 +1,13 @@
|
||||
# OpenRouter
|
||||
|
||||
OpenHandsは、OpenRouterのチャットモデルへのAPIコールにLiteLLMを使用します。OpenRouterをプロバイダーとして使用する方法については、[こちら](https://docs.litellm.ai/docs/providers/openrouter)のドキュメントを参照してください。
|
||||
|
||||
## 設定
|
||||
|
||||
OpenHandsを実行する際、OpenHandsのUIで設定メニューから以下の項目を設定する必要があります:
|
||||
|
||||
* `LLMプロバイダー`を`OpenRouter`に設定
|
||||
* `LLMモデル`を使用するモデルに設定。
|
||||
[OpenRouterのモデルの完全なリストはこちら](https://openrouter.ai/models)を参照してください。
|
||||
モデルがリストにない場合は、`詳細設定`を有効にし、`カスタムモデル`に入力してください(例:openrouter/<model-name>として`openrouter/anthropic/claude-3.5-sonnet`)。
|
||||
* `APIキー`をOpenRouter APIキーに設定。
|
||||
@@ -0,0 +1,41 @@
|
||||
# プロンプトのベストプラクティス
|
||||
|
||||
OpenHands AIソフトウェア開発者と連携する際、明確で効果的なプロンプトを提供することが非常に重要です。このガイドでは、最も正確で有用な応答を生み出すプロンプトを作成するためのベストプラクティスについて説明します。
|
||||
|
||||
## 良いプロンプトの特徴
|
||||
|
||||
良いプロンプトは以下のような特徴があります。
|
||||
|
||||
1. **具体的** : どの機能を追加するか、どのバグを修正する必要があるかを正確に説明します。
|
||||
2. **場所を特定** : 可能な場合は、コードベース内のどの場所を変更する必要があるかを説明します。
|
||||
3. **適切なサイズ** : 1つの機能に対応したサイズで、通常は100行以内のコードに収まります。
|
||||
|
||||
## 例
|
||||
|
||||
### 良いプロンプトの例
|
||||
|
||||
1. "`utils/math_operations.py` に `calculate_average` 関数を追加してください。この関数は数値のリストを入力として受け取り、その平均値を返します。"
|
||||
|
||||
2. "`frontend/src/components/UserProfile.tsx` の42行目で発生している TypeError を修正してください。このエラーは、undefined のプロパティにアクセスしようとしていることを示唆しています。"
|
||||
|
||||
3. "サインアップフォームの email フィールドに入力検証を実装してください。`frontend/src/components/RegistrationForm.tsx` を更新し、送信前にメールアドレスが有効な形式であるかどうかを確認します。"
|
||||
|
||||
### 悪いプロンプトの例
|
||||
|
||||
1. "コードを改善してください。" (あまりにも曖昧で具体性に欠ける)
|
||||
|
||||
2. "バックエンド全体を別のフレームワークを使用するように書き換えてください。" (適切なサイズではない)
|
||||
|
||||
3. "ユーザー認証のどこかにバグがあります。それを見つけて修正できますか?" (具体性と場所情報が不足している)
|
||||
|
||||
## 効果的なプロンプトのヒント
|
||||
|
||||
1. 望ましい結果や解決すべき問題について、できるだけ具体的に説明してください。
|
||||
2. 関連するファイルパスや行番号など、コンテキストを提供してください。
|
||||
3. 大きなタスクは、より小さく管理しやすいプロンプトに分割してください。
|
||||
4. 関連するエラーメッセージやログをすべて含めてください。
|
||||
5. コンテキストから明らかでない場合は、プログラミング言語やフレームワークを指定してください。
|
||||
|
||||
プロンプトが具体的で情報量が多いほど、AIはOpenHandsソフトウェアの開発や修正をより効果的に支援できることを忘れないでください。
|
||||
|
||||
役立つプロンプトの他の例については、[OpenHands入門](./getting-started)を参照してください。
|
||||
@@ -0,0 +1,64 @@
|
||||
# リポジトリ固有の動作のカスタマイズ
|
||||
|
||||
OpenHandsは、リポジトリ固有のコンテキストとガイダンスを提供することで、特定のリポジトリでより効果的に機能するようにカスタマイズできます。このセクションでは、OpenHandsをプロジェクトに最適化する方法について説明します。
|
||||
|
||||
## リポジトリの設定
|
||||
|
||||
リポジトリのルートに`.openhands`ディレクトリを作成することで、OpenHandsの動作をリポジトリ用にカスタマイズできます。最低限、このディレクトリには`.openhands/microagents/repo.md`ファイルが含まれている必要があります。このファイルには、エージェントがこのリポジトリで作業するたびに与えられる指示が含まれています。
|
||||
|
||||
以下の情報を含めることをお勧めします。
|
||||
1. **リポジトリの概要**: プロジェクトの目的とアーキテクチャの簡単な説明
|
||||
2. **ディレクトリ構造**: 主要なディレクトリとその目的
|
||||
3. **開発ガイドライン**: プロジェクト固有のコーディング標準と慣行
|
||||
4. **テスト要件**: テストの実行方法と必要なテストの種類
|
||||
5. **セットアップ手順**: プロジェクトのビルドと実行に必要な手順
|
||||
|
||||
### リポジトリ設定の例
|
||||
`.openhands/microagents/repo.md`ファイルの例:
|
||||
```
|
||||
Repository: MyProject
|
||||
Description: タスク管理用のWebアプリケーション
|
||||
|
||||
ディレクトリ構造:
|
||||
- src/: アプリケーションのメインコード
|
||||
- tests/: テストファイル
|
||||
- docs/: ドキュメンテーション
|
||||
|
||||
セットアップ:
|
||||
- `npm install`を実行して依存関係をインストールします
|
||||
- 開発には`npm run dev`を使用します
|
||||
- テストには`npm test`を実行します
|
||||
|
||||
ガイドライン:
|
||||
- ESLint設定に従ってください
|
||||
- 新機能にはすべてテストを書いてください
|
||||
- 新しいコードにはTypeScriptを使用してください
|
||||
```
|
||||
|
||||
### プロンプトのカスタマイズ
|
||||
|
||||
カスタマイズされたリポジトリで作業する場合:
|
||||
|
||||
1. **プロジェクトの標準を参照する**: プロジェクトで使用されている特定のコーディング標準やパターンに言及する
|
||||
2. **コンテキストを含める**: 関連するドキュメンテーションや既存の実装を参照する
|
||||
3. **テスト要件を指定する**: プロジェクト固有のテスト要件をプロンプトに含める
|
||||
|
||||
カスタムプロンプトの例:
|
||||
```
|
||||
既存のコンポーネントパターンに従って、src/components/TaskList.tsxにタスク完了の新機能を追加してください。
|
||||
tests/components/にユニットテストを含め、docs/features/のドキュメントを更新してください。
|
||||
コンポーネントはsrc/styles/componentsの共有スタイルを使用する必要があります。
|
||||
```
|
||||
|
||||
### リポジトリカスタマイズのベストプラクティス
|
||||
|
||||
1. **指示を最新に保つ**: プロジェクトの進化に合わせて、`.openhands`ディレクトリを定期的に更新する
|
||||
2. **具体的にする**: プロジェクト固有のパス、パターン、要件を含める
|
||||
3. **依存関係を文書化する**: 開発に必要なすべてのツールと依存関係を列挙する
|
||||
4. **例を含める**: プロジェクトからの良いコード例を提供する
|
||||
5. **規約を指定する**: 命名規則、ファイル構成、コードスタイルの好みを文書化する
|
||||
|
||||
OpenHandsをリポジトリ用にカスタマイズすることで、プロジェクトの標準と要件に沿ったより正確で一貫した結果が得られます。
|
||||
|
||||
## その他のマイクロエージェント
|
||||
`.openhands/microagents/`ディレクトリに、`test`、`frontend`、`migration`などの特定のキーワードが見つかった場合にエージェントに送信される追加の指示を作成できます。詳細については、[Microagents](microagents.md)を参照してください。
|
||||
@@ -0,0 +1,33 @@
|
||||
# Microagentsの概要
|
||||
|
||||
Microagentsは、ドメイン固有の知識、リポジトリ固有のコンテキスト、タスク固有のワークフローでOpenHandsを強化する特殊なプロンプトです。専門家のガイダンスを提供し、一般的なタスクを自動化し、プロジェクト全体で一貫したプラクティスを確保するのに役立ちます。
|
||||
|
||||
## Microagentの種類
|
||||
|
||||
現在、OpenHandsは以下の種類のmicroagentsをサポートしています:
|
||||
|
||||
* [リポジトリMicroagents](./microagents-repo): OpenHands用のリポジトリ固有のコンテキストとガイドライン。
|
||||
* [パブリックMicroagents](./microagents-public): すべてのOpenHandsユーザーのためにキーワードによってトリガーされる一般的なガイドライン。
|
||||
|
||||
OpenHandsがリポジトリで動作する際:
|
||||
|
||||
1. リポジトリに`.openhands/microagents/`が存在する場合、そこからリポジトリ固有の指示を読み込みます。
|
||||
2. 会話のキーワードによってトリガーされる一般的なガイドラインを読み込みます。
|
||||
現在の[パブリックMicroagents](https://github.com/All-Hands-AI/OpenHands/tree/main/microagents/knowledge)を参照してください。
|
||||
|
||||
## Microagentのフォーマット
|
||||
|
||||
すべてのmicroagentsは、YAMLのfrontmatterを持つmarkdownファイルを使用します。これには、OpenHandsがタスクを達成するための特別な指示が含まれています:
|
||||
```
|
||||
---
|
||||
name: <Microagentの名前>
|
||||
type: <Microagentのタイプ>
|
||||
version: <Microagentのバージョン>
|
||||
agent: <エージェントのタイプ (通常はCodeActAgent)>
|
||||
triggers:
|
||||
- <オプション: microagentをトリガーするキーワード。トリガーを削除すると、常に含まれるようになります>
|
||||
---
|
||||
|
||||
<OpenHandsが従うべき特別なガイドライン、指示、プロンプトを含むMarkdown。
|
||||
ベストプラクティスに関する各microagentの具体的なドキュメントを確認してください。>
|
||||
```
|
||||
@@ -0,0 +1,91 @@
|
||||
# パブリックマイクロエージェント
|
||||
|
||||
## 概要
|
||||
|
||||
パブリックマイクロエージェントは、OpenHandsのすべてのユーザーが利用できる一般的なガイドラインを提供します。これらは、特定のキーワードによってトリガーされ、特定のドメインやタスクに関する専門知識を提供します。
|
||||
|
||||
## 現在のパブリックマイクロエージェント
|
||||
|
||||
### GitHubエージェント
|
||||
|
||||
GitHubエージェントは、GitHubリポジトリとの対話を支援します。主な機能:
|
||||
|
||||
* リポジトリのクローン
|
||||
* ブランチの作成と切り替え
|
||||
* コミットとプッシュ
|
||||
* プルリクエストの作成
|
||||
|
||||
### NPMエージェント
|
||||
|
||||
NPMエージェントは、Node.jsプロジェクトの管理を支援します:
|
||||
|
||||
* パッケージのインストールと更新
|
||||
* 依存関係の管理
|
||||
* スクリプトの実行
|
||||
* バージョン管理
|
||||
|
||||
## パブリックマイクロエージェントの貢献
|
||||
|
||||
### パブリックマイクロエージェントのベストプラクティス
|
||||
|
||||
1. **明確なトリガー**:エージェントをトリガーするキーワードを明確に定義します
|
||||
2. **集中的な範囲**:1つのドメインまたはタスクに焦点を当てます
|
||||
3. **明確なガイドライン**:エージェントの責任と制限を明確に説明します
|
||||
4. **実用的な例**:一般的なユースケースの例を含めます
|
||||
|
||||
### パブリックマイクロエージェントを貢献するステップ
|
||||
|
||||
1. [マイクロエージェントのフォーマット](./microagents-overview#microagent-format)を確認します
|
||||
2. 新しいマイクロエージェントファイルを作成します
|
||||
3. ガイドラインとベストプラクティスに従っていることを確認します
|
||||
4. プルリクエストを作成します
|
||||
|
||||
### パブリックマイクロエージェントの実装例
|
||||
|
||||
```
|
||||
---
|
||||
name: Dockerエージェント
|
||||
type: public
|
||||
version: 1.0
|
||||
agent: CodeActAgent
|
||||
triggers:
|
||||
- docker
|
||||
- container
|
||||
---
|
||||
|
||||
あなたはDockerコンテナの管理とDockerfileの作成を担当します。
|
||||
|
||||
主な責任:
|
||||
1. Dockerfileの作成と修正
|
||||
2. コンテナのライフサイクル管理
|
||||
3. Docker Compose設定の処理
|
||||
|
||||
ガイドライン:
|
||||
- 可能な限り公式ベースイメージを使用
|
||||
- 必要なセキュリティ考慮事項を含める
|
||||
- レイヤー最適化のためのDockerベストプラクティスに従う
|
||||
|
||||
例:
|
||||
1. Dockerfileの作成:
|
||||
FROM node:18-alpine
|
||||
WORKDIR /app
|
||||
COPY package*.json ./
|
||||
RUN npm install
|
||||
COPY . .
|
||||
CMD ["npm", "start"]
|
||||
|
||||
2. Docker Composeの使用:
|
||||
version: '3'
|
||||
services:
|
||||
web:
|
||||
build: .
|
||||
ports:
|
||||
- "3000:3000"
|
||||
|
||||
忘れないこと:
|
||||
- Dockerfileの構文を検証
|
||||
- セキュリティ脆弱性をチェック
|
||||
- ビルド時間とイメージサイズを最適化
|
||||
```
|
||||
|
||||
より多くの例については、[現在のパブリックマイクロエージェント](https://github.com/All-Hands-AI/OpenHands/tree/main/microagents/knowledge)をご覧ください。
|
||||
@@ -0,0 +1,67 @@
|
||||
# リポジトリマイクロエージェント
|
||||
|
||||
## 概要
|
||||
|
||||
OpenHandsは、リポジトリ固有のコンテキストとガイドラインを提供することで、特定のリポジトリでより効果的に動作するようにカスタマイズできます。このセクションでは、OpenHandsをプロジェクトに最適化する方法を説明します。
|
||||
|
||||
## リポジトリマイクロエージェントの作成
|
||||
|
||||
リポジトリのルートに`.openhands/microagents/`ディレクトリを作成することで、リポジトリに対するOpenHandsの動作をカスタマイズできます。
|
||||
最低限、このリポジトリで作業する際にエージェントに与えられる指示を含む
|
||||
`.openhands/microagents/repo.md`ファイルが必要です。
|
||||
|
||||
### リポジトリマイクロエージェントのベストプラクティス
|
||||
|
||||
* **指示を最新に保つ**:プロジェクトの進化に合わせて`.openhands/microagents/`ディレクトリを定期的に更新します。
|
||||
* **具体的に**:プロジェクト固有のパス、パターン、要件を含めます。
|
||||
* **依存関係を文書化**:開発に必要なすべてのツールと依存関係をリストアップします。
|
||||
* **例を含める**:プロジェクトの良いコードパターンの例を提供します。
|
||||
* **規約を指定**:命名規則、ファイル構成、コードスタイルの設定を文書化します。
|
||||
|
||||
### リポジトリマイクロエージェントを作成するステップ
|
||||
|
||||
#### 1. リポジトリマイクロエージェントの計画
|
||||
|
||||
リポジトリ固有のマイクロエージェントを作成する際は、以下の情報を含めることを推奨します:
|
||||
|
||||
* **リポジトリの概要**:プロジェクトの目的とアーキテクチャの簡単な説明。
|
||||
* **ディレクトリ構造**:主要なディレクトリとその目的。
|
||||
* **開発ガイドライン**:プロジェクト固有のコーディング標準とプラクティス。
|
||||
* **テスト要件**:テストの実行方法と必要なテストの種類。
|
||||
* **セットアップ手順**:プロジェクトのビルドと実行に必要な手順。
|
||||
|
||||
#### 2. ファイルの作成
|
||||
|
||||
リポジトリの`.openhands/microagents/`ディレクトリにファイルを作成します(例:`.openhands/microagents/repo.md`)
|
||||
|
||||
[必要なフォーマット](./microagents-overview#microagent-format)に従って必要なフロントマターと、リポジトリに必要な特殊なガイドラインでファイルを更新します。
|
||||
|
||||
### リポジトリマイクロエージェントの例
|
||||
|
||||
```
|
||||
---
|
||||
name: repo
|
||||
type: repo
|
||||
agent: CodeActAgent
|
||||
---
|
||||
|
||||
リポジトリ:MyProject
|
||||
説明:タスク管理のためのWebアプリケーション
|
||||
|
||||
ディレクトリ構造:
|
||||
- src/:メインアプリケーションコード
|
||||
- tests/:テストファイル
|
||||
- docs/:ドキュメント
|
||||
|
||||
セットアップ:
|
||||
- `npm install`で依存関係をインストール
|
||||
- 開発には`npm run dev`を使用
|
||||
- テストには`npm test`を実行
|
||||
|
||||
ガイドライン:
|
||||
- ESLint設定に従う
|
||||
- すべての新機能にテストを書く
|
||||
- 新しいコードにはTypeScriptを使用
|
||||
|
||||
src/componentsに新しいコンポーネントを追加する場合は、必ずtests/components/に適切なユニットテストを追加してください。
|
||||
```
|
||||
@@ -0,0 +1,213 @@
|
||||
# マイクロエージェント
|
||||
|
||||
OpenHandsは、特定のタスクやコンテキストを効率的に処理するために、特殊なマイクロエージェントを利用しています。これらのマイクロエージェントは、特定のシナリオに特化した動作と知識を提供する小さな目的指向のコンポーネントです。
|
||||
|
||||
## 概要
|
||||
|
||||
マイクロエージェントは、`openhands/agenthub/codeact_agent/micro/`ディレクトリ下のマークダウンファイルで定義されます。各マイクロエージェントは以下の設定を持ちます:
|
||||
|
||||
- 一意の名前
|
||||
- エージェントのタイプ(通常はCodeActAgent)
|
||||
- エージェントを起動するトリガーキーワード
|
||||
- 特定の指示と能力
|
||||
|
||||
## 利用可能なマイクロエージェント
|
||||
|
||||
### GitHubエージェント
|
||||
**ファイル**: `github.md`
|
||||
**トリガー**: `github`, `git`
|
||||
|
||||
GitHubエージェントは、GitHub APIとのインタラクションとリポジトリ管理に特化しています。これは:
|
||||
- API認証用の`GITHUB_TOKEN`にアクセスできる
|
||||
- リポジトリとのインタラクションに厳密なガイドラインに従う
|
||||
- ブランチとプルリクエストを管理する
|
||||
- Webブラウザでのインタラクションの代わりにGitHub APIを使用する
|
||||
|
||||
主な機能:
|
||||
- ブランチ保護(main/masterへの直接プッシュを防止)
|
||||
- 自動PRの作成
|
||||
- Git設定の管理
|
||||
- GitHub操作のためのAPI中心のアプローチ
|
||||
|
||||
### NPMエージェント
|
||||
**ファイル**: `npm.md`
|
||||
**トリガー**: `npm`
|
||||
|
||||
npmパッケージの管理に特化し、特に以下に焦点を当てています:
|
||||
- 非対話的なシェル操作
|
||||
- Unixの'yes'コマンドを使用した自動確認の管理
|
||||
- パッケージインストールの自動化
|
||||
|
||||
### カスタムマイクロエージェント
|
||||
|
||||
マイクロエージェントディレクトリに新しいマークダウンファイルを追加することで、独自のマイクロエージェントを作成できます。各ファイルは次の構造に従う必要があります:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: エージェント名
|
||||
agent: CodeActAgent
|
||||
triggers:
|
||||
- トリガー1
|
||||
- トリガー2
|
||||
---
|
||||
|
||||
マイクロエージェントの指示と能力...
|
||||
```
|
||||
|
||||
## ベストプラクティス
|
||||
|
||||
マイクロエージェントを使用する際は:
|
||||
|
||||
1. **適切なトリガーを使用する**: コマンドに関連するトリガーキーワードを含めて、正しいマイクロエージェントを起動するようにします
|
||||
2. **エージェントのガイドラインに従う**: 各エージェントには特定の指示と制限があります - 最適な結果を得るためにそれらに従ってください
|
||||
3. **API中心のアプローチ**: 可能な場合は、Webインターフェースではなく、APIエンドポイントを使用します
|
||||
4. **自動化に優しい**: 非対話的な環境でうまく機能するコマンドを設計します
|
||||
|
||||
## 統合
|
||||
|
||||
マイクロエージェントは自動的にOpenHandsのワークフローに統合されます。これらは:
|
||||
- 着信コマンドをモニタリングしてトリガーキーワードを検出する
|
||||
- 関連するトリガーが検出されたときに起動する
|
||||
- 特殊な知識と能力を適用する
|
||||
- 特定のガイドラインと制限に従う
|
||||
|
||||
## 使用例
|
||||
|
||||
```bash
|
||||
# GitHubエージェントの例
|
||||
git checkout -b feature-branch
|
||||
git commit -m "Add new feature"
|
||||
git push origin feature-branch
|
||||
|
||||
# NPMエージェントの例
|
||||
yes | npm install package-name
|
||||
```
|
||||
|
||||
特定のエージェントの詳細については、マイクロエージェントディレクトリ内の個別のドキュメントファイルを参照してください。
|
||||
|
||||
## マイクロエージェントの貢献
|
||||
|
||||
OpenHandsに新しいマイクロエージェントを貢献するには、次のガイドラインに従ってください:
|
||||
|
||||
### 1. マイクロエージェントの計画
|
||||
|
||||
マイクロエージェントを作成する前に、以下を検討してください:
|
||||
- どの特定の問題やユースケースに対処するのか?
|
||||
- どのようなユニークな能力や知識を持つべきか?
|
||||
- どのトリガーキーワードを使用するのが適切か?
|
||||
- どのような制約やガイドラインに従うべきか?
|
||||
|
||||
### 2. ファイル構造
|
||||
|
||||
`openhands/agenthub/codeact_agent/micro/`に新しいマークダウンファイルを作成し、説明的な名前を付けます(例:Dockerに特化したエージェントの場合は`docker.md`)。
|
||||
|
||||
### 3. 必要なコンポーネント
|
||||
|
||||
マイクロエージェントファイルには以下を含める必要があります:
|
||||
|
||||
1. **フロントマター**: ファイルの先頭にYAMLメタデータ:
|
||||
```markdown
|
||||
---
|
||||
name: エージェント名
|
||||
agent: CodeActAgent
|
||||
triggers:
|
||||
- トリガー1
|
||||
- トリガー2
|
||||
---
|
||||
```
|
||||
|
||||
2. **指示**: エージェントの動作に関する明確で具体的な指示:
|
||||
```markdown
|
||||
あなたは[特定のタスク/ドメイン]を担当しています。
|
||||
|
||||
主な責任:
|
||||
1. [責任1]
|
||||
2. [責任2]
|
||||
|
||||
ガイドライン:
|
||||
- [ガイドライン1]
|
||||
- [ガイドライン2]
|
||||
|
||||
使用例:
|
||||
[例1]
|
||||
[例2]
|
||||
```
|
||||
|
||||
### 4. マイクロエージェント開発のベストプラクティス
|
||||
|
||||
1. **明確な範囲**: エージェントを特定のドメインまたはタスクに集中させる
|
||||
2. **明示的な指示**: 明確で曖昧さのない指示を提供する
|
||||
3. **有用な例**: 一般的なユースケースの実用的な例を含める
|
||||
4. **セキュリティ第一**: 必要な警告と制約を含める
|
||||
5. **統合の認識**: エージェントが他のコンポーネントとどのように相互作用するかを考慮する
|
||||
|
||||
### 5. マイクロエージェントのテスト
|
||||
|
||||
提出前に:
|
||||
1. さまざまなプロンプトでエージェントをテストする
|
||||
2. トリガーキーワードがエージェントを正しく起動することを確認する
|
||||
3. 指示が明確で完全であることを確認する
|
||||
4. 既存のエージェントとの潜在的な競合を確認する
|
||||
|
||||
### 6. 実装例
|
||||
|
||||
新しいマイクロエージェントのテンプレートを以下に示します:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: docker
|
||||
agent: CodeActAgent
|
||||
triggers:
|
||||
- docker
|
||||
- コンテナ
|
||||
---
|
||||
|
||||
あなたはDockerコンテナの管理とDockerfileの作成を担当しています。
|
||||
|
||||
主な責任:
|
||||
1. Dockerfileの作成と変更
|
||||
2. コンテナのライフサイクル管理
|
||||
3. Docker Compose設定の管理
|
||||
|
||||
ガイドライン:
|
||||
- 可能な限り公式のベースイメージを使用する
|
||||
- 必要なセキュリティの考慮事項を含める
|
||||
- レイヤー最適化のためのDockerベストプラクティスに従う
|
||||
|
||||
例:
|
||||
1. Dockerfileの作成:
|
||||
```dockerfile
|
||||
FROM node:18-alpine
|
||||
WORKDIR /app
|
||||
COPY package*.json ./
|
||||
RUN npm install
|
||||
COPY . .
|
||||
CMD ["npm", "start"]
|
||||
```
|
||||
|
||||
2. Docker Composeの使用:
|
||||
```yaml
|
||||
version: '3'
|
||||
services:
|
||||
web:
|
||||
build: .
|
||||
ports:
|
||||
- "3000:3000"
|
||||
```
|
||||
|
||||
忘れずに:
|
||||
- Dockerfileの構文を検証する
|
||||
- セキュリティの脆弱性を確認する
|
||||
- ビルド時間とイメージサイズを最適化する
|
||||
```
|
||||
|
||||
### 7. 提出プロセス
|
||||
|
||||
1. 適切なディレクトリにマイクロエージェントファイルを作成する
|
||||
2. 徹底的にテストする
|
||||
3. 以下を含むプルリクエストを提出する:
|
||||
- 新しいマイクロエージェントファイル
|
||||
- 必要に応じて更新されたドキュメント
|
||||
- エージェントの目的と能力の説明
|
||||
|
||||
マイクロエージェントは、特定のドメインでOpenHandsの能力を拡張する強力な方法であることを忘れないでください。適切に設計されたエージェントは、特殊なタスクを処理するシステムの能力を大幅に向上させることができます。
|
||||
@@ -0,0 +1,37 @@
|
||||
# プロンプトのベストプラクティス
|
||||
|
||||
OpenHands AIソフトウェア開発者と連携する際、明確で効果的なプロンプトを提供することが重要です。このガイドでは、最も正確で有用な応答を引き出すためのプロンプト作成のベストプラクティスについて説明します。
|
||||
|
||||
## 良いプロンプトの特徴
|
||||
|
||||
良いプロンプトは以下のような特徴があります:
|
||||
|
||||
- **具体的**:どのような機能を追加すべきか、またはどのようなエラーを修正する必要があるかを正確に説明します。
|
||||
- **場所を特定**:可能であれば、コードベース内のどの場所を修正すべきかを説明します。
|
||||
- **適切な範囲**:1つの機能の大きさであるべきで、通常は100行のコードを超えないようにします。
|
||||
|
||||
## 例
|
||||
|
||||
### 良いプロンプトの例
|
||||
|
||||
- "`utils/math_operations.py`に、数値のリストを入力として受け取り、その平均を返す関数`calculate_average`を追加してください。"
|
||||
- "`frontend/src/components/UserProfile.tsx`の42行目で発生しているTypeErrorを修正してください。このエラーは、undefinedのプロパティにアクセスしようとしていることを示唆しています。"
|
||||
- "登録フォームのメールフィールドに入力検証を実装してください。`frontend/src/components/RegistrationForm.tsx`を更新し、送信前にメールが有効な形式であるかどうかを確認するようにしてください。"
|
||||
|
||||
### 悪いプロンプトの例
|
||||
|
||||
- "コードをもっと良くしてください。"(曖昧すぎる、具体性に欠ける)
|
||||
- "バックエンド全体を別のフレームワークを使用するように書き換えてください。"(適切な範囲ではない)
|
||||
- "ユーザー認証のどこかにバグがあります。見つけて修正できますか?"(具体性とロケーション情報に欠ける)
|
||||
|
||||
## 効果的なプロンプトのためのヒント
|
||||
|
||||
- 望ましい結果や解決すべき問題について、できるだけ具体的に説明してください。
|
||||
- 関連するファイルパスや行番号など、コンテキストを提供してください。
|
||||
- 大きなタスクは、より小さく管理しやすいプロンプトに分割してください。
|
||||
- 関連するエラーメッセージやログを含めてください。
|
||||
- コンテキストから明らかでない場合は、プログラミング言語やフレームワークを指定してください。
|
||||
|
||||
プロンプトが正確で情報量が多いほど、AIはOpenHandsソフトウェアの開発や修正においてより良いサポートができることを覚えておいてください。
|
||||
|
||||
役立つプロンプトの他の例については、[OpenHands入門](../getting-started)を参照してください。
|
||||
@@ -0,0 +1,22 @@
|
||||
# ランタイム設定
|
||||
|
||||
ランタイムとは、OpenHands エージェントがファイルを編集したりコマンドを実行したりできる環境のことです。
|
||||
|
||||
デフォルトでは、OpenHands はローカルコンピュータ上で動作する Docker ベースのランタイムを使用します。
|
||||
つまり、使用している LLM の料金のみを支払えばよく、コードが LLM に送信されるだけです。
|
||||
|
||||
また、通常はサードパーティが管理する「リモート」ランタイムもサポートしています。
|
||||
特に多数の OpenHands 会話を並行して実行する場合(例えば評価を行う場合など)、セットアップがより簡単でスケーラブルになります。
|
||||
|
||||
さらに、Docker を使用せずに直接マシン上で実行される「ローカル」ランタイムも提供しており、
|
||||
CI パイプラインのような制御された環境で役立ちます。
|
||||
|
||||
## 利用可能なランタイム
|
||||
|
||||
OpenHands は以下のようなさまざまなランタイム環境をサポートしています。
|
||||
|
||||
- [Docker ランタイム](./runtimes/docker.md) - 分離のために Docker コンテナを使用するデフォルトのランタイム(ほとんどのユーザーにお勧め)
|
||||
- [OpenHands リモートランタイム](./runtimes/remote.md) - 並列実行用のクラウドベースのランタイム(ベータ版)
|
||||
- [Modal ランタイム](./runtimes/modal.md) - パートナーである Modal 社が提供するランタイム
|
||||
- [Daytona ランタイム](./runtimes/daytona.md) - Daytona 社が提供するランタイム
|
||||
- [ローカルランタイム](./runtimes/local.md) - Docker を使用せずにローカルマシン上で直接実行
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
slug: /usage/runtimes
|
||||
title: Runtime Configuration
|
||||
---
|
||||
|
||||
Here is the translation in Japanese, preserving the code block and not translating the code:
|
||||
|
||||
import { Redirect } from '@docusaurus/router';
|
||||
|
||||
<Redirect to="/modules/usage/runtimes-index" />
|
||||
@@ -0,0 +1,32 @@
|
||||
# Daytona ランタイム
|
||||
|
||||
[Daytona](https://www.daytona.io/) をランタイムプロバイダーとして使用できます:
|
||||
|
||||
## ステップ 1: Daytona API キーを取得する
|
||||
1. [Daytona ダッシュボード](https://app.daytona.io/dashboard/keys)にアクセスします。
|
||||
2. **「Create Key」**をクリックします。
|
||||
3. キーの名前を入力し、作成を確認します。
|
||||
4. キーが生成されたら、それをコピーします。
|
||||
|
||||
## ステップ 2: API キーを環境変数として設定する
|
||||
ターミナルで以下のコマンドを実行し、`<your-api-key>` をコピーした実際のキーに置き換えます:
|
||||
```bash
|
||||
export DAYTONA_API_KEY="<your-api-key>"
|
||||
```
|
||||
|
||||
このステップにより、OpenHands が実行されるときに Daytona プラットフォームで認証できるようになります。
|
||||
|
||||
## ステップ 3: Docker を使用してローカルで OpenHands を実行する
|
||||
マシン上で最新バージョンの OpenHands を起動するには、ターミナルで次のコマンドを実行します:
|
||||
```bash
|
||||
bash -i <(curl -sL https://get.daytona.io/openhands)
|
||||
```
|
||||
|
||||
### このコマンドの動作:
|
||||
- 最新の OpenHands リリーススクリプトをダウンロードします。
|
||||
- インタラクティブな Bash セッションでスクリプトを実行します。
|
||||
- Docker を使用して OpenHands コンテナを自動的にプルして実行します。
|
||||
|
||||
実行すると、OpenHands がローカルで実行され、使用準備が整います。
|
||||
|
||||
詳細と手動初期化については、[README.md](https://github.com/All-Hands-AI/OpenHands/blob/main/openhands/runtime/impl/daytona/README.md) 全体を参照してください。
|
||||
@@ -0,0 +1,86 @@
|
||||
# Docker ランタイム
|
||||
|
||||
これは、OpenHands を起動するときに使用されるデフォルトのランタイムです。
|
||||
|
||||
## イメージ
|
||||
nikolaik の `SANDBOX_RUNTIME_CONTAINER_IMAGE` は、ランタイムサーバーと Python および NodeJS の基本的なユーティリティを含む事前ビルドされたランタイムイメージです。
|
||||
[独自のランタイムイメージを構築する](../how-to/custom-sandbox-guide)こともできます。
|
||||
|
||||
## ファイルシステムへの接続
|
||||
ここでの便利な機能の1つは、ローカルファイルシステムに接続する機能です。ファイルシステムをランタイムにマウントするには:
|
||||
1. `WORKSPACE_BASE` を設定します:
|
||||
|
||||
```bash
|
||||
export WORKSPACE_BASE=/path/to/your/code
|
||||
|
||||
# Linux と Mac の例
|
||||
# export WORKSPACE_BASE=$HOME/OpenHands
|
||||
# $WORKSPACE_BASE を /home/<username>/OpenHands に設定します
|
||||
#
|
||||
# Windows の WSL の例
|
||||
# export WORKSPACE_BASE=/mnt/c/dev/OpenHands
|
||||
# $WORKSPACE_BASE を C:\dev\OpenHands に設定します
|
||||
```
|
||||
2. 以下のオプションを `docker run` コマンドに追加します:
|
||||
|
||||
```bash
|
||||
docker run # ...
|
||||
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik \
|
||||
-e SANDBOX_USER_ID=$(id -u) \
|
||||
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
|
||||
-v $WORKSPACE_BASE:/opt/workspace_base \
|
||||
# ...
|
||||
```
|
||||
|
||||
注意してください!OpenHands エージェントがワークスペースにマウントされたファイルを削除または変更することを妨げるものはありません。
|
||||
|
||||
このセットアップはファイルのアクセス権に関する問題を引き起こす可能性がありますが(そのため `SANDBOX_USER_ID` 変数があります)、ほとんどのシステムでうまく機能します。
|
||||
|
||||
## 強化された Docker インストール
|
||||
|
||||
セキュリティが優先される環境に OpenHands をデプロイする場合は、強化された Docker 構成の実装を検討する必要があります。このセクションでは、デフォルト構成を超えて OpenHands Docker デプロイメントを保護するための推奨事項を提供します。
|
||||
|
||||
### セキュリティに関する考慮事項
|
||||
|
||||
README のデフォルトの Docker 構成は、ローカル開発マシンでの使いやすさを考慮して設計されています。公共ネットワーク(例:空港の WiFi)で実行している場合は、追加のセキュリティ対策を実装する必要があります。
|
||||
|
||||
### ネットワークバインディングのセキュリティ
|
||||
|
||||
デフォルトでは、OpenHands はすべてのネットワークインターフェース(`0.0.0.0`)にバインドされ、ホストが接続しているすべてのネットワークにインスタンスが公開される可能性があります。より安全なセットアップのために:
|
||||
|
||||
1. **ネットワークバインディングの制限**:
|
||||
|
||||
`runtime_binding_address` 構成を使用して、OpenHands がリッスンするネットワークインターフェースを制限します:
|
||||
|
||||
```bash
|
||||
docker run # ...
|
||||
-e SANDBOX_RUNTIME_BINDING_ADDRESS=127.0.0.1 \
|
||||
# ...
|
||||
```
|
||||
|
||||
この構成により、OpenHands はループバックインターフェース(`127.0.0.1`)でのみリッスンし、ローカルマシンからのみアクセス可能になります。
|
||||
|
||||
2. **ポートバインディングの保護**:
|
||||
|
||||
`-p` フラグを変更して、すべてのインターフェースではなくローカルホストにのみバインドします:
|
||||
|
||||
```bash
|
||||
docker run # ... \
|
||||
-p 127.0.0.1:3000:3000 \
|
||||
```
|
||||
|
||||
これにより、OpenHands ウェブインターフェースはローカルマシンからのみアクセス可能になり、ネットワーク上の他のマシンからはアクセスできなくなります。
|
||||
|
||||
### ネットワーク分離
|
||||
|
||||
Docker のネットワーク機能を使用して OpenHands を分離します:
|
||||
|
||||
```bash
|
||||
# 分離されたネットワークを作成
|
||||
docker network create openhands-network
|
||||
|
||||
# 分離されたネットワークで OpenHands を実行
|
||||
docker run # ... \
|
||||
--network openhands-network \
|
||||
docker.all-hands.dev/all-hands-ai/openhands:0.34
|
||||
```
|
||||
@@ -0,0 +1,62 @@
|
||||
# ローカルランタイム
|
||||
|
||||
ローカルランタイムを使用すると、OpenHands エージェントは Docker を使用せずに直接ローカルマシン上でアクションを実行できます。このランタイムは主に、Docker が利用できない CI パイプラインやテストシナリオなどの制御された環境向けです。
|
||||
|
||||
:::caution
|
||||
**セキュリティ警告**: ローカルランタイムはサンドボックス分離なしで実行されます。エージェントはマシン上のファイルに直接アクセスして変更できます。制御された環境でのみ、またはセキュリティへの影響を十分に理解している場合にのみ、このランタイムを使用してください。
|
||||
:::
|
||||
|
||||
## 前提条件
|
||||
|
||||
ローカルランタイムを使用する前に、以下を確認してください:
|
||||
|
||||
1. [開発セットアップ手順](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)に従っていること。
|
||||
2. tmux がシステムで利用可能であること。
|
||||
|
||||
## 設定
|
||||
|
||||
ローカルランタイムを使用するには、モデル、API キーなどの必要な設定に加えて、OpenHands を起動するときに環境変数または[config.toml ファイル](https://github.com/All-Hands-AI/OpenHands/blob/main/config.template.toml)を介して以下のオプションを設定する必要があります:
|
||||
|
||||
- 環境変数を介して:
|
||||
|
||||
```bash
|
||||
# 必須
|
||||
export RUNTIME=local
|
||||
|
||||
# オプションですが推奨
|
||||
export WORKSPACE_BASE=/path/to/your/workspace
|
||||
```
|
||||
|
||||
- `config.toml` を介して:
|
||||
|
||||
```toml
|
||||
[core]
|
||||
runtime = "local"
|
||||
workspace_base = "/path/to/your/workspace"
|
||||
```
|
||||
|
||||
`WORKSPACE_BASE` が設定されていない場合、ランタイムはエージェントが作業するための一時ディレクトリを作成します。
|
||||
|
||||
## 使用例
|
||||
|
||||
以下は、ヘッドレスモードでローカルランタイムを使用して OpenHands を起動する例です:
|
||||
|
||||
```bash
|
||||
# ランタイムタイプをローカルに設定
|
||||
export RUNTIME=local
|
||||
|
||||
# オプションでワークスペースディレクトリを設定
|
||||
export WORKSPACE_BASE=/path/to/your/project
|
||||
|
||||
# OpenHands を起動
|
||||
poetry run python -m openhands.core.main -t "hi と出力する bash スクリプトを書いてください"
|
||||
```
|
||||
|
||||
## ユースケース
|
||||
|
||||
ローカルランタイムは特に以下の場合に役立ちます:
|
||||
|
||||
- Docker が利用できない CI/CD パイプライン。
|
||||
- OpenHands 自体のテストと開発。
|
||||
- コンテナの使用が制限されている環境。
|
||||
- ファイルシステムへの直接アクセスが必要なシナリオ。
|
||||
@@ -0,0 +1,13 @@
|
||||
# Modal ランタイム
|
||||
|
||||
[Modal](https://modal.com/) のパートナーが OpenHands 用のランタイムを提供しています。
|
||||
|
||||
Modal ランタイムを使用するには、アカウントを作成し、[API キーを作成](https://modal.com/settings)してください。
|
||||
|
||||
その後、OpenHands を起動するときに以下の環境変数を設定する必要があります:
|
||||
```bash
|
||||
docker run # ...
|
||||
-e RUNTIME=modal \
|
||||
-e MODAL_API_TOKEN_ID="your-id" \
|
||||
-e MODAL_API_TOKEN_SECRET="your-secret" \
|
||||
```
|
||||
@@ -0,0 +1,6 @@
|
||||
# OpenHands リモートランタイム
|
||||
|
||||
OpenHands リモートランタイムは現在ベータ版です(詳細は[こちら](https://runtime.all-hands.dev/)を参照)。クラウド内で並列にランタイムを起動することができます。
|
||||
試してみたい場合は、[このフォーム](https://docs.google.com/forms/d/e/1FAIpQLSckVz_JFwg2_mOxNZjCtr7aoBFI2Mwdan3f75J_TrdMS1JV2g/viewform)に記入して申し込んでください!
|
||||
|
||||
注意:このランタイムは、[OpenHands 評価ハーネス](https://github.com/All-Hands-AI/OpenHands/tree/main/evaluation)を通じてのエージェント評価目的のみのために特別に設計されています。本番環境の OpenHands アプリケーションの起動には使用しないでください。
|
||||
@@ -0,0 +1,43 @@
|
||||
# 🚧 トラブルシューティング
|
||||
|
||||
:::tip
|
||||
OpenHandsはWSL経由でのみWindowsをサポートしています。必ずWSLターミナル内でコマンドを実行してください。
|
||||
:::
|
||||
|
||||
### Dockerクライアントの起動に失敗
|
||||
|
||||
**説明**
|
||||
|
||||
OpenHandsを実行する際に、以下のようなエラーが表示される:
|
||||
```
|
||||
Launch docker client failed. Please make sure you have installed docker and started docker desktop/daemon.
|
||||
```
|
||||
|
||||
**解決策**
|
||||
|
||||
以下の順番で試してみてください:
|
||||
* システム上で`docker`が実行されていることを確認します。ターミナルで`docker ps`が正常に実行できるはずです。
|
||||
* Docker Desktopを使用している場合は、`Settings > Advanced > Allow the default Docker socket to be used`が有効になっていることを確認してください。
|
||||
* 設定によっては、Docker Desktopで`Settings > Resources > Network > Enable host networking`を有効にする必要があるかもしれません。
|
||||
* Docker Desktopを再インストールしてみてください。
|
||||
---
|
||||
|
||||
# 開発ワークフロー固有の問題
|
||||
### runtimeのDockerイメージのビルドエラー
|
||||
|
||||
**説明**
|
||||
|
||||
新しいセッションの開始に失敗し、ログに以下のようなエラーが表示される:
|
||||
```
|
||||
debian-security bookworm-security
|
||||
InRelease At least one invalid signature was encountered.
|
||||
```
|
||||
|
||||
これは、既存の外部ライブラリのハッシュが変更され、ローカルのDockerインスタンスが以前のバージョンをキャッシュしている場合に発生するようです。これを回避するには、以下を試してみてください:
|
||||
|
||||
* 名前が`openhands-runtime-`で始まるコンテナを停止します:
|
||||
`docker ps --filter name=openhands-runtime- --filter status=running -aq | xargs docker stop`
|
||||
* 名前が`openhands-runtime-`で始まるコンテナを削除します:
|
||||
`docker rmi $(docker images --filter name=openhands-runtime- -q --no-trunc)`
|
||||
* 名前が`openhands-runtime-`で始まるコンテナ/イメージを停止して削除します
|
||||
* コンテナ/イメージをプルーンします: `docker container prune -f && docker image prune -f`
|
||||
@@ -0,0 +1,65 @@
|
||||
# ⬆️ アップグレードガイド
|
||||
|
||||
## 0.8.0 (2024-07-13)
|
||||
|
||||
### 重要な設定変更
|
||||
|
||||
このバージョンでは、バックエンドの設定にいくつかの重要な変更を導入しました。
|
||||
OpenHandsをフロントエンドインターフェース(Webインターフェース)のみで使用していた場合、特に対応は必要ありません。
|
||||
|
||||
以下は、設定の重要な変更点のリストです。これらは`main.py`経由でOpenHands CLIを使用しているユーザーにのみ適用されます。
|
||||
詳細については、[#2756](https://github.com/All-Hands-AI/OpenHands/pull/2756)を参照してください。
|
||||
|
||||
#### main.pyの--model-nameオプションの削除
|
||||
|
||||
`--model-name`オプション(または`-m`)は廃止されました。LLMの設定は`config.toml`または環境変数で行う必要があります。
|
||||
|
||||
#### LLM設定グループは'llm'のサブグループである必要がある
|
||||
|
||||
0.8より前のバージョンでは、`config.toml`内のLLM設定に任意の名前を使用できました。例:
|
||||
|
||||
```toml
|
||||
[gpt-4o]
|
||||
model="gpt-4o"
|
||||
api_key="<your_api_key>"
|
||||
```
|
||||
|
||||
その後、CLI引数の`--llm-config`を使用して、名前で目的のLLM設定グループを指定できました。
|
||||
これは機能しなくなりました。代わりに、設定グループは`llm`グループの下にある必要があります。例:
|
||||
|
||||
```toml
|
||||
[llm.gpt-4o]
|
||||
model="gpt-4o"
|
||||
api_key="<your_api_key>"
|
||||
```
|
||||
|
||||
`llm`という名前の設定グループがある場合は、変更する必要はありません。デフォルトのLLM設定グループとして使用されます。
|
||||
|
||||
#### 'agent'グループには'name'フィールドが含まれなくなった
|
||||
|
||||
0.8より前のバージョンでは、以下のような`agent`という名前の設定グループがあってもなくてもよかったです:
|
||||
|
||||
```toml
|
||||
[agent]
|
||||
name="CodeActAgent"
|
||||
memory_max_threads=2
|
||||
```
|
||||
|
||||
`name`フィールドは削除されたことに注意してください。代わりに、`core`グループの下に`default_agent`フィールドを置く必要があります。例:
|
||||
|
||||
```toml
|
||||
[core]
|
||||
# その他の設定
|
||||
default_agent='CodeActAgent'
|
||||
|
||||
[agent]
|
||||
llm_config='llm'
|
||||
memory_max_threads=2
|
||||
|
||||
[agent.CodeActAgent]
|
||||
llm_config='gpt-4o'
|
||||
```
|
||||
|
||||
`llm`サブグループと同様に、`agent`サブグループも定義できることに注意してください。
|
||||
さらに、エージェントを特定のLLM設定グループに関連付けることができます。
|
||||
詳細については、`config.template.toml`の例を参照してください。
|
||||
34
docs/i18n/ja/docusaurus-theme-classic/navbar.json
Normal file
34
docs/i18n/ja/docusaurus-theme-classic/navbar.json
Normal file
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"title": {
|
||||
"message": "OpenHands",
|
||||
"description": "The title in the navbar"
|
||||
},
|
||||
"logo.alt": {
|
||||
"message": "OpenHands",
|
||||
"description": "The alt text of navbar logo"
|
||||
},
|
||||
"item.label.Docs": {
|
||||
"message": "ドキュメント",
|
||||
"description": "Navbar item with label Docs"
|
||||
},
|
||||
"item.label.Codebase": {
|
||||
"message": "コードベース",
|
||||
"description": "Navbar item with label Codebase"
|
||||
},
|
||||
"item.label.FAQ": {
|
||||
"message": "よくある質問",
|
||||
"description": "Navbar item with label FAQ"
|
||||
},
|
||||
"item.label.GitHub": {
|
||||
"message": "GitHub",
|
||||
"description": "Navbar item with label GitHub"
|
||||
},
|
||||
"item.label.User Guides": {
|
||||
"message": "ユーザーガイド",
|
||||
"description": "Navbar item with label User Guides"
|
||||
},
|
||||
"item.label.Company": {
|
||||
"message": "会社情報",
|
||||
"description": "Navbar item with label Company"
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user