Skip to content

The agent that grows with you

10.6 KB
Raw Blame

Terminal Environment Provider Plugins

Hermes runs shell commands through a pluggable set of terminal backends. The built-in backends (local, Docker, Modal, Daytona, Vercel Sandbox, SSH) live in the core repo under tools/environments/. The official Singularity/Apptainer plugin is a complete worked example of this page. Third-party sandbox vendors integrate as plugins instead — a standalone plugin repo installed under ~/.hermes/plugins/, registering a backend the user selects exactly like a built-in one via terminal.backend in config.yaml.

This page mirrors the Browser Provider Plugins guide — same registration flow, same scope semantics.

What a provider controls

A registered backend automatically participates in every core surface:

Surface Driven by
Command dispatch (terminal, execute_code, file tools) create_environment()
hermes setup backend picker display_name, description, setup_instructions(), post_setup()
Dashboard terminal-backend picker (probe status) probe()
hermes status / hermes doctor doctor_checks()
System-prompt environment hints is_remote, env_description
Dangerous-command approval skipping skip_container_guards
Container path/cwd handling is_container
Where commands start when terminal.cwd is unset or unusable default_cwd
Bot Desktop, computer_use and the browser following the terminal supports_streams + the environment's exec_prefix()
Synced cache-file path translation cache_path_base
Secret stripping from spawned subprocesses strip_env_keys
Per-session sandbox isolation (container_persistent: false) session_isolated_when_nonpersistent

Declaring these flags on the provider closes the classic "new backend missed classification site N" bug class — the core consults the registry at each site instead of a hardcoded list of names.

Minimal provider

from agent.terminal_env_provider import TerminalEnvironmentProvider


class AcmeBoxEnvironment:
    """Must satisfy the BaseEnvironment duck-typed contract."""

    def __init__(self, cwd, timeout, task_id):
        self.cwd, self.timeout, self.task_id = cwd, timeout, task_id

    def execute(self, command, timeout=None, **kwargs):
        ...  # run the command in the sandbox
        return {"output": "...", "exit_code": 0}

    def cleanup(self):
        ...  # tear down / detach


class AcmeBoxProvider(TerminalEnvironmentProvider):
    name = "acmebox"
    display_name = "AcmeBox"
    is_remote = True          # commands don't run on the host
    is_container = True       # container-style path/cwd semantics

    @property
    def description(self):
        return "Run commands in an AcmeBox cloud sandbox."

    @property
    def cache_path_base(self):
        return "~/.hermes"    # where synced cache files land, or None

    @property
    def strip_env_keys(self):
        return frozenset({"ACMEBOX_TOKEN"})

    def is_available(self):
        import importlib.util, os
        return (
            importlib.util.find_spec("acmebox") is not None
            and bool(os.getenv("ACMEBOX_TOKEN"))
        )

    def create_environment(self, *, cwd, timeout, task_id="default",
                           image=None, container_config=None, **kwargs):
        return AcmeBoxEnvironment(cwd, timeout, task_id)


def register(ctx):
    ctx.register_terminal_environment_provider(AcmeBoxProvider())
name: acmebox
version: 0.1.0
description: AcmeBox cloud sandbox terminal backend
kind: backend

Enable it, select it, run:

hermes plugins enable acmebox
hermes config set terminal.backend acmebox

Rules

  • Reserved names. Registrations that collide with a built-in backend name (local, docker, modal, managed_modal, daytona, vercel_sandbox, ssh) are rejected. Plugins extend the backend set; they never shadow in-tree backends.
  • create_environment must accept **kwargs and ignore unknown keys — the forward-compat contract that lets the factory signature evolve without breaking older plugins.
  • is_available() / probe() must be cheap. No network calls — they run during requirement checks and UI paints.
  • Fail-soft everywhere. A provider attribute that raises is treated as its default by the core (e.g. a raising skip_container_guards keeps the approval layer ON). Don't rely on exceptions for control flow.
  • Secrets belong in strip_env_keys. Your vendor token must never be readable by a model-authored shell command; listing it strips it from every spawned subprocess unconditionally, like the built-in MODAL_* / DAYTONA_API_KEY handling.

Environment object contract

create_environment() returns an object satisfying the same duck-typed interface as tools.environments.base.BaseEnvironment:

  • execute(command, timeout=None, ...) → {"output": str, "exit_code": int}
  • cleanup() — release resources; called on session teardown / idle reaping
  • Optional: persistence hooks mirroring the built-in cloud backends

