From 5916ba5f3c5f156f9de5ea57030f026177da03a0 Mon Sep 17 00:00:00 2001 From: Hernan Alvarez Date: Sat, 17 Oct 2026 20:04:31 -0700 Subject: [PATCH 1/2] Docs: say host, not machine, for the enrolled computer Vocabulary pass per Positioning Fundamentals v6.6, Section 10. Defines host once on the overview and on Connect a host; headings and anchors follow (connect-a-host, disconnect-a-host, long-lived-headless-hosts). Where the mint output still prints gateway, the docs keep the literal and flag it (#2720). Co-Authored-By: Claude Opus 5.5 --- docs/CLI.md | 10 ++++----- docs/CLIENTS.md | 2 +- docs/CLI_REFERENCE.md | 32 ++++++++++++++------------- docs/CONFIGURATION.md | 4 ++-- docs/MCP.md | 2 +- docs/MCP_REFERENCE.md | 2 +- docs/PRIVACY.md | 42 ++++++++++++++++++------------------ docs/QUERYING.md | 8 +++---- docs/README.md | 4 ++-- docs/TEAM_SETUP.md | 39 +++++++++++++++++---------------- docs/TROUBLESHOOTING.md | 6 +++--- scripts/gen-mcp-reference.js | 2 +- 12 files changed, 78 insertions(+), 75 deletions(-) diff --git a/docs/CLI.md b/docs/CLI.md index 3880ae892..ba3593fda 100644 --- a/docs/CLI.md +++ b/docs/CLI.md @@ -24,8 +24,8 @@ hyp setup ``` Select **Sync to the cloud** to store your recordings on HypAware Cloud or -choose **Local only** to keep recordings on your machine. To change this later, -see [connect a machine](TEAM_SETUP.md#connect-a-machine). +choose **Local only** to keep recordings on your host. To change this later, +see [connect a host](TEAM_SETUP.md#connect-a-host). Setup then asks which AI clients to record, installs the background service, connects the clients you selected, and imports their supported session history. @@ -85,7 +85,7 @@ attention, with guidance to help resolve problems. For capture checks, see The daemon keeps capture and scheduled sync running after you close the terminal. Setup installs it as a per-user service. On macOS, its LaunchAgent runs while you are logged in. On Linux, its systemd user service requires user-session -support; see [headless deployment](TEAM_SETUP.md#long-lived-headless-machines) +support; see [headless deployment](TEAM_SETUP.md#long-lived-headless-hosts) for hosts that must keep running after logout. ```sh @@ -105,7 +105,7 @@ hyp setup ``` Select **Reconfigure** in the menu. HypAware preserves a centrally managed -configuration layer and changes only the choices this machine owns. +configuration layer and changes only the choices this host owns. For unattended replacements and configuration files, see [repeatable configuration](CONFIGURATION.md#make-a-repeatable-setup). @@ -163,7 +163,7 @@ detached, replacing `` with its name, such as `claude` or `codex`. ## Uninstall ```sh -hyp leave # if this machine is enrolled in Cloud +hyp leave # if this host is enrolled in Cloud hyp daemon uninstall npm uninstall -g hypaware ``` diff --git a/docs/CLIENTS.md b/docs/CLIENTS.md index 2d762ae89..937325a51 100644 --- a/docs/CLIENTS.md +++ b/docs/CLIENTS.md @@ -158,7 +158,7 @@ hyp client status ollama To add Ollama on an existing installation while preserving its export choice, run `hyp setup --source ollama` without `--export`. An explicit `--export` changes -that choice. Other clients are preserved; check `hyp status` to see your sinks. Recorded local inference can leave the machine through configured sinks. +that choice. Other clients are preserved; check `hyp status` to see your sinks. Recorded local inference can leave the host through configured sinks. Setup checks the service and model inventory without starting Ollama, downloading or loading a model, or sending inference. Missing executable, unavailable service and empty model inventory are separate results. SDK use does not need the CLI diff --git a/docs/CLI_REFERENCE.md b/docs/CLI_REFERENCE.md index 7a77c73ba..bf2382dd6 100644 --- a/docs/CLI_REFERENCE.md +++ b/docs/CLI_REFERENCE.md @@ -70,7 +70,7 @@ clients with scheduled recovery still import history. Neither flag applies to a preset. With no arguments and no output terminal, setup prints an agent guide on -stdout and exits `0` without configuring the machine. It lists detected +stdout and exits `0` without configuring the host. It lists detected sources, recording disclosures, choices and commands, browser sign-in handoffs, and verification. An agent asks the person before selecting sources or enabling cloud sync, then runs explicit unattended flags. `hyp setup @@ -497,9 +497,9 @@ hyp report list [--local] [--kind ] [--period ] [--limit ] [--b ``` Lists the newest reports visible to the selected organization, then this -machine's saved reports (`$HYP_HOME/reports`, as `hyp report save` leaves +host's saved reports (`$HYP_HOME/reports`, as `hyp report save` leaves them) in their own section, newest first by `report.md` mtime, at most 100 -with the rest counted. A machine with nothing saved prints no section. +with the rest counted. A host with nothing saved prints no section. `--local` prints the saved section alone, with no remote read, and takes none of the remote's selectors or filters. When nothing selects or filters the remote and it cannot be read, the saved reports are still listed under a @@ -727,7 +727,7 @@ hyp sync [instance] [--history ] [--yes] [--dry-run] Prints a destination and exclusion plan, confirms it, then forces the selected sink or every configured sink to export. `--dry-run` sends nothing. On a newly -enrolled machine, an interactive all-destination sync can release the +enrolled host, an interactive all-destination sync can release the first-sync review hold early. A single-instance sync can't release that hold. `--history ` is a separate mode: it previews and, after its own @@ -1352,7 +1352,7 @@ hyp privacy show . --json hyp privacy set sync|local-only|ignore ``` -Upserts an exact machine-local path marking. It doesn't write a dotfile or +Upserts an exact host-local path marking. It doesn't write a dotfile or delete rows. An `ignore` marking prints a line naming `hyp privacy purge --ignored`, which deletes what was already recorded in every ignored folder. @@ -1367,7 +1367,7 @@ hyp privacy set ./private-research local-only hyp privacy unset [sync|local-only|ignore] ``` -Removes machine-local entries governing the path. Add a class to remove only +Removes host-local entries governing the path. Add a class to remove only entries of that class. The operation is idempotent and doesn't delete rows. ```sh @@ -1380,7 +1380,7 @@ hyp privacy unset ./private-research local-only hyp privacy list [--json] ``` -Lists machine-local path and client policy plus the new-folder prompt +Lists host-local path and client policy plus the new-folder prompt preference. It can't globally enumerate `.hypignore` files; use `hyp privacy show PATH` for a specific path. @@ -1397,7 +1397,7 @@ hyp privacy ignore [path] Writes a shareable `.hypignore` file in an existing directory at the explicit path. With no path, uses the repository root, or the current directory when outside a repository. -Use `hyp privacy set sync|local-only|ignore` for machine-local markings +Use `hyp privacy set sync|local-only|ignore` for host-local markings and `hyp privacy show [path]` to report without writing. The receipt names `hyp privacy purge --ignored` to delete what was already recorded in ignored folders. @@ -1413,7 +1413,7 @@ hyp privacy unignore [path] ``` Removes the nearest governing `.hypignore`. Use `hyp privacy unset ` -to remove machine-local markings. It does not remove cached rows. +to remove host-local markings. It does not remove cached rows. ```sh hyp privacy unignore ./customer-data @@ -1455,7 +1455,7 @@ hyp privacy purge | --session [--remote | --local-only] | - ``` **Warning:** This operation permanently deletes matching rows from this -machine's local cache. Select exactly one target. Every form also sweeps the +host's local cache. Select exactly one target. Every form also sweeps the Claude raw-body spool so pending bodies can't recreate deleted rows. A terminal prompts for confirmation; a non-interactive call requires `--yes`. @@ -1543,7 +1543,7 @@ Installs the persistent launchd or systemd user service. When invoked from an ephemeral `npx` path, it installs a durable global package before it writes the service. `--force` allows the existing CLI path if that global installation fails; removing that directory later can break capture. `--dry-run` renders -the exact service definition without changing the machine; add `--json` for +the exact service definition without changing the host; add `--json` for structured plan output. ```sh @@ -1931,13 +1931,13 @@ hyp remote login [name] [--token-file ] [--org ] [--host