Pular para o conteúdo principal

Executando o OpenHands

Requisitos do Sistema​

É recomendado um sistema com processador moderno e no mínimo 4GB de RAM para executar o OpenHands.

Pré-requisitos​

MacOS

Docker Desktop

  1. Instale o Docker Desktop no Mac.
  2. Abra o Docker Desktop, vá para Settings > Advanced e certifique-se de que Allow the default Docker socket to be used esteja habilitado.
Linux
nota

Testado com Ubuntu 22.04.

Docker Desktop

  1. Instale o Docker Desktop no Linux.
Windows

WSL

  1. Instale o WSL.
  2. Execute wsl --version no powershell e confirme Default Version: 2.

Docker Desktop

  1. Instale o Docker Desktop no Windows.
  2. Abra o Docker Desktop, vá para Settings e confirme o seguinte:
  • General: Use the WSL 2 based engine está habilitado.
  • Resources > WSL Integration: Enable integration with my default WSL distro está habilitado.
nota

O comando docker abaixo para iniciar o aplicativo deve ser executado dentro do terminal WSL.

Iniciar o Aplicativo​

A maneira mais fácil de executar o OpenHands é no Docker.

docker pull docker.all-hands.dev/all-hands-ai/runtime:0.37-nikolaik

docker run -it --rm --pull=always \
    -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.37-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.37

Você encontrará o OpenHands rodando em http://localhost:3000!

Você também pode conectar o OpenHands ao seu sistema de arquivos local, executar o OpenHands em um modo headless programável, interagir com ele através de uma CLI amigável, ou executá-lo em issues marcadas com uma ação do GitHub.

Configuração​

Após iniciar o OpenHands, você deve selecionar um LLM Provider e um LLM Model e inserir uma API Key correspondente. Isso pode ser feito durante o popup de configurações iniciais ou selecionando o botão Settings (ícone de engrenagem) na interface.

Se o modelo necessário não existir na lista, você pode ativar as opções Advanced e inserir manualmente com o prefixo correto na caixa de texto Custom Model. As opções Advanced também permitem especificar uma Base URL se necessário.

Obtendo uma API Key​

O OpenHands requer uma chave de API para acessar a maioria dos modelos de linguagem. Veja como obter uma chave de API dos provedores recomendados:

Anthropic (Claude)​

  1. Crie uma conta Anthropic.
  2. Gere uma chave de API.
  3. Configure o faturamento.

Considere definir limites de uso para controlar os custos.

OpenAI​

  1. Crie uma conta OpenAI.
  2. Gere uma chave de API.
  3. Configure o faturamento.

Agora você está pronto para começar a usar o OpenHands.

Versões​

O comando docker acima baixa a versão estável mais recente do OpenHands. Você também tem outras opções:

  • Para uma versão específica, substitua $VERSION em openhands:$VERSION e runtime:$VERSION pelo número da versão. Usamos SemVer, então 0.9 apontará automaticamente para a versão mais recente 0.9.x, e 0 apontará para a versão mais recente 0.x.x.
  • Para a versão de desenvolvimento mais atualizada, substitua $VERSION em openhands:$VERSION e runtime:$VERSION por main. Esta versão é instável e é recomendada apenas para fins de teste ou desenvolvimento.

Para o fluxo de trabalho de desenvolvimento, consulte Development.md.

Está tendo problemas? Confira nosso Guia de Solução de Problemas.