diff --git a/.github/scripts/README.md b/.github/scripts/README.md index 35861a81..9aff1875 100644 --- a/.github/scripts/README.md +++ b/.github/scripts/README.md @@ -42,7 +42,7 @@ To test locally: cd docs # Clone agent-sdk if not already present -git clone https://github.com/All-Hands-AI/agent-sdk.git agent-sdk +git clone https://github.com/OpenHands/agent-sdk.git agent-sdk # Run the script python .github/scripts/sync_code_blocks.py diff --git a/.github/workflows/sync-agent-sdk-openapi.yml b/.github/workflows/sync-agent-sdk-openapi.yml index 0a290933..cb610367 100644 --- a/.github/workflows/sync-agent-sdk-openapi.yml +++ b/.github/workflows/sync-agent-sdk-openapi.yml @@ -38,7 +38,7 @@ jobs: - name: Checkout agent-sdk uses: actions/checkout@v4 with: - repository: All-Hands-AI/agent-sdk + repository: OpenHands/agent-sdk path: agent-sdk ref: ${{ env.AGENT_SDK_REF }} fetch-depth: 0 diff --git a/.github/workflows/sync-docs-code-blocks.yml b/.github/workflows/sync-docs-code-blocks.yml index e4ac2fc0..72dfeb50 100644 --- a/.github/workflows/sync-docs-code-blocks.yml +++ b/.github/workflows/sync-docs-code-blocks.yml @@ -31,7 +31,7 @@ jobs: - name: Checkout agent-sdk uses: actions/checkout@v4 with: - repository: All-Hands-AI/agent-sdk + repository: OpenHands/agent-sdk path: agent-sdk ref: ${{ github.event.inputs.agent_sdk_ref || 'main' }} fetch-depth: 0 diff --git a/.openhands/microagents/sdk-guidelines.md b/.openhands/microagents/sdk-guidelines.md index f1d22510..49bacf65 100644 --- a/.openhands/microagents/sdk-guidelines.md +++ b/.openhands/microagents/sdk-guidelines.md @@ -123,7 +123,7 @@ Links to the GitHub source file: ```mdx -This example is available on GitHub: [examples/01_standalone_sdk/02_custom_tools.py](https://github.com/All-Hands-AI/agent-sdk/blob/main/examples/01_standalone_sdk/02_custom_tools.py) +This example is available on GitHub: [examples/01_standalone_sdk/02_custom_tools.py](https://github.com/OpenHands/agent-sdk/blob/main/examples/01_standalone_sdk/02_custom_tools.py) ``` diff --git a/openapi/agent-sdk.json b/openapi/agent-sdk.json index 62aa00b8..cbb419e4 100644 --- a/openapi/agent-sdk.json +++ b/openapi/agent-sdk.json @@ -1489,14 +1489,14 @@ } } }, - "/api/bash/execute_bash_command": { + "/api/bash/start_bash_command": { "post": { "tags": [ "Bash" ], "summary": "Start Bash Command", - "description": "Execute a bash command", - "operationId": "start_bash_command_api_bash_execute_bash_command_post", + "description": "Execute a bash command in the background", + "operationId": "start_bash_command_api_bash_start_bash_command_post", "requestBody": { "content": { "application/json": { @@ -1531,6 +1531,48 @@ } } }, + "/api/bash/execute_bash_command": { + "post": { + "tags": [ + "Bash" + ], + "summary": "Execute Bash Command", + "description": "Execute a bash command and wait for a result", + "operationId": "execute_bash_command_api_bash_execute_bash_command_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExecuteBashRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BashOutput" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/api/bash/bash_events": { "delete": { "tags": [ diff --git a/openhands/usage/cloud/gitlab-installation.mdx b/openhands/usage/cloud/gitlab-installation.mdx index 38ae0ed8..11f55079 100644 --- a/openhands/usage/cloud/gitlab-installation.mdx +++ b/openhands/usage/cloud/gitlab-installation.mdx @@ -33,7 +33,7 @@ This feature works for personal projects and is available for group projects wit [Premium or Ultimate tier subscription](https://docs.gitlab.com/user/project/integrations/webhooks/#group-webhooks). A webhook is automatically installed within a few minutes after the owner/maintainer of the project or group logs into -OpenHands Cloud. If you decide to delete the webhook, then re-installing will require the support of All Hands AI but +OpenHands Cloud. If you decide to delete the webhook, then re-installing will require our support, but we are planning to improve this in a future release. diff --git a/sdk/arch/llms/configuration.mdx b/sdk/arch/llms/configuration.mdx index f6b3bf55..3d861d57 100644 --- a/sdk/arch/llms/configuration.mdx +++ b/sdk/arch/llms/configuration.mdx @@ -65,7 +65,7 @@ human review of committed configuration. into SDK telemetry so downstream interfaces can display usage estimates. Refer to the docstring within -[`openhands.sdk.llm.LLM`](https://github.com/All-Hands-AI/agent-sdk/blob/main/openhands-sdk/openhands/sdk/llm/llm.py) +[`openhands.sdk.llm.LLM`](https://github.com/OpenHands/agent-sdk/blob/main/openhands-sdk/openhands/sdk/llm/llm.py) for the full schema. All fields can be set programmatically or via environment variables using the naming rule `field -> LLM_FIELD`. diff --git a/sdk/arch/llms/index.mdx b/sdk/arch/llms/index.mdx index 0a93cbea..2aa8485d 100644 --- a/sdk/arch/llms/index.mdx +++ b/sdk/arch/llms/index.mdx @@ -38,7 +38,7 @@ graph LR ## Creating LLM instances -Use the [`openhands.sdk.llm.LLM`](https://github.com/All-Hands-AI/agent-sdk/blob/main/openhands-sdk/openhands/sdk/llm/llm.py) +Use the [`openhands.sdk.llm.LLM`](https://github.com/OpenHands/agent-sdk/blob/main/openhands-sdk/openhands/sdk/llm/llm.py) class to configure model access. The only required field is the `model` name; other options (API keys, retry tuning, response tracing) are optional. diff --git a/sdk/getting-started.mdx b/sdk/getting-started.mdx index e169e435..26aeb9db 100644 --- a/sdk/getting-started.mdx +++ b/sdk/getting-started.mdx @@ -57,7 +57,7 @@ export LLM_API_KEY=your-api-key-here ```bash # Clone the repository - git clone https://github.com/All-Hands-AI/agent-sdk.git + git clone https://github.com/OpenHands/agent-sdk.git cd agent-sdk # Install dependencies and setup development environment @@ -168,5 +168,5 @@ ls examples/01_standalone_sdk/ ### Get Help - **[Slack Community](https://openhands.dev/joinslack)** - Ask questions and share projects -- **[GitHub Issues](https://github.com/All-Hands-AI/agent-sdk/issues)** - Report bugs or request features -- **[Example Directory](https://github.com/All-Hands-AI/agent-sdk/tree/main/examples)** - Browse working code samples +- **[GitHub Issues](https://github.com/OpenHands/agent-sdk/issues)** - Report bugs or request features +- **[Example Directory](https://github.com/OpenHands/agent-sdk/tree/main/examples)** - Browse working code samples diff --git a/sdk/guides/custom-tools.mdx b/sdk/guides/custom-tools.mdx index 8440e8cf..d91b51bd 100644 --- a/sdk/guides/custom-tools.mdx +++ b/sdk/guides/custom-tools.mdx @@ -32,7 +32,7 @@ These components are tied together by a **ToolDefinition** that registers the to ## Creating a Custom Tool -This example is available on GitHub: [examples/01_standalone_sdk/02_custom_tools.py](https://github.com/All-Hands-AI/agent-sdk/blob/main/examples/01_standalone_sdk/02_custom_tools.py) +This example is available on GitHub: [examples/01_standalone_sdk/02_custom_tools.py](https://github.com/OpenHands/agent-sdk/blob/main/examples/01_standalone_sdk/02_custom_tools.py) Here's a minimal example of creating a custom grep tool: diff --git a/sdk/guides/hello-world.mdx b/sdk/guides/hello-world.mdx index d33e6c11..0cefa2e8 100644 --- a/sdk/guides/hello-world.mdx +++ b/sdk/guides/hello-world.mdx @@ -4,7 +4,7 @@ description: The simplest possible OpenHands agent - configure an LLM, create an --- -This example is available on GitHub: [examples/01_standalone_sdk/01_hello_world.py](https://github.com/All-Hands-AI/agent-sdk/blob/main/examples/01_standalone_sdk/01_hello_world.py) +This example is available on GitHub: [examples/01_standalone_sdk/01_hello_world.py](https://github.com/OpenHands/agent-sdk/blob/main/examples/01_standalone_sdk/01_hello_world.py) This is the most basic example showing how to set up and run an OpenHands agent: diff --git a/sdk/guides/mcp.mdx b/sdk/guides/mcp.mdx index ff9c615e..0c62b09c 100644 --- a/sdk/guides/mcp.mdx +++ b/sdk/guides/mcp.mdx @@ -9,7 +9,7 @@ MCP (Model Context Protocol) is a protocol for exposing tools and resources to A ## Basic MCP Usage -This example is available on GitHub: [examples/01_standalone_sdk/07_mcp_integration.py](https://github.com/All-Hands-AI/agent-sdk/blob/main/examples/01_standalone_sdk/07_mcp_integration.py) +This example is available on GitHub: [examples/01_standalone_sdk/07_mcp_integration.py](https://github.com/OpenHands/agent-sdk/blob/main/examples/01_standalone_sdk/07_mcp_integration.py) Here's an example integrating MCP servers with an agent: @@ -139,7 +139,7 @@ agent = Agent( ## MCP with OAuth -This example is available on GitHub: [examples/01_standalone_sdk/08_mcp_with_oauth.py](https://github.com/All-Hands-AI/agent-sdk/blob/main/examples/01_standalone_sdk/08_mcp_with_oauth.py) +This example is available on GitHub: [examples/01_standalone_sdk/08_mcp_with_oauth.py](https://github.com/OpenHands/agent-sdk/blob/main/examples/01_standalone_sdk/08_mcp_with_oauth.py) For MCP servers requiring OAuth authentication: diff --git a/sdk/index.mdx b/sdk/index.mdx index dfae86f3..3eeef3d0 100644 --- a/sdk/index.mdx +++ b/sdk/index.mdx @@ -78,7 +78,7 @@ Other SDKs (e.g. [Claude Code](https://github.com/anthropics/claude-agent-sdk-py Explore the complete SDK API and source code. @@ -118,7 +118,7 @@ Other SDKs (e.g. [Claude Code](https://github.com/anthropics/claude-agent-sdk-py Contribute to the SDK or report issues on GitHub.