mirror of
https://github.com/OpenHands/OpenHands.git
synced 2025-12-26 05:48:36 +08:00
Fix Cloud documentation structure and consolidate issue resolver information (#8558)
Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: mamoodi <mamoodiha@gmail.com>
This commit is contained in:
Graham Neubig
GitHub
parent
2906a9023f
commit
13f9acd48a
@ -1,33 +0,0 @@
|
||||
# Résolveur GitHub Cloud
|
||||
|
||||
Le Résolveur GitHub automatise les corrections de code et fournit une assistance intelligente pour vos dépôts.
|
||||
|
||||
## Configuration
|
||||
|
||||
Le Résolveur GitHub Cloud est disponible automatiquement lorsque vous
|
||||
[accordez l'accès au dépôt OpenHands Cloud](./openhands-cloud#adding-repository-access).
|
||||
|
||||
## Utilisation
|
||||
|
||||
Après avoir accordé l'accès au dépôt OpenHands Cloud, vous pouvez utiliser le Résolveur GitHub Cloud sur les problèmes et les pull requests
|
||||
du dépôt.
|
||||
|
||||
### Problèmes (Issues)
|
||||
|
||||
Sur votre dépôt, étiquetez un problème avec `openhands`. OpenHands va :
|
||||
1. Commenter le problème pour vous informer qu'il y travaille.
|
||||
- Vous pouvez cliquer sur le lien pour suivre la progression sur OpenHands Cloud.
|
||||
2. Ouvrir une pull request s'il détermine que le problème a été résolu avec succès.
|
||||
3. Commenter le problème avec un résumé des tâches effectuées et un lien vers la pull request.
|
||||
|
||||
|
||||
### Pull Requests
|
||||
|
||||
Pour qu'OpenHands travaille sur des pull requests, utilisez `@openhands` dans les commentaires de premier niveau ou en ligne pour :
|
||||
- Poser des questions
|
||||
- Demander des mises à jour
|
||||
- Obtenir des explications de code
|
||||
|
||||
OpenHands va :
|
||||
1. Commenter la PR pour vous informer qu'il y travaille.
|
||||
2. Effectuer la tâche.
|
||||
@ -0,0 +1,32 @@
|
||||
# Résolveur de Problèmes Cloud
|
||||
|
||||
Le Résolveur de Problèmes Cloud automatise les corrections de code et fournit une assistance intelligente pour vos dépôts sur GitHub et GitLab.
|
||||
|
||||
## Configuration
|
||||
|
||||
Le Résolveur de Problèmes Cloud est disponible automatiquement lorsque vous accordez l'accès au dépôt OpenHands Cloud :
|
||||
- [Accès au dépôt GitHub](./github-installation#adding-repository-access)
|
||||
- [Accès au dépôt GitLab](./gitlab-installation#adding-repository-access)
|
||||
|
||||
## Utilisation
|
||||
|
||||
Après avoir accordé l'accès au dépôt OpenHands Cloud, vous pouvez utiliser le Résolveur de Problèmes Cloud sur les problèmes et les pull/merge requests dans vos dépôts.
|
||||
|
||||
### Travailler avec les Problèmes
|
||||
|
||||
Sur votre dépôt, étiquetez un problème avec `openhands`. OpenHands va :
|
||||
1. Commenter le problème pour vous faire savoir qu'il y travaille
|
||||
- Vous pouvez cliquer sur le lien pour suivre la progression sur OpenHands Cloud
|
||||
2. Ouvrir une pull request (GitHub) ou une merge request (GitLab) s'il détermine que le problème a été résolu avec succès
|
||||
3. Commenter le problème avec un résumé des tâches effectuées et un lien vers la PR/MR
|
||||
|
||||
### Travailler avec les Pull/Merge Requests
|
||||
|
||||
Pour qu'OpenHands travaille sur les pull requests (GitHub) ou les merge requests (GitLab), mentionnez `@openhands` dans les commentaires pour :
|
||||
- Poser des questions
|
||||
- Demander des mises à jour
|
||||
- Obtenir des explications de code
|
||||
|
||||
OpenHands va :
|
||||
1. Commenter pour vous faire savoir qu'il y travaille
|
||||
2. Effectuer la tâche demandée
|
||||
@ -0,0 +1,29 @@
|
||||
# Interface Cloud
|
||||
|
||||
L'interface Cloud fournit une interface web pour interagir avec OpenHands AI. Cette page explique comment accéder et utiliser l'interface Cloud d'OpenHands.
|
||||
|
||||
## Accès à l'Interface
|
||||
|
||||
L'interface Cloud d'OpenHands est accessible à [app.all-hands.dev](https://app.all-hands.dev). Vous devrez vous connecter avec votre compte GitHub ou GitLab pour accéder à l'interface.
|
||||
|
||||
<!-- Image will be added in a future update -->
|
||||
<!--  -->
|
||||
|
||||
## Fonctionnalités Clés
|
||||
|
||||
Pour des informations détaillées sur les fonctionnalités disponibles dans l'interface Cloud d'OpenHands, veuillez consulter la section [Fonctionnalités Clés](../key-features.md) de la documentation.
|
||||
|
||||
## Paramètres
|
||||
|
||||
La page des paramètres vous permet de :
|
||||
|
||||
1. Configurer les préférences de votre compte
|
||||
2. Gérer l'accès aux dépôts
|
||||
3. Générer des clés API pour un accès programmatique
|
||||
4. Personnaliser votre expérience OpenHands
|
||||
|
||||
## Prochaines Étapes
|
||||
|
||||
- [Utiliser le Résolveur de Problèmes Cloud](./cloud-issue-resolver.md) pour automatiser les corrections de code et obtenir de l'aide
|
||||
- [En savoir plus sur l'API Cloud](./cloud-api.md) pour un accès programmatique
|
||||
- [Retourner à la Mise en Route](./openhands-cloud.md)
|
||||
@ -0,0 +1,55 @@
|
||||
# Installation GitHub
|
||||
|
||||
Ce guide vous accompagne dans le processus d'installation et de configuration d'OpenHands Cloud pour vos dépôts GitHub.
|
||||
|
||||
## Prérequis
|
||||
|
||||
- Un compte GitHub
|
||||
- Accès à OpenHands Cloud
|
||||
|
||||
## Étapes d'Installation
|
||||
|
||||
1. Connectez-vous à [OpenHands Cloud](https://app.all-hands.dev)
|
||||
2. Si vous n'avez pas encore connecté votre compte GitHub :
|
||||
- Cliquez sur `Se connecter à GitHub`
|
||||
- Examinez et acceptez les conditions d'utilisation
|
||||
- Autorisez l'application OpenHands AI
|
||||
|
||||
## Ajout d'Accès au Dépôt
|
||||
|
||||
Vous pouvez accorder à OpenHands l'accès à des dépôts spécifiques :
|
||||
|
||||
1. Cliquez sur le menu déroulant `Sélectionner un projet GitHub`, puis sélectionnez `Ajouter plus de dépôts...`
|
||||
2. Sélectionnez votre organisation et choisissez les dépôts spécifiques auxquels vous souhaitez accorder l'accès à OpenHands.
|
||||
- OpenHands demande des jetons à courte durée de vie (expiration de 8 heures) avec ces permissions :
|
||||
- Actions : Lecture et écriture
|
||||
- Administration : Lecture seule
|
||||
- Statuts de commit : Lecture et écriture
|
||||
- Contenus : Lecture et écriture
|
||||
- Problèmes : Lecture et écriture
|
||||
- Métadonnées : Lecture seule
|
||||
- Pull requests : Lecture et écriture
|
||||
- Webhooks : Lecture et écriture
|
||||
- Workflows : Lecture et écriture
|
||||
- L'accès au dépôt pour un utilisateur est accordé en fonction de :
|
||||
- Permission accordée pour le dépôt
|
||||
- Permissions GitHub de l'utilisateur (propriétaire/collaborateur)
|
||||
3. Cliquez sur `Installer & Autoriser`
|
||||
|
||||
## Modification de l'Accès au Dépôt
|
||||
|
||||
Vous pouvez modifier l'accès au dépôt à tout moment :
|
||||
* En utilisant le même workflow `Sélectionner un projet GitHub > Ajouter plus de dépôts`, ou
|
||||
* En visitant la page Paramètres et en sélectionnant `Configurer les Dépôts GitHub` dans la section `Paramètres GitHub`.
|
||||
|
||||
## Utilisation d'OpenHands avec GitHub
|
||||
|
||||
Une fois que vous avez accordé l'accès au dépôt, vous pouvez utiliser OpenHands avec vos dépôts GitHub.
|
||||
|
||||
Pour plus de détails sur l'utilisation d'OpenHands avec les problèmes et les pull requests GitHub, consultez la documentation du [Résolveur de Problèmes Cloud](./cloud-issue-resolver.md).
|
||||
|
||||
## Prochaines Étapes
|
||||
|
||||
- [Accéder à l'Interface Cloud](./cloud-ui.md) pour interagir avec l'interface web
|
||||
- [Utiliser le Résolveur de Problèmes Cloud](./cloud-issue-resolver.md) pour automatiser les corrections de code et obtenir de l'aide
|
||||
- [Utiliser l'API Cloud](./cloud-api.md) pour interagir programmatiquement avec OpenHands
|
||||
@ -0,0 +1,50 @@
|
||||
# Installation GitLab
|
||||
|
||||
Ce guide vous accompagne dans le processus d'installation et de configuration d'OpenHands Cloud pour vos dépôts GitLab.
|
||||
|
||||
## Prérequis
|
||||
|
||||
- Un compte GitLab
|
||||
- Accès à OpenHands Cloud
|
||||
|
||||
## Étapes d'Installation
|
||||
|
||||
1. Connectez-vous à [OpenHands Cloud](https://app.all-hands.dev)
|
||||
2. Si vous n'avez pas encore connecté votre compte GitLab :
|
||||
- Cliquez sur `Se connecter à GitLab`
|
||||
- Examinez et acceptez les conditions d'utilisation
|
||||
- Autorisez l'application OpenHands AI
|
||||
|
||||
## Ajout d'Accès au Dépôt
|
||||
|
||||
Vous pouvez accorder à OpenHands l'accès à des dépôts spécifiques :
|
||||
|
||||
1. Cliquez sur le menu déroulant `Sélectionner un projet GitLab`, puis sélectionnez `Ajouter plus de dépôts...`
|
||||
2. Sélectionnez votre organisation et choisissez les dépôts spécifiques auxquels vous souhaitez accorder l'accès à OpenHands.
|
||||
- OpenHands demande des permissions avec ces portées :
|
||||
- api : Accès complet à l'API
|
||||
- read_user : Lecture des informations utilisateur
|
||||
- read_repository : Lecture des informations du dépôt
|
||||
- write_repository : Écriture dans le dépôt
|
||||
- L'accès au dépôt pour un utilisateur est accordé en fonction de :
|
||||
- Permission accordée pour le dépôt
|
||||
- Permissions GitLab de l'utilisateur (propriétaire/mainteneur/développeur)
|
||||
3. Cliquez sur `Installer & Autoriser`
|
||||
|
||||
## Modification de l'Accès au Dépôt
|
||||
|
||||
Vous pouvez modifier l'accès au dépôt à tout moment :
|
||||
* En utilisant le même workflow `Sélectionner un projet GitLab > Ajouter plus de dépôts`, ou
|
||||
* En visitant la page Paramètres et en sélectionnant `Configurer les Dépôts GitLab` dans la section `Paramètres GitLab`.
|
||||
|
||||
## Utilisation d'OpenHands avec GitLab
|
||||
|
||||
Une fois que vous avez accordé l'accès au dépôt, vous pouvez utiliser OpenHands avec vos dépôts GitLab.
|
||||
|
||||
Pour plus de détails sur l'utilisation d'OpenHands avec les problèmes et les merge requests GitLab, consultez la documentation du [Résolveur de Problèmes Cloud](./cloud-issue-resolver.md).
|
||||
|
||||
## Prochaines Étapes
|
||||
|
||||
- [Accéder à l'Interface Cloud](./cloud-ui.md) pour interagir avec l'interface web
|
||||
- [Utiliser le Résolveur de Problèmes Cloud](./cloud-issue-resolver.md) pour automatiser les corrections de code et obtenir de l'aide
|
||||
- [Utiliser l'API Cloud](./cloud-api.md) pour interagir programmatiquement avec OpenHands
|
||||
@ -0,0 +1,24 @@
|
||||
# OpenHands Cloud
|
||||
|
||||
OpenHands Cloud est la version hébergée dans le cloud d'OpenHands par All Hands AI.
|
||||
|
||||
## Accès à OpenHands Cloud
|
||||
|
||||
Pour commencer avec OpenHands Cloud, visitez [app.all-hands.dev](https://app.all-hands.dev).
|
||||
|
||||
Vous serez invité à vous connecter avec votre compte GitHub ou GitLab :
|
||||
|
||||
1. Après avoir lu et accepté les conditions d'utilisation, cliquez sur `Se connecter à GitHub` ou `Se connecter à GitLab`.
|
||||
2. Examinez les permissions demandées par OpenHands et autorisez l'application.
|
||||
- OpenHands nécessitera certaines permissions de votre compte. Pour en savoir plus sur ces permissions,
|
||||
vous pouvez cliquer sur le lien `En savoir plus` sur la page d'autorisation.
|
||||
|
||||
## Prochaines Étapes
|
||||
|
||||
Une fois que vous avez connecté votre compte, vous pouvez :
|
||||
|
||||
- [Installer l'Intégration GitHub](./github-installation.md) pour utiliser OpenHands avec vos dépôts GitHub
|
||||
- [Installer l'Intégration GitLab](./gitlab-installation.md) pour utiliser OpenHands avec vos dépôts GitLab
|
||||
- [Accéder à l'Interface Cloud](./cloud-ui.md) pour interagir avec l'interface web
|
||||
- [Utiliser l'API Cloud](./cloud-api.md) pour interagir programmatiquement avec OpenHands
|
||||
- [Configurer le Résolveur de Problèmes Cloud](./cloud-issue-resolver.md) pour automatiser les corrections de code et fournir une assistance intelligente
|
||||
@ -1,65 +0,0 @@
|
||||
# OpenHands Cloud
|
||||
|
||||
OpenHands Cloud est la version hébergée dans le cloud d'OpenHands par All Hands AI.
|
||||
|
||||
## Accéder à OpenHands Cloud
|
||||
|
||||
OpenHands Cloud est accessible à l'adresse https://app.all-hands.dev/.
|
||||
|
||||
Vous pouvez également interagir avec OpenHands Cloud par programmation en utilisant l'[API](./cloud-api).
|
||||
|
||||
## Premiers pas
|
||||
|
||||
Après avoir visité OpenHands Cloud, il vous sera demandé de vous connecter avec votre compte GitHub ou GitLab :
|
||||
|
||||
1. Après avoir lu et accepté les conditions d'utilisation, cliquez sur `Log in with GitHub` ou `Log in with GitLab`.
|
||||
2. Examinez les autorisations demandées par OpenHands, puis cliquez sur `Authorize OpenHands AI`.
|
||||
- OpenHands nécessitera certaines autorisations de votre compte GitHub ou GitLab. Pour en savoir plus sur ces autorisations :
|
||||
- GitHub : Vous pouvez cliquer sur le lien `Learn more` sur la page d'autorisation GitHub.
|
||||
- GitLab : Vous pouvez développer chaque demande d'autorisation sur la page d'autorisation GitLab.
|
||||
|
||||
## Accès aux dépôts
|
||||
|
||||
### GitHub
|
||||
|
||||
#### Ajouter l'accès aux dépôts
|
||||
|
||||
Vous pouvez accorder à OpenHands un accès à des dépôts spécifiques :
|
||||
1. Cliquez sur `Add GitHub repos` sur la page d'accueil.
|
||||
2. Sélectionnez l'organisation, puis choisissez les dépôts spécifiques auxquels vous souhaitez donner accès à OpenHands.
|
||||
<details>
|
||||
<summary>Détails des autorisations pour l'accès aux dépôts</summary>
|
||||
|
||||
Openhands demande des jetons à courte durée de vie (expiration de 8 heures) avec ces autorisations :
|
||||
- Actions : Lecture et écriture
|
||||
- Administration : Lecture seule
|
||||
- Statuts de commit : Lecture et écriture
|
||||
- Contenus : Lecture et écriture
|
||||
- Issues : Lecture et écriture
|
||||
- Métadonnées : Lecture seule
|
||||
- Pull requests : Lecture et écriture
|
||||
- Webhooks : Lecture et écriture
|
||||
- Workflows : Lecture et écriture
|
||||
|
||||
L'accès au dépôt pour un utilisateur est accordé en fonction de :
|
||||
- L'autorisation accordée pour le dépôt.
|
||||
- Les autorisations GitHub de l'utilisateur (propriétaire/collaborateur).
|
||||
</details>
|
||||
|
||||
3. Cliquez sur `Install & Authorize`.
|
||||
|
||||
#### Modifier l'accès aux dépôts
|
||||
|
||||
Vous pouvez modifier l'accès aux dépôts GitHub à tout moment en :
|
||||
* Utilisant le même processus `Add GitHub repos`, ou
|
||||
* Visitant la page Paramètres et en sélectionnant `Configure GitHub Repositories` dans la section `Git Settings`.
|
||||
|
||||
### GitLab
|
||||
|
||||
Lorsque vous utilisez votre compte GitLab, OpenHands aura automatiquement accès à vos dépôts.
|
||||
|
||||
## Persistance des conversations
|
||||
|
||||
- Liste des conversations – Affiche uniquement les 10 conversations les plus récentes initiées au cours des 10 derniers jours.
|
||||
- Espaces de travail – Les espaces de travail de conversation sont conservés pendant 14 jours.
|
||||
- Environnements d'exécution – Les environnements d'exécution restent actifs ("chauds") pendant 30 minutes. Après cette période, la reprise d'une conversation peut prendre 1 à 2 minutes.
|
||||
@ -1,8 +1,8 @@
|
||||
# Aperçu des fonctionnalités d'OpenHands
|
||||
# Aperçu des Fonctionnalités d'OpenHands
|
||||
|
||||
|
||||
|
||||
### Panneau de discussion
|
||||
### Panneau de Discussion
|
||||
- Affiche la conversation entre l'utilisateur et OpenHands.
|
||||
- OpenHands explique ses actions dans ce panneau.
|
||||
|
||||
@ -10,8 +10,8 @@
|
||||
- Montre les modifications de fichiers effectuées par OpenHands.
|
||||
|
||||
### VS Code
|
||||
- VS Code intégré pour parcourir et modifier des fichiers.
|
||||
- Peut également être utilisé pour télécharger et importer des fichiers.
|
||||
- VS Code intégré pour parcourir et modifier les fichiers.
|
||||
- Peut également être utilisé pour télécharger et envoyer des fichiers.
|
||||
|
||||
### Terminal
|
||||
- Un espace permettant à OpenHands et aux utilisateurs d'exécuter des commandes terminal.
|
||||
@ -25,5 +25,5 @@
|
||||
- Les utilisateurs peuvent interagir avec l'application en cours d'exécution.
|
||||
|
||||
### Navigateur
|
||||
- Utilisé par OpenHands pour naviguer sur des sites web.
|
||||
- Utilisé par OpenHands pour naviguer sur les sites web.
|
||||
- Le navigateur n'est pas interactif.
|
||||
|
||||
@ -1,31 +0,0 @@
|
||||
# Cloud GitHub Resolver
|
||||
|
||||
GitHub Resolverはコードの修正を自動化し、リポジトリに対してインテリジェントな支援を提供します。
|
||||
|
||||
## セットアップ
|
||||
|
||||
Cloud GitHub Resolverは、[OpenHands Cloudにリポジトリアクセス権を付与する](./openhands-cloud#adding-repository-access)と自動的に利用可能になります。
|
||||
|
||||
## 使用方法
|
||||
|
||||
OpenHands Cloudにリポジトリアクセス権を付与した後、リポジトリの課題（Issue）とプルリクエストでCloud GitHub Resolverを使用できます。
|
||||
|
||||
### 課題（Issues）
|
||||
|
||||
リポジトリで課題に`openhands`ラベルを付けると、OpenHandsは以下の操作を行います：
|
||||
1. 課題にコメントして、作業中であることを通知します。
|
||||
- OpenHands Cloudで進捗状況を追跡するためのリンクをクリックできます。
|
||||
2. 課題が正常に解決されたと判断した場合、プルリクエストを開きます。
|
||||
3. 実行されたタスクの概要とプルリクエストへのリンクを含むコメントを課題に投稿します。
|
||||
|
||||
|
||||
### プルリクエスト
|
||||
|
||||
プルリクエストでOpenHandsを利用するには、トップレベルまたはインラインコメントで`@openhands`を使用して：
|
||||
- 質問する
|
||||
- 更新をリクエストする
|
||||
- コードの説明を取得する
|
||||
|
||||
OpenHandsは以下の操作を行います：
|
||||
1. PRにコメントして、作業中であることを通知します。
|
||||
2. タスクを実行します。
|
||||
@ -0,0 +1,32 @@
|
||||
# クラウド課題リゾルバー
|
||||
|
||||
クラウド課題リゾルバーは、GitHubとGitLabのリポジトリに対してコード修正を自動化し、インテリジェントな支援を提供します。
|
||||
|
||||
## セットアップ
|
||||
|
||||
クラウド課題リゾルバーは、OpenHands Cloudリポジトリアクセスを許可すると自動的に利用可能になります：
|
||||
- [GitHubリポジトリアクセス](./github-installation#adding-repository-access)
|
||||
- [GitLabリポジトリアクセス](./gitlab-installation#adding-repository-access)
|
||||
|
||||
## 使用方法
|
||||
|
||||
OpenHands Cloudリポジトリアクセスを許可した後、リポジトリの課題やプルリクエスト/マージリクエストでクラウド課題リゾルバーを使用できます。
|
||||
|
||||
### 課題の操作
|
||||
|
||||
リポジトリで、課題に`openhands`というラベルを付けます。OpenHandsは以下を行います：
|
||||
1. 課題にコメントして、作業中であることを知らせます
|
||||
- リンクをクリックすると、OpenHands Cloudで進捗状況を追跡できます
|
||||
2. 課題が正常に解決されたと判断した場合、プルリクエスト（GitHub）またはマージリクエスト（GitLab）を開きます
|
||||
3. 実行されたタスクの概要とPR/MRへのリンクを含むコメントを課題に残します
|
||||
|
||||
### プルリクエスト/マージリクエストの操作
|
||||
|
||||
プルリクエスト（GitHub）またはマージリクエスト（GitLab）でOpenHandsを動作させるには、コメントで`@openhands`を言及して以下を行います：
|
||||
- 質問する
|
||||
- 更新をリクエストする
|
||||
- コードの説明を取得する
|
||||
|
||||
OpenHandsは以下を行います：
|
||||
1. 作業中であることを知らせるコメントをします
|
||||
2. リクエストされたタスクを実行します
|
||||
@ -0,0 +1,29 @@
|
||||
# クラウドUI
|
||||
|
||||
クラウドUIは、OpenHands AIと対話するためのウェブインターフェースを提供します。このページでは、OpenHands クラウドUIへのアクセス方法と使用方法について説明します。
|
||||
|
||||
## UIへのアクセス
|
||||
|
||||
OpenHands クラウドUIは[app.all-hands.dev](https://app.all-hands.dev)でアクセスできます。インターフェースにアクセスするには、GitHubまたはGitLabアカウントでサインインする必要があります。
|
||||
|
||||
<!-- 画像は将来のアップデートで追加されます -->
|
||||
<!--  -->
|
||||
|
||||
## 主な機能
|
||||
|
||||
OpenHands クラウドUIで利用可能な機能の詳細については、ドキュメントの[主な機能](../key-features.md)セクションを参照してください。
|
||||
|
||||
## 設定
|
||||
|
||||
設定ページでは以下のことができます：
|
||||
|
||||
1. アカウント設定の構成
|
||||
2. リポジトリアクセスの管理
|
||||
3. プログラムによるアクセスのためのAPIキーの生成
|
||||
4. OpenHandsエクスペリエンスのカスタマイズ
|
||||
|
||||
## 次のステップ
|
||||
|
||||
- [クラウド課題リゾルバーを使用する](./cloud-issue-resolver.md)でコード修正を自動化し、支援を受ける
|
||||
- [クラウドAPIについて学ぶ](./cloud-api.md)でプログラムによるアクセスを行う
|
||||
- [はじめにに戻る](./openhands-cloud.md)
|
||||
@ -0,0 +1,55 @@
|
||||
# GitHub インストール
|
||||
|
||||
このガイドでは、GitHubリポジトリ用にOpenHands Cloudをインストールおよび設定するプロセスについて説明します。
|
||||
|
||||
## 前提条件
|
||||
|
||||
- GitHubアカウント
|
||||
- OpenHands Cloudへのアクセス
|
||||
|
||||
## インストール手順
|
||||
|
||||
1. [OpenHands Cloud](https://app.all-hands.dev)にログインします
|
||||
2. まだGitHubアカウントを接続していない場合：
|
||||
- `GitHubに接続する`をクリックします
|
||||
- 利用規約を確認して同意します
|
||||
- OpenHands AIアプリケーションを承認します
|
||||
|
||||
## リポジトリアクセスの追加
|
||||
|
||||
特定のリポジトリへのアクセスをOpenHandsに許可できます：
|
||||
|
||||
1. `GitHubプロジェクトを選択`ドロップダウンをクリックし、`リポジトリを追加...`を選択します
|
||||
2. 組織を選択し、OpenHandsにアクセスを許可する特定のリポジトリを選択します。
|
||||
- OpenHandsは以下の権限を持つ短期間のトークン（8時間の有効期限）をリクエストします：
|
||||
- アクション：読み取りと書き込み
|
||||
- 管理：読み取り専用
|
||||
- コミットステータス：読み取りと書き込み
|
||||
- コンテンツ：読み取りと書き込み
|
||||
- 課題：読み取りと書き込み
|
||||
- メタデータ：読み取り専用
|
||||
- プルリクエスト：読み取りと書き込み
|
||||
- Webhook：読み取りと書き込み
|
||||
- ワークフロー：読み取りと書き込み
|
||||
- ユーザーのリポジトリアクセスは以下に基づいて付与されます：
|
||||
- リポジトリに付与された権限
|
||||
- ユーザーのGitHub権限（所有者/コラボレーター）
|
||||
3. `インストール＆承認`をクリックします
|
||||
|
||||
## リポジトリアクセスの変更
|
||||
|
||||
リポジトリアクセスはいつでも変更できます：
|
||||
* 同じ`GitHubプロジェクトを選択 > リポジトリを追加`ワークフローを使用する、または
|
||||
* 設定ページにアクセスし、`GitHub設定`セクションで`GitHubリポジトリを設定する`を選択します。
|
||||
|
||||
## GitHubでのOpenHandsの使用
|
||||
|
||||
リポジトリアクセスを許可すると、GitHubリポジトリでOpenHandsを使用できます。
|
||||
|
||||
GitHub課題とプルリクエストでOpenHandsを使用する方法の詳細については、[クラウド課題リゾルバー](./cloud-issue-resolver.md)のドキュメントを参照してください。
|
||||
|
||||
## 次のステップ
|
||||
|
||||
- [クラウドUIにアクセスする](./cloud-ui.md)でウェブインターフェースと対話する
|
||||
- [クラウド課題リゾルバーを使用する](./cloud-issue-resolver.md)でコード修正を自動化し、支援を受ける
|
||||
- [クラウドAPIを使用する](./cloud-api.md)でプログラムによりOpenHandsと対話する
|
||||
@ -0,0 +1,50 @@
|
||||
# GitLab インストール
|
||||
|
||||
このガイドでは、GitLabリポジトリ用にOpenHands Cloudをインストールおよび設定するプロセスについて説明します。
|
||||
|
||||
## 前提条件
|
||||
|
||||
- GitLabアカウント
|
||||
- OpenHands Cloudへのアクセス
|
||||
|
||||
## インストール手順
|
||||
|
||||
1. [OpenHands Cloud](https://app.all-hands.dev)にログインします
|
||||
2. まだGitLabアカウントを接続していない場合：
|
||||
- `GitLabに接続する`をクリックします
|
||||
- 利用規約を確認して同意します
|
||||
- OpenHands AIアプリケーションを承認します
|
||||
|
||||
## リポジトリアクセスの追加
|
||||
|
||||
特定のリポジトリへのアクセスをOpenHandsに許可できます：
|
||||
|
||||
1. `GitLabプロジェクトを選択`ドロップダウンをクリックし、`リポジトリを追加...`を選択します
|
||||
2. 組織を選択し、OpenHandsにアクセスを許可する特定のリポジトリを選択します。
|
||||
- OpenHandsは以下のスコープで権限をリクエストします：
|
||||
- api：完全なAPIアクセス
|
||||
- read_user：ユーザー情報の読み取り
|
||||
- read_repository：リポジトリ情報の読み取り
|
||||
- write_repository：リポジトリへの書き込み
|
||||
- ユーザーのリポジトリアクセスは以下に基づいて付与されます：
|
||||
- リポジトリに付与された権限
|
||||
- ユーザーのGitLab権限（所有者/メンテナー/開発者）
|
||||
3. `インストール＆承認`をクリックします
|
||||
|
||||
## リポジトリアクセスの変更
|
||||
|
||||
リポジトリアクセスはいつでも変更できます：
|
||||
* 同じ`GitLabプロジェクトを選択 > リポジトリを追加`ワークフローを使用する、または
|
||||
* 設定ページにアクセスし、`GitLab設定`セクションで`GitLabリポジトリを設定する`を選択します。
|
||||
|
||||
## GitLabでのOpenHandsの使用
|
||||
|
||||
リポジトリアクセスを許可すると、GitLabリポジトリでOpenHandsを使用できます。
|
||||
|
||||
GitLab課題とマージリクエストでOpenHandsを使用する方法の詳細については、[クラウド課題リゾルバー](./cloud-issue-resolver.md)のドキュメントを参照してください。
|
||||
|
||||
## 次のステップ
|
||||
|
||||
- [クラウドUIにアクセスする](./cloud-ui.md)でウェブインターフェースと対話する
|
||||
- [クラウド課題リゾルバーを使用する](./cloud-issue-resolver.md)でコード修正を自動化し、支援を受ける
|
||||
- [クラウドAPIを使用する](./cloud-api.md)でプログラムによりOpenHandsと対話する
|
||||
@ -0,0 +1,24 @@
|
||||
# OpenHands クラウド
|
||||
|
||||
OpenHands クラウドは、All Hands AIのOpenHandsのホスト型クラウドバージョンです。
|
||||
|
||||
## OpenHands クラウドへのアクセス
|
||||
|
||||
OpenHands クラウドを始めるには、[app.all-hands.dev](https://app.all-hands.dev)にアクセスしてください。
|
||||
|
||||
GitHubまたはGitLabアカウントで接続するよう求められます：
|
||||
|
||||
1. 利用規約を読んで同意した後、`GitHubに接続する`または`GitLabに接続する`をクリックします。
|
||||
2. OpenHandsがリクエストする権限を確認し、アプリケーションを承認します。
|
||||
- OpenHandsはあなたのアカウントから特定の権限を必要とします。これらの権限について詳しく知るには、
|
||||
承認ページの`詳細を見る`リンクをクリックしてください。
|
||||
|
||||
## 次のステップ
|
||||
|
||||
アカウントを接続したら、以下のことができます：
|
||||
|
||||
- [GitHub統合をインストールする](./github-installation.md)でGitHubリポジトリでOpenHandsを使用する
|
||||
- [GitLab統合をインストールする](./gitlab-installation.md)でGitLabリポジトリでOpenHandsを使用する
|
||||
- [クラウドUIにアクセスする](./cloud-ui.md)でウェブインターフェースと対話する
|
||||
- [クラウドAPIを使用する](./cloud-api.md)でプログラムによりOpenHandsと対話する
|
||||
- [クラウド課題リゾルバーを設定する](./cloud-issue-resolver.md)でコード修正を自動化し、インテリジェントな支援を提供する
|
||||
@ -1,65 +0,0 @@
|
||||
# OpenHands Cloud
|
||||
|
||||
OpenHands CloudはAll Hands AIによるOpenHandsのクラウドホスト版です。
|
||||
|
||||
## OpenHands Cloudへのアクセス
|
||||
|
||||
OpenHands Cloudは https://app.all-hands.dev/ でアクセスできます。
|
||||
|
||||
[API](./cloud-api)を使用してプログラム的にOpenHands Cloudと対話することもできます。
|
||||
|
||||
## はじめに
|
||||
|
||||
OpenHands Cloudにアクセスすると、GitHubまたはGitLabアカウントとの接続を求められます：
|
||||
|
||||
1. 利用規約を読んで同意した後、`Log in with GitHub`または`Log in with GitLab`をクリックします。
|
||||
2. OpenHandsが要求する権限を確認し、`Authorize OpenHands AI`をクリックします。
|
||||
- OpenHandsはGitHubまたはGitLabアカウントからいくつかの権限を必要とします。これらの権限について詳しく知るには：
|
||||
- GitHub：GitHub認証ページの`Learn more`リンクをクリックできます。
|
||||
- GitLab：GitLab認証ページで各権限リクエストを展開できます。
|
||||
|
||||
## リポジトリアクセス
|
||||
|
||||
### GitHub
|
||||
|
||||
#### リポジトリアクセスの追加
|
||||
|
||||
OpenHandsに特定のリポジトリへのアクセス権を付与できます：
|
||||
1. ホームページで`Add GitHub repos`をクリックします。
|
||||
2. 組織を選択し、OpenHandsにアクセス権を付与する特定のリポジトリを選択します。
|
||||
<details>
|
||||
<summary>リポジトリアクセスの権限詳細</summary>
|
||||
|
||||
Openhandsは短期間のトークン（8時間で期限切れ）を以下の権限で要求します：
|
||||
- Actions：読み取りと書き込み
|
||||
- Administration：読み取り専用
|
||||
- Commit statuses：読み取りと書き込み
|
||||
- Contents：読み取りと書き込み
|
||||
- Issues：読み取りと書き込み
|
||||
- Metadata：読み取り専用
|
||||
- Pull requests：読み取りと書き込み
|
||||
- Webhooks：読み取りと書き込み
|
||||
- Workflows：読み取りと書き込み
|
||||
|
||||
ユーザーのリポジトリアクセスは以下に基づいて付与されます：
|
||||
- リポジトリに対して付与された権限
|
||||
- ユーザーのGitHub権限（オーナー/コラボレーター）
|
||||
</details>
|
||||
|
||||
3. `Install & Authorize`をクリックします。
|
||||
|
||||
#### リポジトリアクセスの変更
|
||||
|
||||
GitHubリポジトリアクセスはいつでも以下の方法で変更できます：
|
||||
* 同じ`Add GitHub repos`ワークフローを使用する、または
|
||||
* 設定ページにアクセスし、`Git Settings`セクションの下にある`Configure GitHub Repositories`を選択する。
|
||||
|
||||
### GitLab
|
||||
|
||||
GitLabアカウントを使用する場合、OpenHandsは自動的にあなたのリポジトリにアクセスできるようになります。
|
||||
|
||||
## 会話の保持
|
||||
|
||||
- 会話リスト – 過去10日間に開始された最新10件の会話のみが表示されます。
|
||||
- ワークスペース – 会話ワークスペースは14日間保持されます。
|
||||
- ランタイム – ランタイムは30分間アクティブ（「ウォーム」）な状態を維持します。この期間後、会話を再開するには1〜2分かかる場合があります。
|
||||
@ -3,11 +3,11 @@
|
||||
|
||||
|
||||
### チャットパネル
|
||||
- ユーザーとOpenHandsの会話を表示します。
|
||||
- ユーザーとOpenHands間の会話を表示します。
|
||||
- OpenHandsはこのパネルで自身の行動を説明します。
|
||||
|
||||
### 変更点
|
||||
- OpenHandsによって実行されたファイルの変更を表示します。
|
||||
### 変更
|
||||
- OpenHandsによって実行されたファイル変更を表示します。
|
||||
|
||||
### VS Code
|
||||
- ファイルの閲覧や修正のための組み込みVS Code。
|
||||
@ -18,7 +18,7 @@
|
||||
|
||||
### Jupyter
|
||||
- OpenHandsによって実行されたすべてのPythonコマンドを表示します。
|
||||
- OpenHandsを使用してデータ可視化タスクを実行する際に特に便利です。
|
||||
- データ可視化タスクにOpenHandsを使用する際に特に便利です。
|
||||
|
||||
### アプリ
|
||||
- OpenHandsがアプリケーションを実行する際にウェブサーバーを表示します。
|
||||
@ -26,4 +26,4 @@
|
||||
|
||||
### ブラウザ
|
||||
- OpenHandsがウェブサイトを閲覧するために使用します。
|
||||
- このブラウザは非対話型です。
|
||||
- ブラウザは非対話式です。
|
||||
|
||||
@ -1,33 +0,0 @@
|
||||
# Resolvedor GitHub na Nuvem
|
||||
|
||||
O Resolvedor GitHub automatiza correções de código e fornece assistência inteligente para seus repositórios.
|
||||
|
||||
## Configuração
|
||||
|
||||
O Resolvedor GitHub na Nuvem está disponível automaticamente quando você
|
||||
[concede acesso de repositório ao OpenHands Cloud](./openhands-cloud#adding-repository-access).
|
||||
|
||||
## Uso
|
||||
|
||||
Após conceder acesso de repositório ao OpenHands Cloud, você pode usar o Resolvedor GitHub na Nuvem nos problemas e pull requests
|
||||
do repositório.
|
||||
|
||||
### Problemas (Issues)
|
||||
|
||||
No seu repositório, rotule um problema com `openhands`. O OpenHands irá:
|
||||
1. Comentar no problema para informar que está trabalhando nele.
|
||||
- Você pode clicar no link para acompanhar o progresso no OpenHands Cloud.
|
||||
2. Abrir um pull request se determinar que o problema foi resolvido com sucesso.
|
||||
3. Comentar no problema com um resumo das tarefas realizadas e um link para o pull request.
|
||||
|
||||
|
||||
### Pull Requests
|
||||
|
||||
Para fazer o OpenHands trabalhar em pull requests, use `@openhands` em comentários de nível superior ou em linha para:
|
||||
- Fazer perguntas
|
||||
- Solicitar atualizações
|
||||
- Obter explicações de código
|
||||
|
||||
O OpenHands irá:
|
||||
1. Comentar no PR para informar que está trabalhando nele.
|
||||
2. Realizar a tarefa.
|
||||
@ -0,0 +1,32 @@
|
||||
# Resolvedor de Problemas na Nuvem
|
||||
|
||||
O Resolvedor de Problemas na Nuvem automatiza correções de código e fornece assistência inteligente para seus repositórios no GitHub e GitLab.
|
||||
|
||||
## Configuração
|
||||
|
||||
O Resolvedor de Problemas na Nuvem está disponível automaticamente quando você concede acesso ao repositório OpenHands Cloud:
|
||||
- [Acesso ao repositório GitHub](./github-installation#adding-repository-access)
|
||||
- [Acesso ao repositório GitLab](./gitlab-installation#adding-repository-access)
|
||||
|
||||
## Uso
|
||||
|
||||
Após conceder acesso ao repositório OpenHands Cloud, você pode usar o Resolvedor de Problemas na Nuvem em issues e pull/merge requests em seus repositórios.
|
||||
|
||||
### Trabalhando com Issues
|
||||
|
||||
No seu repositório, rotule uma issue com `openhands`. O OpenHands irá:
|
||||
1. Comentar na issue para informar que está trabalhando nela
|
||||
- Você pode clicar no link para acompanhar o progresso no OpenHands Cloud
|
||||
2. Abrir um pull request (GitHub) ou merge request (GitLab) se determinar que o problema foi resolvido com sucesso
|
||||
3. Comentar na issue com um resumo das tarefas realizadas e um link para o PR/MR
|
||||
|
||||
### Trabalhando com Pull/Merge Requests
|
||||
|
||||
Para fazer o OpenHands trabalhar em pull requests (GitHub) ou merge requests (GitLab), mencione `@openhands` nos comentários para:
|
||||
- Fazer perguntas
|
||||
- Solicitar atualizações
|
||||
- Obter explicações de código
|
||||
|
||||
O OpenHands irá:
|
||||
1. Comentar para informar que está trabalhando nisso
|
||||
2. Realizar a tarefa solicitada
|
||||
@ -0,0 +1,29 @@
|
||||
# Interface da Nuvem
|
||||
|
||||
A Interface da Nuvem fornece uma interface web para interagir com o OpenHands AI. Esta página explica como acessar e usar a Interface da Nuvem do OpenHands.
|
||||
|
||||
## Acessando a Interface
|
||||
|
||||
A Interface da Nuvem do OpenHands pode ser acessada em [app.all-hands.dev](https://app.all-hands.dev). Você precisará fazer login com sua conta do GitHub ou GitLab para acessar a interface.
|
||||
|
||||
<!-- A imagem será adicionada em uma atualização futura -->
|
||||
<!--  -->
|
||||
|
||||
## Recursos Principais
|
||||
|
||||
Para informações detalhadas sobre os recursos disponíveis na Interface da Nuvem do OpenHands, consulte a seção [Recursos Principais](../key-features.md) da documentação.
|
||||
|
||||
## Configurações
|
||||
|
||||
A página de configurações permite que você:
|
||||
|
||||
1. Configure as preferências da sua conta
|
||||
2. Gerencie o acesso ao repositório
|
||||
3. Gere chaves de API para acesso programático
|
||||
4. Personalize sua experiência com o OpenHands
|
||||
|
||||
## Próximos Passos
|
||||
|
||||
- [Use o Resolvedor de Problemas na Nuvem](./cloud-issue-resolver.md) para automatizar correções de código e obter assistência
|
||||
- [Aprenda sobre a API da Nuvem](./cloud-api.md) para acesso programático
|
||||
- [Voltar para Introdução](./openhands-cloud.md)
|
||||
@ -0,0 +1,55 @@
|
||||
# Instalação do GitHub
|
||||
|
||||
Este guia orienta você pelo processo de instalação e configuração do OpenHands Cloud para seus repositórios GitHub.
|
||||
|
||||
## Pré-requisitos
|
||||
|
||||
- Uma conta GitHub
|
||||
- Acesso ao OpenHands Cloud
|
||||
|
||||
## Passos de Instalação
|
||||
|
||||
1. Faça login no [OpenHands Cloud](https://app.all-hands.dev)
|
||||
2. Se você ainda não conectou sua conta GitHub:
|
||||
- Clique em `Conectar ao GitHub`
|
||||
- Revise e aceite os termos de serviço
|
||||
- Autorize a aplicação OpenHands AI
|
||||
|
||||
## Adicionando Acesso ao Repositório
|
||||
|
||||
Você pode conceder ao OpenHands acesso a repositórios específicos:
|
||||
|
||||
1. Clique no menu suspenso `Selecionar um projeto GitHub`, depois selecione `Adicionar mais repositórios...`
|
||||
2. Selecione sua organização e escolha os repositórios específicos para conceder acesso ao OpenHands.
|
||||
- OpenHands solicita tokens de curta duração (expiração de 8 horas) com estas permissões:
|
||||
- Ações: Leitura e escrita
|
||||
- Administração: Somente leitura
|
||||
- Status de commit: Leitura e escrita
|
||||
- Conteúdos: Leitura e escrita
|
||||
- Issues: Leitura e escrita
|
||||
- Metadados: Somente leitura
|
||||
- Pull requests: Leitura e escrita
|
||||
- Webhooks: Leitura e escrita
|
||||
- Workflows: Leitura e escrita
|
||||
- O acesso ao repositório para um usuário é concedido com base em:
|
||||
- Permissão concedida para o repositório
|
||||
- Permissões do GitHub do usuário (proprietário/colaborador)
|
||||
3. Clique em `Instalar e Autorizar`
|
||||
|
||||
## Modificando o Acesso ao Repositório
|
||||
|
||||
Você pode modificar o acesso ao repositório a qualquer momento:
|
||||
* Usando o mesmo fluxo de trabalho `Selecionar um projeto GitHub > Adicionar mais repositórios`, ou
|
||||
* Visitando a página de Configurações e selecionando `Configurar Repositórios GitHub` na seção `Configurações do GitHub`.
|
||||
|
||||
## Usando OpenHands com GitHub
|
||||
|
||||
Depois de conceder acesso ao repositório, você pode usar o OpenHands com seus repositórios GitHub.
|
||||
|
||||
Para detalhes sobre como usar o OpenHands com issues e pull requests do GitHub, consulte a documentação do [Resolvedor de Problemas na Nuvem](./cloud-issue-resolver.md).
|
||||
|
||||
## Próximos Passos
|
||||
|
||||
- [Acesse a Interface da Nuvem](./cloud-ui.md) para interagir com a interface web
|
||||
- [Use o Resolvedor de Problemas na Nuvem](./cloud-issue-resolver.md) para automatizar correções de código e obter assistência
|
||||
- [Use a API da Nuvem](./cloud-api.md) para interagir programaticamente com o OpenHands
|
||||
@ -0,0 +1,50 @@
|
||||
# Instalação do GitLab
|
||||
|
||||
Este guia orienta você pelo processo de instalação e configuração do OpenHands Cloud para seus repositórios GitLab.
|
||||
|
||||
## Pré-requisitos
|
||||
|
||||
- Uma conta GitLab
|
||||
- Acesso ao OpenHands Cloud
|
||||
|
||||
## Passos de Instalação
|
||||
|
||||
1. Faça login no [OpenHands Cloud](https://app.all-hands.dev)
|
||||
2. Se você ainda não conectou sua conta GitLab:
|
||||
- Clique em `Conectar ao GitLab`
|
||||
- Revise e aceite os termos de serviço
|
||||
- Autorize a aplicação OpenHands AI
|
||||
|
||||
## Adicionando Acesso ao Repositório
|
||||
|
||||
Você pode conceder ao OpenHands acesso a repositórios específicos:
|
||||
|
||||
1. Clique no menu suspenso `Selecionar um projeto GitLab`, depois selecione `Adicionar mais repositórios...`
|
||||
2. Selecione sua organização e escolha os repositórios específicos para conceder acesso ao OpenHands.
|
||||
- OpenHands solicita permissões com estes escopos:
|
||||
- api: Acesso completo à API
|
||||
- read_user: Ler informações do usuário
|
||||
- read_repository: Ler informações do repositório
|
||||
- write_repository: Escrever no repositório
|
||||
- O acesso ao repositório para um usuário é concedido com base em:
|
||||
- Permissão concedida para o repositório
|
||||
- Permissões do GitLab do usuário (proprietário/mantenedor/desenvolvedor)
|
||||
3. Clique em `Instalar e Autorizar`
|
||||
|
||||
## Modificando o Acesso ao Repositório
|
||||
|
||||
Você pode modificar o acesso ao repositório a qualquer momento:
|
||||
* Usando o mesmo fluxo de trabalho `Selecionar um projeto GitLab > Adicionar mais repositórios`, ou
|
||||
* Visitando a página de Configurações e selecionando `Configurar Repositórios GitLab` na seção `Configurações do GitLab`.
|
||||
|
||||
## Usando OpenHands com GitLab
|
||||
|
||||
Depois de conceder acesso ao repositório, você pode usar o OpenHands com seus repositórios GitLab.
|
||||
|
||||
Para detalhes sobre como usar o OpenHands com issues e merge requests do GitLab, consulte a documentação do [Resolvedor de Problemas na Nuvem](./cloud-issue-resolver.md).
|
||||
|
||||
## Próximos Passos
|
||||
|
||||
- [Acesse a Interface da Nuvem](./cloud-ui.md) para interagir com a interface web
|
||||
- [Use o Resolvedor de Problemas na Nuvem](./cloud-issue-resolver.md) para automatizar correções de código e obter assistência
|
||||
- [Use a API da Nuvem](./cloud-api.md) para interagir programaticamente com o OpenHands
|
||||
@ -1,45 +1,24 @@
|
||||
# Openhands Cloud
|
||||
# OpenHands Cloud
|
||||
|
||||
O OpenHands Cloud é a versão hospedada na nuvem do OpenHands da All Hands AI.
|
||||
OpenHands Cloud é a versão hospedada na nuvem do OpenHands da All Hands AI.
|
||||
|
||||
## Acessando o OpenHands Cloud
|
||||
|
||||
Atualmente, os usuários estão sendo admitidos para acessar o OpenHands Cloud em ondas. Para se inscrever,
|
||||
[entre na lista de espera](https://www.all-hands.dev/join-waitlist). Assim que for aprovado, você receberá um e-mail com
|
||||
instruções sobre como acessá-lo.
|
||||
Para começar com o OpenHands Cloud, visite [app.all-hands.dev](https://app.all-hands.dev).
|
||||
|
||||
## Primeiros Passos
|
||||
Você será solicitado a se conectar com sua conta GitHub ou GitLab:
|
||||
|
||||
Após visitar o OpenHands Cloud, você será solicitado a se conectar com sua conta do GitHub:
|
||||
1. Após ler e aceitar os termos de serviço, clique em `Connect to GitHub`.
|
||||
2. Revise as permissões solicitadas pelo OpenHands e clique em `Authorize OpenHands AI`.
|
||||
- O OpenHands exigirá algumas permissões da sua conta do GitHub. Para ler mais sobre essas permissões,
|
||||
você pode clicar no link `Learn more` na página de autorização do GitHub.
|
||||
1. Após ler e aceitar os termos de serviço, clique em `Conectar ao GitHub` ou `Conectar ao GitLab`.
|
||||
2. Revise as permissões solicitadas pelo OpenHands e autorize a aplicação.
|
||||
- OpenHands exigirá certas permissões da sua conta. Para ler mais sobre essas permissões,
|
||||
você pode clicar no link `Saiba mais` na página de autorização.
|
||||
|
||||
## Acesso ao Repositório
|
||||
## Próximos Passos
|
||||
|
||||
### Adicionando Acesso ao Repositório
|
||||
Depois de conectar sua conta, você pode:
|
||||
|
||||
Você pode conceder ao OpenHands acesso específico ao repositório:
|
||||
1. Clique no menu suspenso `Select a GitHub project`, selecione `Add more repositories...`.
|
||||
2. Selecione a organização e escolha os repositórios específicos para conceder acesso ao OpenHands.
|
||||
- O Openhands solicita tokens de curta duração (expiração de 8 horas) com estas permissões:
|
||||
- Actions: Read and write
|
||||
- Administration: Read-only
|
||||
- Commit statuses: Read and write
|
||||
- Contents: Read and write
|
||||
- Issues: Read and write
|
||||
- Metadata: Read-only
|
||||
- Pull requests: Read and write
|
||||
- Webhooks: Read and write
|
||||
- Workflows: Read and write
|
||||
- O acesso ao repositório para um usuário é concedido com base em:
|
||||
- Permissão concedida para o repositório.
|
||||
- Permissões do GitHub do usuário (proprietário/colaborador).
|
||||
3. Clique em `Install & Authorize`.
|
||||
|
||||
### Modificando o Acesso ao Repositório
|
||||
|
||||
Você pode modificar o acesso ao repositório a qualquer momento:
|
||||
* Usando o mesmo fluxo de trabalho `Select a GitHub project > Add more repositories`, ou
|
||||
* Visitando a página de Configurações e selecionando `Configure GitHub Repositories` na seção `GitHub Settings`.
|
||||
- [Instalar a Integração com GitHub](./github-installation.md) para usar o OpenHands com seus repositórios GitHub
|
||||
- [Instalar a Integração com GitLab](./gitlab-installation.md) para usar o OpenHands com seus repositórios GitLab
|
||||
- [Acessar a Interface da Nuvem](./cloud-ui.md) para interagir com a interface web
|
||||
- [Usar a API da Nuvem](./cloud-api.md) para interagir programaticamente com o OpenHands
|
||||
- [Configurar o Resolvedor de Problemas na Nuvem](./cloud-issue-resolver.md) para automatizar correções de código e fornecer assistência inteligente
|
||||
|
||||
@ -1,65 +0,0 @@
|
||||
# Openhands Cloud
|
||||
|
||||
OpenHands Cloud é a versão hospedada na nuvem do OpenHands pela All Hands AI.
|
||||
|
||||
## Acessando o OpenHands Cloud
|
||||
|
||||
O OpenHands Cloud pode ser acessado em https://app.all-hands.dev/.
|
||||
|
||||
Você também pode interagir com o OpenHands Cloud programaticamente usando a [API](./cloud-api).
|
||||
|
||||
## Primeiros Passos
|
||||
|
||||
Ao visitar o OpenHands Cloud, você será solicitado a conectar-se com sua conta GitHub ou GitLab:
|
||||
|
||||
1. Após ler e aceitar os termos de serviço, clique em `Log in with GitHub` ou `Log in with GitLab`.
|
||||
2. Revise as permissões solicitadas pelo OpenHands e então clique em `Authorize OpenHands AI`.
|
||||
- O OpenHands precisará de algumas permissões da sua conta GitHub ou GitLab. Para ler mais sobre essas permissões:
|
||||
- GitHub: Você pode clicar no link `Learn more` na página de autorização do GitHub.
|
||||
- GitLab: Você pode expandir cada solicitação de permissão na página de autorização do GitLab.
|
||||
|
||||
## Acesso ao Repositório
|
||||
|
||||
### GitHub
|
||||
|
||||
#### Adicionando Acesso ao Repositório
|
||||
|
||||
Você pode conceder ao OpenHands acesso específico ao repositório:
|
||||
1. Clique em `Add GitHub repos` na página inicial.
|
||||
2. Selecione a organização e, em seguida, escolha os repositórios específicos para conceder acesso ao OpenHands.
|
||||
<details>
|
||||
<summary>Detalhes de Permissão para Acesso ao Repositório</summary>
|
||||
|
||||
O Openhands solicita tokens de curta duração (expiração de 8 horas) com estas permissões:
|
||||
- Actions: Leitura e escrita
|
||||
- Administration: Somente leitura
|
||||
- Commit statuses: Leitura e escrita
|
||||
- Contents: Leitura e escrita
|
||||
- Issues: Leitura e escrita
|
||||
- Metadata: Somente leitura
|
||||
- Pull requests: Leitura e escrita
|
||||
- Webhooks: Leitura e escrita
|
||||
- Workflows: Leitura e escrita
|
||||
|
||||
O acesso ao repositório para um usuário é concedido com base em:
|
||||
- Permissão concedida para o repositório.
|
||||
- Permissões do GitHub do usuário (proprietário/colaborador).
|
||||
</details>
|
||||
|
||||
3. Clique em `Install & Authorize`.
|
||||
|
||||
#### Modificando o Acesso ao Repositório
|
||||
|
||||
Você pode modificar o acesso ao repositório do GitHub a qualquer momento:
|
||||
* Usando o mesmo fluxo de trabalho `Add GitHub repos`, ou
|
||||
* Visitando a página de Configurações e selecionando `Configure GitHub Repositories` na seção `Git Settings`.
|
||||
|
||||
### GitLab
|
||||
|
||||
Ao usar sua conta GitLab, o OpenHands terá automaticamente acesso aos seus repositórios.
|
||||
|
||||
## Persistência de Conversas
|
||||
|
||||
- Lista de Conversas – Exibe apenas as 10 conversas mais recentes iniciadas nos últimos 10 dias.
|
||||
- Workspaces – Os workspaces de conversas são mantidos por 14 dias.
|
||||
- Runtimes – Os runtimes permanecem ativos ("aquecidos") por 30 minutos. Após esse período, retomar uma conversa pode levar de 1 a 2 minutos.
|
||||
@ -1,4 +1,4 @@
|
||||
# Visão Geral dos Recursos do OpenHands
|
||||
# Visão Geral das Funcionalidades do OpenHands
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
- Exibe a conversa entre o usuário e o OpenHands.
|
||||
- O OpenHands explica suas ações neste painel.
|
||||
|
||||
### Mudanças
|
||||
### Alterações
|
||||
- Mostra as alterações de arquivos realizadas pelo OpenHands.
|
||||
|
||||
### VS Code
|
||||
@ -14,13 +14,13 @@
|
||||
- Também pode ser usado para fazer upload e download de arquivos.
|
||||
|
||||
### Terminal
|
||||
- Um espaço para o OpenHands e os usuários executarem comandos de terminal.
|
||||
- Um espaço para o OpenHands e usuários executarem comandos de terminal.
|
||||
|
||||
### Jupyter
|
||||
- Mostra todos os comandos Python que foram executados pelo OpenHands.
|
||||
- Particularmente útil ao usar o OpenHands para realizar tarefas de visualização de dados.
|
||||
- Particularmente útil ao usar o OpenHands para tarefas de visualização de dados.
|
||||
|
||||
### App
|
||||
### Aplicativo
|
||||
- Exibe o servidor web quando o OpenHands executa uma aplicação.
|
||||
- Os usuários podem interagir com a aplicação em execução.
|
||||
|
||||
|
||||
@ -1,31 +0,0 @@
|
||||
# Cloud GitHub Resolver
|
||||
|
||||
GitHub Resolver 自动修复代码并为您的仓库提供智能辅助。
|
||||
|
||||
## 设置
|
||||
|
||||
当您[授予 OpenHands Cloud 仓库访问权限](./openhands-cloud#adding-repository-access)后，Cloud GitHub Resolver 会自动可用。
|
||||
|
||||
## 使用方法
|
||||
|
||||
授予 OpenHands Cloud 仓库访问权限后，您可以在仓库的 issues 和 pull requests 中使用 Cloud GitHub Resolver。
|
||||
|
||||
### Issues
|
||||
|
||||
在您的仓库中，给 issue 添加 `openhands` 标签。OpenHands 将会：
|
||||
1. 在 issue 上发表评论，让您知道它正在处理该问题。
|
||||
- 您可以点击链接在 OpenHands Cloud 上跟踪进度。
|
||||
2. 如果确定问题已成功解决，则会打开一个 pull request。
|
||||
3. 在 issue 上发表评论，总结已执行的任务并提供 pull request 的链接。
|
||||
|
||||
|
||||
### Pull Requests
|
||||
|
||||
要让 OpenHands 处理 pull requests，请在顶级或内联评论中使用 `@openhands` 来：
|
||||
- 提问
|
||||
- 请求更新
|
||||
- 获取代码解释
|
||||
|
||||
OpenHands 将会：
|
||||
1. 在 PR 上发表评论，让您知道它正在处理该请求。
|
||||
2. 执行任务。
|
||||
@ -0,0 +1,32 @@
|
||||
# 云问题解决器
|
||||
|
||||
云问题解决器可以自动修复代码并为您的GitHub和GitLab仓库提供智能辅助。
|
||||
|
||||
## 设置
|
||||
|
||||
当您授予OpenHands Cloud仓库访问权限时，云问题解决器会自动可用：
|
||||
- [GitHub仓库访问](./github-installation#adding-repository-access)
|
||||
- [GitLab仓库访问](./gitlab-installation#adding-repository-access)
|
||||
|
||||
## 使用方法
|
||||
|
||||
授予OpenHands Cloud仓库访问权限后，您可以在仓库的问题和拉取/合并请求中使用云问题解决器。
|
||||
|
||||
### 处理问题
|
||||
|
||||
在您的仓库中，给问题添加`openhands`标签。OpenHands将会：
|
||||
1. 在问题上发表评论，让您知道它正在处理
|
||||
- 您可以点击链接在OpenHands Cloud上跟踪进度
|
||||
2. 如果确定问题已成功解决，则打开拉取请求（GitHub）或合并请求（GitLab）
|
||||
3. 在问题上发表评论，总结已执行的任务并提供PR/MR的链接
|
||||
|
||||
### 处理拉取/合并请求
|
||||
|
||||
要让OpenHands处理拉取请求（GitHub）或合并请求（GitLab），在评论中提及`@openhands`以：
|
||||
- 提问
|
||||
- 请求更新
|
||||
- 获取代码解释
|
||||
|
||||
OpenHands将会：
|
||||
1. 发表评论让您知道它正在处理
|
||||
2. 执行请求的任务
|
||||
@ -0,0 +1,29 @@
|
||||
# 云界面
|
||||
|
||||
云界面为与OpenHands AI交互提供了网页界面。本页面说明如何访问和使用OpenHands云界面。
|
||||
|
||||
## 访问界面
|
||||
|
||||
OpenHands云界面可以在[app.all-hands.dev](https://app.all-hands.dev)访问。您需要使用GitHub或GitLab账户登录才能访问界面。
|
||||
|
||||
<!-- 图片将在未来更新中添加 -->
|
||||
<!--  -->
|
||||
|
||||
## 主要功能
|
||||
|
||||
有关OpenHands云界面中可用功能的详细信息，请参阅文档的[主要功能](../key-features.md)部分。
|
||||
|
||||
## 设置
|
||||
|
||||
设置页面允许您：
|
||||
|
||||
1. 配置您的账户偏好
|
||||
2. 管理仓库访问权限
|
||||
3. 生成用于程序化访问的API密钥
|
||||
4. 自定义您的OpenHands体验
|
||||
|
||||
## 下一步
|
||||
|
||||
- [使用云问题解决器](./cloud-issue-resolver.md)自动修复代码并获取帮助
|
||||
- [了解云API](./cloud-api.md)进行程序化访问
|
||||
- [返回入门指南](./openhands-cloud.md)
|
||||
@ -0,0 +1,55 @@
|
||||
# GitHub 安装
|
||||
|
||||
本指南将引导您完成为GitHub仓库安装和配置OpenHands Cloud的过程。
|
||||
|
||||
## 前提条件
|
||||
|
||||
- GitHub账户
|
||||
- 访问OpenHands Cloud
|
||||
|
||||
## 安装步骤
|
||||
|
||||
1. 登录[OpenHands Cloud](https://app.all-hands.dev)
|
||||
2. 如果您尚未连接GitHub账户：
|
||||
- 点击`连接到GitHub`
|
||||
- 查看并接受服务条款
|
||||
- 授权OpenHands AI应用程序
|
||||
|
||||
## 添加仓库访问权限
|
||||
|
||||
您可以授予OpenHands访问特定仓库的权限：
|
||||
|
||||
1. 点击`选择GitHub项目`下拉菜单，然后选择`添加更多仓库...`
|
||||
2. 选择您的组织并选择要授予OpenHands访问权限的特定仓库。
|
||||
- OpenHands请求短期令牌（8小时过期）并具有以下权限：
|
||||
- 操作：读取和写入
|
||||
- 管理：只读
|
||||
- 提交状态：读取和写入
|
||||
- 内容：读取和写入
|
||||
- 问题：读取和写入
|
||||
- 元数据：只读
|
||||
- 拉取请求：读取和写入
|
||||
- Webhooks：读取和写入
|
||||
- 工作流程：读取和写入
|
||||
- 用户的仓库访问权限基于：
|
||||
- 为仓库授予的权限
|
||||
- 用户的GitHub权限（所有者/协作者）
|
||||
3. 点击`安装并授权`
|
||||
|
||||
## 修改仓库访问权限
|
||||
|
||||
您可以随时修改仓库访问权限：
|
||||
* 使用相同的`选择GitHub项目 > 添加更多仓库`工作流程，或
|
||||
* 访问设置页面并在`GitHub设置`部分选择`配置GitHub仓库`。
|
||||
|
||||
## 使用OpenHands与GitHub
|
||||
|
||||
一旦您授予了仓库访问权限，您就可以将OpenHands与您的GitHub仓库一起使用。
|
||||
|
||||
有关如何将OpenHands与GitHub问题和拉取请求一起使用的详细信息，请参阅[云问题解决器](./cloud-issue-resolver.md)文档。
|
||||
|
||||
## 下一步
|
||||
|
||||
- [访问云界面](./cloud-ui.md)与网页界面交互
|
||||
- [使用云问题解决器](./cloud-issue-resolver.md)自动修复代码并获取帮助
|
||||
- [使用云API](./cloud-api.md)以编程方式与OpenHands交互
|
||||
@ -0,0 +1,50 @@
|
||||
# GitLab 安装
|
||||
|
||||
本指南将引导您完成为GitLab仓库安装和配置OpenHands Cloud的过程。
|
||||
|
||||
## 前提条件
|
||||
|
||||
- GitLab账户
|
||||
- 访问OpenHands Cloud
|
||||
|
||||
## 安装步骤
|
||||
|
||||
1. 登录[OpenHands Cloud](https://app.all-hands.dev)
|
||||
2. 如果您尚未连接GitLab账户：
|
||||
- 点击`连接到GitLab`
|
||||
- 查看并接受服务条款
|
||||
- 授权OpenHands AI应用程序
|
||||
|
||||
## 添加仓库访问权限
|
||||
|
||||
您可以授予OpenHands访问特定仓库的权限：
|
||||
|
||||
1. 点击`选择GitLab项目`下拉菜单，然后选择`添加更多仓库...`
|
||||
2. 选择您的组织并选择要授予OpenHands访问权限的特定仓库。
|
||||
- OpenHands请求具有以下范围的权限：
|
||||
- api：完全API访问
|
||||
- read_user：读取用户信息
|
||||
- read_repository：读取仓库信息
|
||||
- write_repository：写入仓库
|
||||
- 用户的仓库访问权限基于：
|
||||
- 为仓库授予的权限
|
||||
- 用户的GitLab权限（所有者/维护者/开发者）
|
||||
3. 点击`安装并授权`
|
||||
|
||||
## 修改仓库访问权限
|
||||
|
||||
您可以随时修改仓库访问权限：
|
||||
* 使用相同的`选择GitLab项目 > 添加更多仓库`工作流程，或
|
||||
* 访问设置页面并在`GitLab设置`部分选择`配置GitLab仓库`。
|
||||
|
||||
## 使用OpenHands与GitLab
|
||||
|
||||
一旦您授予了仓库访问权限，您就可以将OpenHands与您的GitLab仓库一起使用。
|
||||
|
||||
有关如何将OpenHands与GitLab问题和合并请求一起使用的详细信息，请参阅[云问题解决器](./cloud-issue-resolver.md)文档。
|
||||
|
||||
## 下一步
|
||||
|
||||
- [访问云界面](./cloud-ui.md)与网页界面交互
|
||||
- [使用云问题解决器](./cloud-issue-resolver.md)自动修复代码并获取帮助
|
||||
- [使用云API](./cloud-api.md)以编程方式与OpenHands交互
|
||||
@ -0,0 +1,24 @@
|
||||
# OpenHands 云
|
||||
|
||||
OpenHands 云是All Hands AI的OpenHands的托管云版本。
|
||||
|
||||
## 访问OpenHands云
|
||||
|
||||
要开始使用OpenHands云，请访问[app.all-hands.dev](https://app.all-hands.dev)。
|
||||
|
||||
系统将提示您连接您的GitHub或GitLab账户：
|
||||
|
||||
1. 阅读并接受服务条款后，点击`连接到GitHub`或`连接到GitLab`。
|
||||
2. 查看OpenHands请求的权限并授权应用程序。
|
||||
- OpenHands将需要您账户的某些权限。要了解更多关于这些权限的信息，
|
||||
您可以点击授权页面上的`了解更多`链接。
|
||||
|
||||
## 下一步
|
||||
|
||||
一旦您连接了账户，您可以：
|
||||
|
||||
- [安装GitHub集成](./github-installation.md)以将OpenHands与您的GitHub仓库一起使用
|
||||
- [安装GitLab集成](./gitlab-installation.md)以将OpenHands与您的GitLab仓库一起使用
|
||||
- [访问云界面](./cloud-ui.md)与网页界面交互
|
||||
- [使用云API](./cloud-api.md)以编程方式与OpenHands交互
|
||||
- [设置云问题解决器](./cloud-issue-resolver.md)自动修复代码并提供智能辅助
|
||||
@ -1,65 +0,0 @@
|
||||
# OpenHands Cloud
|
||||
|
||||
OpenHands Cloud 是由 All Hands AI 提供的 OpenHands 云托管版本。
|
||||
|
||||
## 访问 OpenHands Cloud
|
||||
|
||||
OpenHands Cloud 可以通过 https://app.all-hands.dev/ 访问。
|
||||
|
||||
您还可以使用 [API](./cloud-api) 以编程方式与 OpenHands Cloud 交互。
|
||||
|
||||
## 入门指南
|
||||
|
||||
访问 OpenHands Cloud 后，系统会要求您连接您的 GitHub 或 GitLab 账户：
|
||||
|
||||
1. 阅读并接受服务条款后，点击 `Log in with GitHub` 或 `Log in with GitLab`。
|
||||
2. 查看 OpenHands 请求的权限，然后点击 `Authorize OpenHands AI`。
|
||||
- OpenHands 将需要您的 GitHub 或 GitLab 账户的一些权限。要了解更多关于这些权限的信息：
|
||||
- GitHub：您可以点击 GitHub 授权页面上的 `Learn more` 链接。
|
||||
- GitLab：您可以在 GitLab 授权页面上展开每个权限请求。
|
||||
|
||||
## 仓库访问
|
||||
|
||||
### GitHub
|
||||
|
||||
#### 添加仓库访问权限
|
||||
|
||||
您可以授予 OpenHands 特定仓库的访问权限：
|
||||
1. 在首页点击 `Add GitHub repos`。
|
||||
2. 选择组织，然后选择要授予 OpenHands 访问权限的特定仓库。
|
||||
<details>
|
||||
<summary>仓库访问权限详情</summary>
|
||||
|
||||
Openhands 请求短期令牌（8小时过期）并具有以下权限：
|
||||
- Actions：读写权限
|
||||
- Administration：只读权限
|
||||
- Commit statuses：读写权限
|
||||
- Contents：读写权限
|
||||
- Issues：读写权限
|
||||
- Metadata：只读权限
|
||||
- Pull requests：读写权限
|
||||
- Webhooks：读写权限
|
||||
- Workflows：读写权限
|
||||
|
||||
用户的仓库访问权限基于：
|
||||
- 为仓库授予的权限。
|
||||
- 用户的 GitHub 权限（所有者/协作者）。
|
||||
</details>
|
||||
|
||||
3. 点击 `Install & Authorize`。
|
||||
|
||||
#### 修改仓库访问权限
|
||||
|
||||
您可以随时修改 GitHub 仓库访问权限，方法是：
|
||||
* 使用相同的 `Add GitHub repos` 流程，或
|
||||
* 访问设置页面，在 `Git Settings` 部分下选择 `Configure GitHub Repositories`。
|
||||
|
||||
### GitLab
|
||||
|
||||
使用 GitLab 账户时，OpenHands 将自动获得对您仓库的访问权限。
|
||||
|
||||
## 对话持久性
|
||||
|
||||
- 对话列表 – 仅显示过去 10 天内发起的 10 个最近对话。
|
||||
- 工作区 – 对话工作区保留 14 天。
|
||||
- 运行时 – 运行时保持活跃（"热"状态）30 分钟。在此期间后，恢复对话可能需要 1-2 分钟。
|
||||
@ -1,6 +1,6 @@
|
||||
# OpenHands 功能概览
|
||||
|
||||
|
||||
|
||||
|
||||
### 聊天面板
|
||||
- 显示用户与 OpenHands 之间的对话。
|
||||
@ -22,7 +22,7 @@
|
||||
|
||||
### 应用
|
||||
- 当 OpenHands 运行应用程序时显示网络服务器。
|
||||
- 用户可以与运行中的应用程序交互。
|
||||
- 用户可以与正在运行的应用程序交互。
|
||||
|
||||
### 浏览器
|
||||
- 由 OpenHands 用于浏览网站。
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# OpenHands Cloud API
|
||||
# Cloud API
|
||||
|
||||
OpenHands Cloud provides a REST API that allows you to programmatically interact with the service. This is useful if
|
||||
you want to kick off your own jobs from your programs in a flexible way.
|
||||
|
||||
@ -1,33 +0,0 @@
|
||||
# Cloud GitHub Resolver
|
||||
|
||||
The GitHub Resolver automates code fixes and provides intelligent assistance for your repositories.
|
||||
|
||||
## Setup
|
||||
|
||||
The Cloud GitHub Resolver is available automatically when you
|
||||
[grant OpenHands Cloud repository access](./openhands-cloud#adding-repository-access).
|
||||
|
||||
## Usage
|
||||
|
||||
After granting OpenHands Cloud repository access, you can use the Cloud GitHub Resolver on the issues and pull requests
|
||||
on the repository.
|
||||
|
||||
### Issues
|
||||
|
||||
On your repository, label an issue with `openhands`. OpenHands will:
|
||||
1. Comment on the issue to let you know it is working on it.
|
||||
- You can click on the link to track the progress on OpenHands Cloud.
|
||||
2. Open a pull request if it determines that the issue has been successfully resolved.
|
||||
3. Comment on the issue with a summary of the performed tasks and a link to the pull request.
|
||||
|
||||
|
||||
### Pull Requests
|
||||
|
||||
To get OpenHands to work on pull requests, use `@openhands` in top level or inline comments to:
|
||||
- Ask questions
|
||||
- Request updates
|
||||
- Get code explanations
|
||||
|
||||
OpenHands will:
|
||||
1. Comment on the PR to let you know it is working on it.
|
||||
2. Perform the task.
|
||||
32
docs/modules/usage/cloud/cloud-issue-resolver.md
Normal file
32
docs/modules/usage/cloud/cloud-issue-resolver.md
Normal file
@ -0,0 +1,32 @@
|
||||
# Cloud Issue Resolver
|
||||
|
||||
The Cloud Issue Resolver automates code fixes and provides intelligent assistance for your repositories on GitHub.
|
||||
|
||||
## Setup
|
||||
|
||||
The Cloud Issue Resolver is available automatically when you grant OpenHands Cloud repository access:
|
||||
- [GitHub repository access](./github-installation#adding-repository-access)
|
||||
|
||||
## Usage
|
||||
|
||||
After granting OpenHands Cloud repository access, you can use the Cloud Issue Resolver on issues and pull requests in your repositories.
|
||||
|
||||
### Working with Issues
|
||||
|
||||
On your repository, label an issue with `openhands` or add a message starting with
|
||||
`@openhands`. OpenHands will:
|
||||
1. Comment on the issue to let you know it is working on it
|
||||
- You can click on the link to track the progress on OpenHands Cloud
|
||||
2. Open a pull request if it determines that the issue has been successfully resolved
|
||||
3. Comment on the issue with a summary of the performed tasks and a link to the PR
|
||||
|
||||
### Working with Pull Requests
|
||||
|
||||
To get OpenHands to work on pull requests, mention `@openhands` in comments to:
|
||||
- Ask questions
|
||||
- Request updates
|
||||
- Get code explanations
|
||||
|
||||
OpenHands will:
|
||||
1. Comment to let you know it is working on it
|
||||
2. Perform the requested task
|
||||
26
docs/modules/usage/cloud/cloud-ui.md
Normal file
26
docs/modules/usage/cloud/cloud-ui.md
Normal file
@ -0,0 +1,26 @@
|
||||
# Cloud UI
|
||||
|
||||
The Cloud UI provides a web interface for interacting with OpenHands AI. This page explains how to access and use the OpenHands Cloud UI.
|
||||
|
||||
## Accessing the UI
|
||||
|
||||
The OpenHands Cloud UI can be accessed at [app.all-hands.dev](https://app.all-hands.dev). You'll need to sign in with your GitHub or GitLab account to access the interface.
|
||||
|
||||
|
||||
## Key Features
|
||||
|
||||
For detailed information about the features available in the OpenHands Cloud UI, please refer to the [Key Features](../key-features.md) section of the documentation.
|
||||
|
||||
## Settings
|
||||
|
||||
The settings page allows you to:
|
||||
|
||||
- Configure your account preferences.
|
||||
- Manage repository access.
|
||||
- Generate API keys for programmatic access.
|
||||
- Generate custom secrets for the agent.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Use the Cloud Issue Resolver](./cloud-issue-resolver.md) to automate code fixes and get assistance.
|
||||
- [Learn about the Cloud API](./cloud-api.md) for programmatic access.
|
||||
53
docs/modules/usage/cloud/github-installation.md
Normal file
53
docs/modules/usage/cloud/github-installation.md
Normal file
@ -0,0 +1,53 @@
|
||||
# GitHub Installation
|
||||
|
||||
This guide walks you through the process of installing and configuring OpenHands Cloud for your GitHub repositories.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A GitHub account
|
||||
- Access to OpenHands Cloud
|
||||
|
||||
## Installation Steps
|
||||
|
||||
1. Log in to [OpenHands Cloud](https://app.all-hands.dev)
|
||||
2. If you haven't connected your GitHub account yet:
|
||||
- Click on `Connect to GitHub`
|
||||
- Review and accept the terms of service
|
||||
- Authorize the OpenHands AI application
|
||||
|
||||
## Adding Repository Access
|
||||
|
||||
You can grant OpenHands access to specific repositories:
|
||||
|
||||
1. Click on `Add GitHub repos`
|
||||
2. Select your organization and choose the specific repositories to grant OpenHands access to.
|
||||
- OpenHands requests short-lived tokens (8-hour expiration) with these permissions:
|
||||
- Actions: Read and write
|
||||
- Administration: Read-only
|
||||
- Commit statuses: Read and write
|
||||
- Contents: Read and write
|
||||
- Issues: Read and write
|
||||
- Metadata: Read-only
|
||||
- Pull requests: Read and write
|
||||
- Webhooks: Read and write
|
||||
- Workflows: Read and write
|
||||
- Repository access for a user is granted based on:
|
||||
- Permission granted for the repository
|
||||
- User's GitHub permissions (owner/collaborator)
|
||||
3. Click `Install & Authorize`
|
||||
|
||||
## Modifying Repository Access
|
||||
|
||||
You can modify repository access at any time by visiting the Settings page and selecting `Configure GitHub Repositories` under the `Git` tab.
|
||||
|
||||
## Using OpenHands with GitHub
|
||||
|
||||
Once you've granted repository access, you can use OpenHands with your GitHub repositories.
|
||||
|
||||
For details on how to use OpenHands with GitHub issues and pull requests, see the [Cloud Issue Resolver](./cloud-issue-resolver.md) documentation.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Access the Cloud UI](./cloud-ui.md) to interact with the web interface
|
||||
- [Use the Cloud Issue Resolver](./cloud-issue-resolver.md) to automate code fixes and get assistance
|
||||
- [Use the Cloud API](./cloud-api.md) to programmatically interact with OpenHands
|
||||
22
docs/modules/usage/cloud/gitlab-installation.md
Normal file
22
docs/modules/usage/cloud/gitlab-installation.md
Normal file
@ -0,0 +1,22 @@
|
||||
# GitLab Installation
|
||||
|
||||
This guide walks you through the process of installing and configuring OpenHands Cloud for your GitLab repositories.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A GitLab account
|
||||
- Access to OpenHands Cloud
|
||||
|
||||
## Installation Steps
|
||||
|
||||
1. Log in to [OpenHands Cloud](https://app.all-hands.dev)
|
||||
2. If you haven't connected your GitLab account yet:
|
||||
- Click on `Log in with GitLab`
|
||||
- Authorize the OpenHands application
|
||||
|
||||
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Access the Cloud UI](./cloud-ui.md) to interact with the web interface
|
||||
- [Use the Cloud API](./cloud-api.md) to programmatically interact with OpenHands
|
||||
24
docs/modules/usage/cloud/openhands-cloud.md
Normal file
24
docs/modules/usage/cloud/openhands-cloud.md
Normal file
@ -0,0 +1,24 @@
|
||||
# OpenHands Cloud
|
||||
|
||||
OpenHands Cloud is the hosted cloud version of All Hands AI's OpenHands.
|
||||
|
||||
## Accessing OpenHands Cloud
|
||||
|
||||
To get started with OpenHands Cloud, visit [app.all-hands.dev](https://app.all-hands.dev).
|
||||
|
||||
You'll be prompted to connect with your GitHub or GitLab account:
|
||||
|
||||
1. Click `Log in with GitHub` or `Log in with GitLab`.
|
||||
2. Review the permissions requested by OpenHands and authorize the application.
|
||||
- OpenHands will require certain permissions from your account. To read more about these permissions,
|
||||
you can click the `Learn more` link on the authorization page.
|
||||
|
||||
## Next Steps
|
||||
|
||||
Once you've connected your account, you can:
|
||||
|
||||
- [Install GitHub Integration](./github-installation.md) to use OpenHands with your GitHub repositories
|
||||
- [Install GitLab Integration](./gitlab-installation.md) to use OpenHands with your GitLab repositories
|
||||
- [Access the Cloud UI](./cloud-ui.md) to interact with the web interface
|
||||
- [Use the Cloud API](./cloud-api.md) to programmatically interact with OpenHands
|
||||
- [Set up the Cloud Issue Resolver](./cloud-issue-resolver.md) to automate code fixes and provide intelligent assistance
|
||||
@ -24,19 +24,40 @@ const sidebars: SidebarsConfig = {
|
||||
items: [
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'Openhands Cloud',
|
||||
label: 'Getting Started',
|
||||
id: 'usage/cloud/openhands-cloud',
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Installation',
|
||||
items: [
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'GitHub Installation',
|
||||
id: 'usage/cloud/github-installation',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'GitLab Installation',
|
||||
id: 'usage/cloud/gitlab-installation',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'Cloud UI',
|
||||
id: 'usage/cloud/cloud-ui',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'Cloud Issue Resolver',
|
||||
id: 'usage/cloud/cloud-issue-resolver',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'Cloud API',
|
||||
id: 'usage/cloud/cloud-api',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'Cloud GitHub Resolver',
|
||||
id: 'usage/cloud/cloud-github-resolver',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user