Installation and Setup

  1. Follow the installation instructions to install OpenHands.
  2. After running the command, access OpenHands at http://localhost:3000.

Interacting with the GUI

Initial Setup

  1. Upon first launch, you’ll see a settings popup.
  2. Select an LLM Provider and LLM Model from the dropdown menus. If the required model does not exist in the list, select see advanced settings. Then toggle Advanced options and enter it with the correct prefix in the Custom Model text box.
  3. Enter the corresponding API Key for your chosen provider.
  4. Click Save Changes to apply the settings.

Version Control Tokens

OpenHands supports multiple version control providers. You can configure tokens for multiple providers simultaneously.

GitHub Token Setup

OpenHands automatically exports a GITHUB_TOKEN to the shell environment if provided:

GitLab Token Setup

OpenHands automatically exports a GITLAB_TOKEN to the shell environment if provided:

Advanced Settings

  1. Inside the Settings page, under the LLM tab, toggle Advanced options to access additional settings.
  2. Use the Custom Model text box to manually enter a model if it’s not in the list.
  3. Specify a Base URL if required by your LLM provider.

Interacting with the AI

  1. Type your prompt in the input box.
  2. Click the send button or press Enter to submit your message.
  3. The AI will process your input and provide a response in the chat window.
  4. You can continue the conversation by asking follow-up questions or providing additional information.

Tips for Effective Use

  • Be specific in your requests to get the most accurate and helpful responses, as described in the prompting best practices.
  • Use one of the recommended models, as described in the LLMs section.

Remember, the GUI mode of OpenHands is designed to make your interaction with the AI assistant as smooth and intuitive as possible. Don’t hesitate to explore its features to maximize your productivity.