Subclassing BaseEnvironment is recommended (you inherit the shared file-sync and background-process plumbing) but not required.

File tools and the host filesystem

read_file, write_file, patch and search_files go through your environment's execute(), so they see exactly the files your commands see. The one exception is an environment that declares uses_host_filesystem = True (only the built-in LocalEnvironment does): there the file tools read, write and search the host directly, run the bundled ripgrep, stat paths on the host, write oversized tool output straight to ~/.hermes/cache/spillover and enable LSP diagnostics.

A backend that subclasses LocalEnvironment to confine its commands (a bubblewrap or other host sandbox that hides paths, mounts them read-only or gives commands their own $TMPDIR) inherits True and must turn it off, or the file tools bypass the sandbox:

from tools.environments.local import LocalEnvironment


class AcmeJailEnvironment(LocalEnvironment):
    uses_host_filesystem = False  # file tools run inside the jail, via execute()

Leave it unset on backends that don't subclass LocalEnvironment; the default is False. Hermes v0.22.5 and earlier ignore the attribute and use the host fast path for every LocalEnvironment subclass, so pin requires_hermes past that.

Images

Your backend reads its own image setting (a config_schema key, or a terminal.<name>_image key you document). Hermes passes image= only for a per-task override: a batch run (batch_runner.py) giving each prompt its own container registers it as <name>_image for the active backend, and that value reaches create_environment(image=...). Otherwise image is ""; fall back to your setting.

Starting directory

Without default_cwd, a plugin backend starts in /root, and a host-looking terminal.cwd is replaced by /root when is_container is set. Return an absolute in-sandbox path to start somewhere else:

    @property
    def default_cwd(self):
        return "/home/acme"

When the home directory is only known once the sandbox is up, return "~" instead. Hermes then passes cwd="~" to create_environment() (it never expands it on the host), and your environment sets self.cwd to the absolute home it resolved:

class AcmeBoxEnvironment(BaseEnvironment):
    def __init__(self, *, cwd, timeout, sandbox):
        if cwd == "~":
            cwd = sandbox.home()  # e.g. "/home/acme"
        super().__init__(cwd=cwd, timeout=timeout)

Hermes keeps ~ as the backend default, so every new sandbox resolves its own home, and records the path each environment resolved on that environment. Commands can also arrive with cwd="~"; BaseEnvironment already cds there correctly. A cd anywhere under that home is kept for later commands and used as the base for relative paths in the file tools. Without this, a sandbox path like /home/acme/project would be discarded as if it were a host path.

default_cwd is read on every command, so keep it cheap (no network calls). Relative paths are ignored, because Hermes would anchor them on the host.

Bot Desktop and computer_use

The screen, computer_use and the browser follow the terminal into Docker and SSH sandboxes (and the Singularity plugin's) by spawning long-lived processes there with stdin and stdout left open. A plugin backend can opt in the same way:

  1. Set supports_streams = True on the provider. bot_desktop.placement: auto then places the screen inside your backend instead of refusing.
  2. Give the environment an exec_prefix(*, user=None, interactive=True) method. It returns a local argv that runs whatever follows it inside the sandbox, with stdin and stdout open (the shape of docker exec -i <container>), or None when it can't right now. Hermes appends bash -c <script> as separate words, so the client must pass them through unchanged and the sandbox needs bash. user names the account to run as; ignore it if your backend can't switch users. Return a list, not a single command string.
class AcmeBoxEnvironment:
    def exec_prefix(self, *, user=None, interactive=True):
        return ["acmebox", "exec", "--stdin", self.sandbox_id, "--"]

The sandbox image still needs the desktop stack (Xvnc, Xfce, Chromium, cua-driver); nousresearch/hermes-sandbox:desktop has it. Bot Desktop and the browser keep their scratch files under the environment's get_temp_dir(). An environment that doesn't subclass BaseEnvironment and has no such method gets the same default BaseEnvironment uses.

A terminal backend runs only in-process: its environment object is what the terminal tool, file tools, exec_prefix() and the ~ home resolution all drive. Under plugins.isolation: host the object cannot cross the host boundary, so creating the environment refuses with a message naming plugins.isolation: in_process (before the host starts a sandbox), and Bot Desktop refuses a supports_streams backend the same way.

Session isolation semantics

If your sandbox is resumed by name (a durable VM the backend re-attaches to), set session_isolated_when_nonpersistent = True. With terminal.container_persistent: false, each session then gets its own sandbox identity instead of sharing one — without this, two independent ephemeral runs could attach one live VM and delete it out from under each other.