"""Profile distributions — shareable, packaged Hermes profiles via git. Sources: a git URL (``github.com/user/repo``, ``https://...``, ``git@...``, ``ssh://``, ``git://``) or a local directory that already contains ``distribution.yaml`` (profile development before the first push). """ from __future__ import annotations import operator import os import re import shutil import subprocess import tempfile from dataclasses import dataclass, field from datetime import datetime, timezone from pathlib import Path from typing import Any, Dict, List, Optional, Tuple import hermes_yaml as yaml from hermes_cli._subprocess_compat import noninteractive_git_env from hermes_cli.archive_safe import normalize_archive_parts from hermes_cli.profiles import DEFAULT_EXPORT_EXCLUDE_ROOT from utils import rmtree_readonly MANIFEST_FILENAME = "distribution.yaml" ENV_TEMPLATE_FILENAME = ".env.template" ENV_EXAMPLE_FILENAME = ".env.EXAMPLE" # Default distribution-owned paths (relative to profile root). Authors may override via # ``distribution_owned:``. config.yaml is dist-owned but preserved on update by default. DEFAULT_DIST_OWNED: Tuple[str, ...] = ("SOUL.md", "config.yaml", "mcp.json", "skills", "cron", MANIFEST_FILENAME) # Distribution-specific user data extends the shared profile/runtime exclusions. USER_OWNED_EXCLUDE: frozenset = DEFAULT_EXPORT_EXCLUDE_ROOT | frozenset({ "memories", "sessions", "plans", "workspace", "home", "backups", "cache", "local", }) # Profile distributions own cron definitions, not scheduler state. The runtime has # one canonical multi-record store; every sibling under cron/ is runtime data. _CRON_STORE_REL = ("cron", "jobs.json") def _is_distribution_runtime_path(parts: Tuple[str, ...]) -> bool: """Runtime-owned entries nested under otherwise distribution-owned roots.""" if len(parts) < 2: return False if parts[0] == "cron": return parts[:2] != _CRON_STORE_REL # Root-level dot entries under skills are Hermes bookkeeping (.hub, # .usage.json, curator state, bundled manifest, locks, archives, ...). return parts[0] == "skills" and len(parts) == 2 and parts[1].startswith(".") class DistributionError(Exception): """Raised for distribution install/update failures.""" # Manifest def _str(data: dict, key: str, default: str = "") -> str: return str(data.get(key) or default) @dataclass class EnvRequirement: name: str description: str = "" required: bool = True default: Optional[str] = None @classmethod def from_dict(cls, data: Any) -> "EnvRequirement": if not isinstance(data, dict): raise DistributionError(f"env_requires entry must be a mapping, got {type(data).__name__}") name = _str(data, "name").strip() if not name: raise DistributionError("env_requires entry missing 'name'") return cls( name=name, description=_str(data, "description"), required=bool(data.get("required", True)), default=data.get("default"), ) def to_dict(self) -> Dict[str, Any]: out: Dict[str, Any] = {"name": self.name, "description": self.description} if not self.required: out["required"] = False if self.default is not None: out["default"] = self.default return out @dataclass class DistributionManifest: name: str version: str = "0.1.0" description: str = "" hermes_requires: str = "" author: str = "" license: str = "" env_requires: List[EnvRequirement] = field(default_factory=list) distribution_owned: List[str] = field(default_factory=list) # Tracked after install — where we pulled from, so ``update`` can re-pull. source: str = "" # ISO-8601 UTC timestamp written on install/update (empty in repo-shipped manifests). installed_at: str = "" @classmethod def from_dict(cls, data: Any) -> "DistributionManifest": if not isinstance(data, dict): raise DistributionError(f"{MANIFEST_FILENAME} must be a mapping, got {type(data).__name__}") name = _str(data, "name").strip() if not name: raise DistributionError(f"{MANIFEST_FILENAME} missing 'name'") env_raw = data.get("env_requires") or [] if not isinstance(env_raw, list): raise DistributionError("env_requires must be a list") dist_owned_raw = data.get("distribution_owned") or [] if dist_owned_raw and not isinstance(dist_owned_raw, list): raise DistributionError("distribution_owned must be a list") return cls( name=name, version=_str(data, "version", "0.1.0"), description=_str(data, "description"), hermes_requires=_str(data, "hermes_requires"), author=_str(data, "author"), license=_str(data, "license"), env_requires=[EnvRequirement.from_dict(e) for e in env_raw], distribution_owned=[str(p).strip().strip("/") for p in dist_owned_raw if str(p).strip()], source=_str(data, "source"), installed_at=_str(data, "installed_at"), ) def to_dict(self) -> Dict[str, Any]: out: Dict[str, Any] = {"name": self.name, "version": self.version} # Key order is the on-disk YAML order (write_manifest uses sort_keys=False). optional = ( ("description", self.description), ("hermes_requires", self.hermes_requires), ("author", self.author), ("license", self.license), ("env_requires", [e.to_dict() for e in self.env_requires]), ("distribution_owned", self.distribution_owned), ("source", self.source), ("installed_at", self.installed_at), ) out.update((k, v) for k, v in optional if v) return out def read_manifest(profile_dir: Path) -> Optional[DistributionManifest]: """Return the manifest for *profile_dir*, or None if it isn't a distribution.""" mf_path = profile_dir / MANIFEST_FILENAME if not mf_path.is_file(): return None try: data = yaml.safe_load(mf_path.read_text(encoding="utf-8-sig")) except Exception as exc: raise DistributionError(f"Failed to parse {mf_path}: {exc}") from exc return DistributionManifest.from_dict(data or {}) def write_manifest(profile_dir: Path, manifest: DistributionManifest) -> Path: """Atomically write ``distribution.yaml``. A bare write_text() truncates before the dump lands and read_manifest() treats a missing/unparseable manifest as "not a distribution", so an interrupted install/update would silently demote the profile.""" mf_path = profile_dir / MANIFEST_FILENAME from utils import atomic_yaml_write # create_mode=0o644: with an explicit `distribution_owned` allowlist that omits # distribution.yaml, _copy_dist_payload reaches here with no manifest on disk. It is a # shareable descriptor, not a secret — don't leave it at mkstemp's 0600. An existing # file's mode is preserved. atomic_yaml_write(mf_path, manifest.to_dict(), sort_keys=False, default_flow_style=False, create_mode=0o644) return mf_path # Version check _VERSION_OP_RE = re.compile(r"^\s*(>=|<=|==|!=|>|<)\s*(.+?)\s*$") _VERSION_OPS = {">=": operator.ge, "<=": operator.le, "==": operator.eq, "!=": operator.ne, ">": operator.gt, "<": operator.lt} def _parse_semver(v: str) -> Tuple[int, int, int]: """major.minor.patch only; pre-release / build metadata ("0.12.0-rc1+abc") stripped.""" parts = re.split(r"[-+]", str(v).strip().lstrip("v"), 1)[0].split(".") parts += ["0"] * (3 - len(parts)) try: return int(parts[0]), int(parts[1]), int(parts[2]) except ValueError as exc: raise DistributionError(f"Unparseable version: {v!r}") from exc def check_hermes_requires(spec: str, current_version: str) -> None: """Raise DistributionError if ``current_version`` does not satisfy ``spec`` (bare version = ``>=``).""" if not spec or not spec.strip(): return m = _VERSION_OP_RE.match(spec) op, target = m.groups() if m else (">=", spec.strip()) if not _VERSION_OPS[op](_parse_semver(current_version), _parse_semver(target)): raise DistributionError(f"This distribution requires Hermes {op}{target}, but you have {current_version}.") def _env_template_from_manifest(manifest: DistributionManifest) -> str: """Generate a ``.env.template`` body from env_requires.""" lines = [ "# Environment variables required by this Hermes distribution.", "# Copy to `.env` and fill in your own values before running.", "", ] for req in manifest.env_requires: if req.description: lines.append(f"# {req.description}") default_val = req.default if req.default is not None else "" if req.required: lines += ["# (required)", f"{req.name}={default_val}", ""] else: lines += ["# (optional)", f"# {req.name}={default_val}", ""] return "\n".join(lines).rstrip() + "\n" # Source staging — git clone or local directory _GITHUB_SHORTHAND_RE = re.compile(r"^github\.com/[\w.-]+/[\w.-]+/?$") def _looks_like_git_url(s: str) -> bool: """Any http(s) URL is a git repo — git is the only remote transport (no tar.gz URLs).""" s = s.strip() return ( s.endswith(".git") or s.startswith(("git@", "ssh://", "git://", "http://", "https://")) or bool(_GITHUB_SHORTHAND_RE.match(s)) ) def _git_clone(url: str, dest: Path) -> None: if _GITHUB_SHORTHAND_RE.match(url): url = f"https://{url.rstrip('/')}" from hermes_cli.git_credentials import run_git_with_credential_fallback try: result = run_git_with_credential_fallback( ["git", "clone", "--depth", "1", url, str(dest)], url, env=noninteractive_git_env(), capture_output=True, text=True, encoding="utf-8", errors="replace", ) except FileNotFoundError as exc: raise DistributionError("git is required for git-URL installs") from exc if result.returncode != 0: raise DistributionError(f"git clone failed: {(result.stderr or '').strip()}") def _stage_source(source: str, workdir: Path) -> Tuple[Path, str]: """Resolve *source* to ``(staged_dir, provenance)``: git URLs are shallow-cloned into *workdir* (``.git`` removed); a local directory is used in place.""" src_str = source.strip() if _looks_like_git_url(src_str): staged, provenance = workdir / "clone", src_str _git_clone(src_str, staged) # Not ``ignore_errors``: a half-deleted ``.git`` (read-only objects on Windows) would # otherwise be copied into the profile as distribution content (#117184). rmtree_readonly(staged / ".git") missing = ( f"No {MANIFEST_FILENAME} at the root of {src_str!r}. " "This repository is not a Hermes profile distribution." ) elif (path_guess := Path(src_str).expanduser()).is_dir(): staged = path_guess.resolve() provenance = str(staged) missing = ( f"No {MANIFEST_FILENAME} in {path_guess}. " "A local-directory source must contain a distribution.yaml at its root." ) else: raise DistributionError( f"Cannot resolve distribution source: {source!r}. " "Expected a git URL (e.g. github.com/user/repo) or a local directory." ) if not (staged / MANIFEST_FILENAME).is_file(): raise DistributionError(missing) return staged, provenance def _reject_distribution_symlinks(staged: Path) -> None: """Reject symlinks before reading or copying distribution files.""" for entry in staged.rglob("*"): if not entry.is_symlink(): continue try: rel = entry.relative_to(staged) except ValueError: rel = entry raise DistributionError(f"Profile distributions cannot contain symlinks: {rel}") # Install @dataclass class InstallPlan: """Summary of what an install will do, surfaced for user confirmation.""" manifest: DistributionManifest staged_dir: Path provenance: str target_dir: Path existing: bool # True if target profile already exists (update path) preserves_config: bool = True has_cron: bool = False def _has_cron_jobs(staged: Path) -> bool: return staged.joinpath(*_CRON_STORE_REL).is_file() def plan_install(source: str, workdir: Path, override_name: Optional[str] = None) -> InstallPlan: """Stage *source* and produce a plan describing what install would do.""" from hermes_cli.profiles import _canon_valid, get_profile_dir from hermes_cli.version_info import get_version_info staged, provenance = _stage_source(source, workdir) _reject_distribution_symlinks(staged) manifest = read_manifest(staged) if manifest is None: raise DistributionError( f"No {MANIFEST_FILENAME} found at the distribution root — this source is not a Hermes distribution." ) check_hermes_requires(manifest.hermes_requires, get_version_info().base_version) # fail fast canon = _canon_valid(override_name or manifest.name) if canon == "default": raise DistributionError( "Cannot install a distribution as 'default' — that is the built-in " "root profile (~/.hermes). Pass --name to install under a new profile." ) manifest.name = canon manifest.source = provenance # Stamped once here so both fresh install and update propagate a fresh timestamp. manifest.installed_at = datetime.now(timezone.utc).isoformat(timespec="seconds") target_dir = get_profile_dir(canon) existing = target_dir.is_dir() return InstallPlan( manifest=manifest, staged_dir=staged, provenance=provenance, target_dir=target_dir, existing=existing, preserves_config=existing, has_cron=_has_cron_jobs(staged), ) def _owned_entries(staged: Path, manifest: DistributionManifest): """Yield ``(src, rel_parts)`` for every staged path the distribution owns.""" explicit_owned = [p for p in (p.strip().strip("/") for p in manifest.distribution_owned) if p] if not explicit_owned: # Legacy: no allowlist means the whole payload (minus USER_OWNED_EXCLUDE) is owned. # Do NOT narrow to DEFAULT_DIST_OWNED — existing distributions ship arbitrary extra # top-level paths without declaring them. for entry in staged.iterdir(): if entry.name not in USER_OWNED_EXCLUDE: yield entry, (entry.name,) return # Path-aware allowlist: copy exactly the declared paths. for rel in explicit_owned: try: rel_parts = tuple(normalize_archive_parts(rel)) except ValueError: continue if rel_parts[0] in USER_OWNED_EXCLUDE or _is_distribution_runtime_path(rel_parts): continue src = staged.joinpath(*rel_parts) if src.exists(): yield src, rel_parts def _remove_existing(path: Path) -> None: """Remove one destination entry without following a destination symlink.""" if path.is_dir() and not path.is_symlink(): shutil.rmtree(path) elif os.path.lexists(path): # Covers files, dangling/any symlinks, fifos and sockets alike. path.unlink() def _replace_entry(src: Path, dest: Path) -> None: """Replace *dest* with *src* wholesale so files retired upstream disappear and file<->directory transitions cannot raise or leave stale content behind.""" _remove_existing(dest) if src.is_dir(): shutil.copytree(src, dest) else: shutil.copy2(src, dest) def _shipped_cron_store(entries: List[Tuple[Path, Tuple[str, ...]]]) -> Optional[Path]: """Return the staged ``cron/jobs.json`` when the distribution owns it (via ``cron/`` or exactly).""" for src, rel_parts in entries: if rel_parts == _CRON_STORE_REL: return src if rel_parts == _CRON_STORE_REL[:1] and (src / _CRON_STORE_REL[1]).is_file(): return src / _CRON_STORE_REL[1] return None def _merge_cron_store(src: Path, home: Path) -> None: """Merge a distribution's cron store into profile *home* by job id; new jobs arrive paused. Nothing is written when a shipped job cannot be scheduled (unparseable schedule, past one-shot for a job the installer resumed); the error names the job.""" from cron import jobs as cron_jobs from cron.job_definition import import_job_definitions dest = home.joinpath(*_CRON_STORE_REL) try: with tempfile.TemporaryDirectory(prefix="hermes_dist_cron_") as tmp: staged_store = Path(tmp) / "cron" staged_store.mkdir() shutil.copy2(src, staged_store / "jobs.json") with cron_jobs.use_cron_store(tmp): shipped = { job["id"]: job for job in cron_jobs.load_jobs() if isinstance(job, dict) and job.get("id") } with cron_jobs.use_cron_store(home): import_job_definitions( shipped, paused_reason="Installed from a profile distribution; review it, then resume.") except (RuntimeError, ValueError) as exc: # RuntimeError: load_jobs on a corrupt/unreadable store; ValueError: a job-labelled # unschedulable definition. OSError propagates as-is like every other copy step. raise DistributionError(f"Could not merge cron jobs into {dest}: {exc}") from exc def _real_dir(base: Path, parts: Tuple[str, ...]) -> Path: """Return ``base/parts`` as a chain of real directories. A user could have swapped an ancestor for a file; writing through it is impossible, so a file is replaced by a real directory. A symlinked ancestor is refused rather than silently unlinked: it is deliberate user configuration (a shared skills dir, say) and writing through it would land the payload outside the profile.""" path = base for part in parts: path = path / part _refuse_symlink(path) if path.exists() and not path.is_dir(): _remove_existing(path) path.mkdir(exist_ok=True) return path def _refuse_symlink(path: Path) -> None: if path.is_symlink(): raise DistributionError( f"{path} is a symlink; refusing to replace it — remove the link " "(or replace it with a real directory) and re-run" ) def _is_container(path: Path, rel: Tuple[str, ...]) -> bool: """A container of roots, not a root itself. Under ``skills/`` that is a dir with no SKILL.md in it or above it (a category, whatever metadata it ships: DESCRIPTION.md, README.md, LICENSE; a dir inside a skill, like its ``scripts/``, belongs to that skill); elsewhere, a dir holding no files other than DESCRIPTION.md and dotfiles.""" if not path.is_dir(): return False if rel[0] == "skills": return not any((p / "SKILL.md").is_file() for p in (path, *path.parents[: len(rel) - 1])) return not any( p.is_file() and p.name != "DESCRIPTION.md" and not p.name.startswith(".") for p in path.iterdir() ) def _merge_dir(src: Path, dest: Path, rel: Tuple[str, ...]) -> None: """Merge authored roots while leaving runtime-owned nested state untouched.""" for child in src.iterdir(): parts = (*rel, child.name) if _is_distribution_runtime_path(parts): continue if parts == _CRON_STORE_REL: continue # merged up front by _copy_dist_payload if _is_container(child, parts): _merge_dir(child, _real_dir(dest, (child.name,)), parts) else: _replace_entry(child, dest / child.name) def _refuse_symlinked_containers(src: Path, dest: Path, rel: Tuple[str, ...]) -> None: for child in src.iterdir(): parts = (*rel, child.name) if _is_distribution_runtime_path(parts): continue if _is_container(child, parts): _refuse_symlink(dest / child.name) _refuse_symlinked_containers(child, dest / child.name, parts) def _merges_per_root(src: Path, rel_parts: Tuple[str, ...]) -> bool: """An owned top-level dir, or an owned container (``skills/research/``, see ``_is_container``), is merged per authored root instead of replaced whole, so skills the installer added to it (``hermes skills install`` and agent-created skills land in ``skills//``) survive. The pre-write symlink guard and the copy loop both use this, so the guard covers exactly what the copy merges.""" return src.is_dir() and (len(rel_parts) == 1 or _is_container(src, rel_parts)) def _refuse_symlinked_targets(target: Path, entries) -> None: """Refuse before the first write. The per-entry check in ``_real_dir`` fires mid-loop, after earlier entries were already replaced and before the manifest is rewritten, leaving a half-updated profile that fails identically on every retry.""" for src, rel_parts in entries: # Directories are walked as containers, so the whole chain must be real; # a file only needs a real parent chain (a symlinked file is unlinked, not followed). depth = len(rel_parts) if src.is_dir() else len(rel_parts) - 1 path = target for part in rel_parts[:depth]: path = path / part _refuse_symlink(path) if _merges_per_root(src, rel_parts): _refuse_symlinked_containers(src, path, rel_parts) def _copy_dist_payload(staged: Path, target: Path, manifest: DistributionManifest, preserve_config: bool) -> None: """Copy distribution-owned files (see ``_owned_entries``) from *staged* into *target*. User-owned paths are never touched. ``config.yaml`` is replaced only when ``preserve_config`` is False (fresh install / ``--force-config``). ``.env.template`` lands as ``.env.EXAMPLE`` so it never shadows a real ``.env``. A top-level owned directory, and an owned container (``_is_container``), is merged per authored root. ``cron/jobs.json`` is special: it is one multi-record runtime store, so shipped definitions merge by job id instead of replacing the file.""" target.mkdir(parents=True, exist_ok=True) entries = list(_owned_entries(staged, manifest)) _refuse_symlinked_targets(target, entries) # The cron merge runs first: it is the one step that can reject shipped content # (an unschedulable job), and rejecting before any file is replaced keeps the profile whole. cron_store = _shipped_cron_store(entries) if cron_store is not None: _real_dir(target, _CRON_STORE_REL[:-1]) _merge_cron_store(cron_store, target) for src, rel_parts in entries: if rel_parts == _CRON_STORE_REL: continue if len(rel_parts) == 1: name = rel_parts[0] if name == ENV_TEMPLATE_FILENAME: # _replace_entry unlinks first so copy2 cannot write through a symlinked .env.EXAMPLE. _replace_entry(src, target / ENV_EXAMPLE_FILENAME) continue if name == "config.yaml" and preserve_config and (target / "config.yaml").exists(): continue if _merges_per_root(src, rel_parts): _merge_dir(src, _real_dir(target, rel_parts), rel_parts) continue _replace_entry(src, _real_dir(target, rel_parts[:-1]) / rel_parts[-1]) # Emit .env.EXAMPLE from manifest if the staged tree didn't ship one if manifest.env_requires and not (target / ENV_EXAMPLE_FILENAME).exists(): (target / ENV_EXAMPLE_FILENAME).write_text(_env_template_from_manifest(manifest), encoding="utf-8") # Make sure the manifest on disk reflects resolved name + source write_manifest(target, manifest) # A shipped profile.yaml must not carry a backend-assigned role. if any(rel_parts == ("profile.yaml",) for _, rel_parts in entries): from hermes_cli.profiles import drop_profile_role drop_profile_role(target) def _bootstrap_user_dirs(target: Path) -> None: """Create the bootstrap dirs a fresh profile expects (same set as ``create_profile``).""" from hermes_cli.profiles import _PROFILE_DIRS for d in _PROFILE_DIRS: (target / d).mkdir(parents=True, exist_ok=True) def install_distribution( source: str, name: Optional[str] = None, force: bool = False, create_alias: bool = False ) -> InstallPlan: """Install a distribution from *source* into a new profile; returns the resolved plan. Use :func:`plan_install` first to preview + prompt.""" from hermes_cli.profiles import check_alias_collision, create_wrapper_script with tempfile.TemporaryDirectory(prefix="hermes_dist_install_") as tmp: plan = plan_install(source, Path(tmp), override_name=name) if plan.existing and not force: raise DistributionError( f"Profile '{plan.manifest.name}' already exists at {plan.target_dir}. " "Use `hermes profile update` to upgrade in place, or pass --force to overwrite." ) # Fresh install (or --force): config.yaml comes from the distribution. Roots the # payload does not ship are left alone either way, so --force keeps user skills. _bootstrap_user_dirs(plan.target_dir) _copy_dist_payload(plan.staged_dir, plan.target_dir, plan.manifest, preserve_config=False) if create_alias and check_alias_collision(plan.manifest.name) is None: create_wrapper_script(plan.manifest.name) return plan def _existing_profile(profile_name: str) -> Tuple[str, Path]: """Return ``(canonical_name, profile_dir)`` or raise if the profile doesn't exist.""" from hermes_cli.profiles import _existing_profile_dir try: return _existing_profile_dir(profile_name) except FileNotFoundError as exc: raise DistributionError(str(exc)) from exc def update_distribution(profile_name: str, force_config: bool = False) -> InstallPlan: """Re-pull from the installed manifest's ``source:`` and apply: dist-owned files overwritten, user data never touched, ``config.yaml`` preserved unless ``force_config``.""" canon, target = _existing_profile(profile_name) existing_manifest = read_manifest(target) if existing_manifest is None: raise DistributionError( f"Profile '{canon}' is not a distribution (no {MANIFEST_FILENAME}). " "Only profiles installed via `hermes profile install` can be updated." ) if not existing_manifest.source: raise DistributionError( f"Profile '{canon}' has no recorded source. Re-install with " "`hermes profile install --name {canon} --force`." ) with tempfile.TemporaryDirectory(prefix="hermes_dist_update_") as tmp: plan = plan_install(existing_manifest.source, Path(tmp), override_name=canon) plan.preserves_config = not force_config _copy_dist_payload(plan.staged_dir, plan.target_dir, plan.manifest, preserve_config=plan.preserves_config) return plan def describe_distribution(profile_name: str) -> Dict[str, Any]: """Return a structured view of a profile's distribution metadata ({} if not a distribution).""" manifest = read_manifest(_existing_profile(profile_name)[1]) return {} if manifest is None else manifest.to_dict()