Say host, not gateway or machine, in CLI output and user-facing field names

Open
  • Is something wrong?
#2,720 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript
Domain
cli, documentation

Research direction

Start with the named CLI entry points in src/core/cli/remote_commands.js and the help and notices for hyp leave, hyp privacy, and hyp ignore; also read src/core/mcp/instructions.js. Check how gateway_id appears in ai_gateway_messages and mint response JSON, then trace the docs references in TEAM_SETUP and CLI_REFERENCE for hyp remote mint. Done means user-facing output, help, field names, and MCP instructions use “host,” with the temporary docs notes removed.

Written by the indexing model from the issue text.

Description

The customer word for an enrolled computer is now host (Positioning Fundamentals v6.6, Section 10). The site and docs say host, and the dashboard already does (hyparam/hypscope#400). The CLI still shows the data model's names, so the docs have to flag literals instead of matching them.

What still says gateway or machine where a customer reads it:

  • hyp remote mint prints minted CI token for '<name>' (gateway <id>, expires ...) on stderr (src/core/cli/remote_commands.js, the detail line).
  • hyp remote login prints note: this replaced a ... gateway identity (was gateway <id>).
  • gateway_id is the field name in ai_gateway_messages and in the mint response JSON, so it shows in hyp query output and schema listings.
  • CLI help and notices say machine: hyp leave help ("Disconnects this machine"), the hyp remote login notices ("connects this machine to your team", "this machine is connected to ..."), and the hyp privacy / hyp ignore help ("machine-local"). The MCP instructions (src/core/mcp/instructions.js) say "for this machine".

Ask: rename or alias these so CLI output, help, and user-facing field names say host (for example host <id> in mint output, a host_id alias in query results). The internal record can keep its name.

Until this lands, the docs carry the line "shown as gateway in the current CLI output; this is the host record" next to the mint output (TEAM_SETUP, CLI_REFERENCE hyp remote mint). Remove those lines when the output changes. The docs pass is not fully closed until then.

Dominant language
JavaScript
Stars
11
Forks
0
Avg merge
2h 55m
Merged PRs (30d)
294

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from hyparam/hypaware

All issues in hyparam/hypaware

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.