Update docs to match backend key rename and CWD behavior
- cli-config.yaml.example: env_type → backend everywhere, matching the documented config key that hermes_cli/config.py and README already use - cli-config.yaml.example: added comments clarifying cwd is a path INSIDE the target environment for non-local backends - AGENTS.md: updated terminal.cwd description to explain "." only resolves to host CWD for the local backend - .env.example: updated TERMINAL_CWD comment to warn against using host-local paths with remote backends, lists per-backend defaults
This commit is contained in:
parent
c33feb6dc9
commit
a7609c97be
3 changed files with 15 additions and 13 deletions
|
|
@ -48,8 +48,10 @@ TERMINAL_MODAL_IMAGE=nikolaik/python-nodejs:python3.11-nodejs20
|
||||||
|
|
||||||
|
|
||||||
# Working directory for terminal commands
|
# Working directory for terminal commands
|
||||||
# For CLI: "." means current directory (resolved automatically from config.yaml)
|
# For local backend: "." means current directory (resolved automatically)
|
||||||
# For containers (docker/singularity/modal): absolute path inside the container
|
# For remote backends (ssh/docker/modal/singularity): use an absolute path
|
||||||
|
# INSIDE the target environment, or leave unset for the backend's default
|
||||||
|
# (/root for modal, / for docker, ~ for ssh). Do NOT use a host-local path.
|
||||||
# Usually managed by config.yaml (terminal.cwd) — uncomment to override
|
# Usually managed by config.yaml (terminal.cwd) — uncomment to override
|
||||||
# TERMINAL_CWD=.
|
# TERMINAL_CWD=.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -364,7 +364,7 @@ API keys are loaded from `~/.hermes/.env`:
|
||||||
|
|
||||||
Terminal tool configuration (in `~/.hermes/config.yaml`):
|
Terminal tool configuration (in `~/.hermes/config.yaml`):
|
||||||
- `terminal.backend` - Backend: local, docker, singularity, modal, or ssh
|
- `terminal.backend` - Backend: local, docker, singularity, modal, or ssh
|
||||||
- `terminal.cwd` - Working directory for CLI ("." = current directory)
|
- `terminal.cwd` - Working directory ("." = host CWD for local only; for remote backends set an absolute path inside the target, or omit to use the backend's default)
|
||||||
- `terminal.docker_image` - Image for Docker backend
|
- `terminal.docker_image` - Image for Docker backend
|
||||||
- `terminal.singularity_image` - Image for Singularity backend
|
- `terminal.singularity_image` - Image for Singularity backend
|
||||||
- `terminal.modal_image` - Image for Modal backend
|
- `terminal.modal_image` - Image for Modal backend
|
||||||
|
|
|
||||||
|
|
@ -27,8 +27,8 @@ model:
|
||||||
# - CLI (`hermes` command): Uses "." (current directory where you run hermes)
|
# - CLI (`hermes` command): Uses "." (current directory where you run hermes)
|
||||||
# - Messaging (Telegram/Discord): Uses MESSAGING_CWD from .env (default: home)
|
# - Messaging (Telegram/Discord): Uses MESSAGING_CWD from .env (default: home)
|
||||||
terminal:
|
terminal:
|
||||||
env_type: "local"
|
backend: "local"
|
||||||
cwd: "." # CLI working directory - "." means current directory
|
cwd: "." # For local backend: "." = current directory. Ignored for remote backends.
|
||||||
timeout: 180
|
timeout: 180
|
||||||
lifetime_seconds: 300
|
lifetime_seconds: 300
|
||||||
# sudo_password: "" # Enable sudo commands (pipes via sudo -S) - SECURITY WARNING: plaintext!
|
# sudo_password: "" # Enable sudo commands (pipes via sudo -S) - SECURITY WARNING: plaintext!
|
||||||
|
|
@ -39,8 +39,8 @@ terminal:
|
||||||
# Great for: keeping agent isolated from its own code, using powerful remote hardware
|
# Great for: keeping agent isolated from its own code, using powerful remote hardware
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
# terminal:
|
# terminal:
|
||||||
# env_type: "ssh"
|
# backend: "ssh"
|
||||||
# cwd: "/home/myuser/project"
|
# cwd: "/home/myuser/project" # Path on the REMOTE server
|
||||||
# timeout: 180
|
# timeout: 180
|
||||||
# lifetime_seconds: 300
|
# lifetime_seconds: 300
|
||||||
# ssh_host: "my-server.example.com"
|
# ssh_host: "my-server.example.com"
|
||||||
|
|
@ -54,8 +54,8 @@ terminal:
|
||||||
# Great for: reproducible environments, testing, isolation
|
# Great for: reproducible environments, testing, isolation
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
# terminal:
|
# terminal:
|
||||||
# env_type: "docker"
|
# backend: "docker"
|
||||||
# cwd: "/workspace"
|
# cwd: "/workspace" # Path INSIDE the container (default: /)
|
||||||
# timeout: 180
|
# timeout: 180
|
||||||
# lifetime_seconds: 300
|
# lifetime_seconds: 300
|
||||||
# docker_image: "nikolaik/python-nodejs:python3.11-nodejs20"
|
# docker_image: "nikolaik/python-nodejs:python3.11-nodejs20"
|
||||||
|
|
@ -66,8 +66,8 @@ terminal:
|
||||||
# Great for: HPC clusters, shared compute environments
|
# Great for: HPC clusters, shared compute environments
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
# terminal:
|
# terminal:
|
||||||
# env_type: "singularity"
|
# backend: "singularity"
|
||||||
# cwd: "/workspace"
|
# cwd: "/workspace" # Path INSIDE the container (default: /root)
|
||||||
# timeout: 180
|
# timeout: 180
|
||||||
# lifetime_seconds: 300
|
# lifetime_seconds: 300
|
||||||
# singularity_image: "docker://nikolaik/python-nodejs:python3.11-nodejs20"
|
# singularity_image: "docker://nikolaik/python-nodejs:python3.11-nodejs20"
|
||||||
|
|
@ -78,8 +78,8 @@ terminal:
|
||||||
# Great for: GPU access, scalable compute, serverless execution
|
# Great for: GPU access, scalable compute, serverless execution
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
# terminal:
|
# terminal:
|
||||||
# env_type: "modal"
|
# backend: "modal"
|
||||||
# cwd: "/workspace"
|
# cwd: "/workspace" # Path INSIDE the sandbox (default: /root)
|
||||||
# timeout: 180
|
# timeout: 180
|
||||||
# lifetime_seconds: 300
|
# lifetime_seconds: 300
|
||||||
# modal_image: "nikolaik/python-nodejs:python3.11-nodejs20"
|
# modal_image: "nikolaik/python-nodejs:python3.11-nodejs20"
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue