OpenHands Agent-Computer Interface (ACI)

0.3.3 · deprecated · verified Sat Apr 11

OpenHands-ACI (Agent-Computer Interface) provides essential tools and interfaces for AI agents to interact with computer systems for software development tasks. This includes capabilities for sophisticated code editing, file management, code linting, and executing shell commands, acting as a foundational layer for AI software engineer agents like OpenHands. The project is currently archived as its functionalities have been migrated to the OpenHands Agent SDK.

Warnings

breaking The `openhands-aci` repository is officially archived, and the file editor tool, a core component, has been migrated to the OpenHands Agent SDK under `openhands/tools/str_replace_editor`. This means direct usage of `openhands-aci` for file editing functionality is deprecated and likely to be broken or not maintained.
Fix: Migrate your code to use the OpenHands Agent SDK for agent-computer interface functionalities, especially for file editing. Refer to the official OpenHands documentation for the latest SDK usage.
gotcha Practical use of OpenHands (which utilizes ACI) often requires a running Docker environment for sandboxed code execution. Without Docker installed and running, core functionalities related to agent interaction with the system may fail.
Fix: Ensure Docker is installed and running on your system. For Windows users, WSL (Windows Subsystem for Linux) is required. Troubleshoot Docker connectivity if errors like 'Launch docker client failed' occur.
gotcha Earlier versions of `openhands-aci` (and potentially `openhands` CLI interactions) have reported issues with invalid JSON output, which can lead to parsing errors for agents or consuming applications.
Fix: Ensure you are using the latest available version of `openhands-aci` (though deprecated) or, more importantly, the OpenHands Agent SDK, as fixes for such issues would be integrated there. Monitor for updates related to structured output and parsing.

Install

pip install openhands-aci Install latest version

Imports

Code Editor and related tools
```
from openhands.tools.str_replace_editor import StrReplaceEditor # For file editing functionality
```
The core file editor tool functionality has been migrated from `openhands-aci` to the OpenHands Agent SDK. Direct imports from `openhands_aci.editor` are deprecated.
Shell execution
```
from openhands_aci.utils.shell import execute_shell_command
```
Example for utility functions like shell command execution, still present in the archived package.

Quickstart

This quickstart demonstrates a basic utility from `openhands-aci`, specifically executing a shell command, which represents a core function of an Agent-Computer Interface. This is for illustrative purposes as the library is deprecated. For developing with OpenHands, it is recommended to use the OpenHands Agent SDK or the `openhands` CLI directly.

import os
import asyncio
from openhands_aci.utils.shell import execute_shell_command

async def main():
    print("Demonstrating a basic utility from openhands-aci (shell command execution).")
    print("Note: The openhands-aci library is deprecated. For modern usage, refer to the OpenHands Agent SDK.")

    # Example: Execute a simple shell command
    command = "echo Hello from OpenHands ACI"
    print(f"Executing: '{command}'")
    result = await execute_shell_command(command, os.environ.get('AUTH_TOKEN', ''))
    print(f"Stdout: {result.stdout.strip()}")
    print(f"Stderr: {result.stderr.strip()}")
    print(f"Return Code: {result.return_code}")

    # Example: List files in the current directory
    command_ls = "ls -la"
    print(f"\nExecuting: '{command_ls}'")
    result_ls = await execute_shell_command(command_ls, os.environ.get('AUTH_TOKEN', ''))
    print(f"Stdout:\n{result_ls.stdout.strip()}")

if __name__ == "__main__":
    asyncio.run(main())

view raw JSON →