Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add comprehensive OpenHands glossary #6310

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Conversation

rbren
Copy link
Collaborator

@rbren rbren commented Jan 16, 2025

This PR adds a comprehensive glossary of OpenHands-specific terms to help users and contributors better understand the system.

The glossary includes:

  • 85+ terms organized hierarchically
  • Clear, concise definitions for each term
  • Categorization of related terms under parent concepts
  • Coverage of core components, tools, runtimes, and features

The glossary is stored in .openhands/microagents/glossary.md for easy access and maintenance.


To run this PR locally, use the following command:

docker run -it --rm   -p 3000:3000   -v /var/run/docker.sock:/var/run/docker.sock   --add-host host.docker.internal:host-gateway   -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:695310d-nikolaik   --name openhands-app-695310d   docker.all-hands.dev/all-hands-ai/openhands:695310d


#### Local Runtime
A runtime environment that executes on the local machine, suitable for development and testing.
#### Modal Runtime
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit. Not newlined like the others

### Browser
A system for web-based interactions and tasks.

#### Browser Environment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This definition isn't filled in yet, if it matters

Terminal and execution related functionality.

#### Bash Parser
A component that processes and interprets bash commands and their outputs for agent interaction.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this implies an interaction between Bash Parser, Bash Session, and the Runtime, but it isn't spelled out. Also Bash is one specific shell, we might consider calling this Shell or Console at some point.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now we have tmux integrated, i don't think we have a explicit bash parser anymore, i.e., most things are handled by tmux automatically. Maybe we could remove this to reduce confusion?

The current context and status of an agent, including its memory, active tools, and ongoing tasks.

#### CodeAct Agent
A specialized agent type in OpenHands designed specifically for software development tasks and code manipulation.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A specialized agent type in OpenHands designed specifically for software development tasks and code manipulation.
[A generalist agent in OpenHands](https://arxiv.org/abs/2407.16741) designed to perform tasks by editing and executing code.

Terminal and execution related functionality.

#### Bash Parser
A component that processes and interprets bash commands and their outputs for agent interaction.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now we have tmux integrated, i don't think we have a explicit bash parser anymore, i.e., most things are handled by tmux automatically. Maybe we could remove this to reduce confusion?


#### Local Runtime
A runtime environment that executes on the local machine, suitable for development and testing.
#### Modal Runtime
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Modal Runtime
#### Modal Runtime

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants