docs: fix Microsoft.Foreign hits (e.g./i.e. -> for example/that is)
Substitutes 'for example' for 'e.g.' and 'that is' for 'i.e.' per Microsoft style, with no comma after the replacement -- this repo never puts a comma after e.g./i.e. either, so the substituted phrase matches that house style instead of vale's literal 'for example,' suggestion. Covers all 77 real hits (72 from the initial vale pass + 5 more of the same pattern found on a follow-up vale run). None of the flagged instances were sentence-initial, so there's no capitalization concern here. Verified via a fresh vale run: 0 remaining Microsoft.Foreign hits. Full accounting in /agents/iris/state/haiku-batches/foreign-report.md.
This commit is contained in:
iris
mara
parent
ff377b0dee
commit
4f2d1d281a
30 changed files with 80 additions and 80 deletions
|
|
@ -173,7 +173,7 @@ Create an issue
|
|||
* `--body <BODY>` — Inline body text
|
||||
* `--body-file <BODY_FILE>` — Read body from a file. `-` means stdin
|
||||
* `--assignee <ASSIGNEE>` — Initial assignee login
|
||||
* `--label <LABELS>` — Label name to attach, repeatable (e.g. `--label area/ops --label type/bug`). Same spelling `labels add` accepts. An unresolved name errors out (before the issue is created) rather than silently attaching fewer labels than asked for
|
||||
* `--label <LABELS>` — Label name to attach, repeatable (for example `--label area/ops --label type/bug`). Same spelling `labels add` accepts. An unresolved name errors out (before the issue is created) rather than silently attaching fewer labels than asked for
|
||||
|
||||
|
||||
|
||||
|
|
@ -401,7 +401,7 @@ List / add / remove emoji reactions on the issue, or on one of its comments with
|
|||
###### **Subcommands:**
|
||||
|
||||
* `list` — List reactions (default when no action is given)
|
||||
* `add` — Add a reaction — a Forgejo shortcode, e.g. `+1`, `heart`, `rocket`
|
||||
* `add` — Add a reaction — a Forgejo shortcode, for example `+1`, `heart`, `rocket`
|
||||
* `remove` — Remove your own reaction with this content
|
||||
|
||||
###### **Arguments:**
|
||||
|
|
@ -425,7 +425,7 @@ List reactions (default when no action is given)
|
|||
|
||||
## `hive-forge issue reaction add`
|
||||
|
||||
Add a reaction — a Forgejo shortcode, e.g. `+1`, `heart`, `rocket`
|
||||
Add a reaction — a Forgejo shortcode, for example `+1`, `heart`, `rocket`
|
||||
|
||||
**Usage:** `hive-forge issue reaction add <CONTENT>`
|
||||
|
||||
|
|
@ -540,7 +540,7 @@ Create a pull request
|
|||
* `--remote <REMOTE>` — Remote to push to (default: `forge`, or `origin` in `--agit` mode)
|
||||
* `--agit` — Open the PR via Forgejo's `AGit` flow instead of pushing a branch — works for read-only collaborators. Run from inside a cloned repo
|
||||
* `--topic <TOPIC>` — `AGit` topic — groups repeated pushes into one PR (re-run with the same topic to update it). Defaults to the branch name. Only meaningful with `--agit`
|
||||
* `--label <LABELS>` — Label name to attach, repeatable (e.g. `--label area/ops --label type/bug`). Same spelling `labels add` accepts — an unresolved name errors out rather than silently attaching fewer labels than asked for. In `--agit` mode this is applied as a follow-up call once the PR number is known (the `AGit` push itself has no label field), so it's silently skipped (not a label-resolution error) if the PR URL couldn't be parsed back out of the push output — same fallback as the deferred multi-line body
|
||||
* `--label <LABELS>` — Label name to attach, repeatable (for example `--label area/ops --label type/bug`). Same spelling `labels add` accepts — an unresolved name errors out rather than silently attaching fewer labels than asked for. In `--agit` mode this is applied as a follow-up call once the PR number is known (the `AGit` push itself has no label field), so it's silently skipped (not a label-resolution error) if the PR URL couldn't be parsed back out of the push output — same fallback as the deferred multi-line body
|
||||
|
||||
|
||||
|
||||
|
|
@ -860,7 +860,7 @@ List / add / remove emoji reactions on the PR, or on one of its comments with `-
|
|||
###### **Subcommands:**
|
||||
|
||||
* `list` — List reactions (default when no action is given)
|
||||
* `add` — Add a reaction — a Forgejo shortcode, e.g. `+1`, `heart`, `rocket`
|
||||
* `add` — Add a reaction — a Forgejo shortcode, for example `+1`, `heart`, `rocket`
|
||||
* `remove` — Remove your own reaction with this content
|
||||
|
||||
###### **Arguments:**
|
||||
|
|
@ -884,7 +884,7 @@ List reactions (default when no action is given)
|
|||
|
||||
## `hive-forge pr reaction add`
|
||||
|
||||
Add a reaction — a Forgejo shortcode, e.g. `+1`, `heart`, `rocket`
|
||||
Add a reaction — a Forgejo shortcode, for example `+1`, `heart`, `rocket`
|
||||
|
||||
**Usage:** `hive-forge pr reaction add <CONTENT>`
|
||||
|
||||
|
|
@ -962,7 +962,7 @@ Clone a forge repo (default `-r`/`HIVE_FORGE_REPO`) with credentials auto-inject
|
|||
|
||||
###### **Arguments:**
|
||||
|
||||
* `<DEST>` — Destination directory. Defaults to the repo's basename (e.g. `internal/knowledge` → `knowledge`)
|
||||
* `<DEST>` — Destination directory. Defaults to the repo's basename (for example `internal/knowledge` → `knowledge`)
|
||||
|
||||
###### **Options:**
|
||||
|
||||
|
|
@ -985,7 +985,7 @@ Create a forge repo under the current user (or `--org`). Prints the repo URL
|
|||
|
||||
* `--description <DESCRIPTION>` — Repository description
|
||||
* `--private` — Create the repo as private (default: public)
|
||||
* `--default-branch <DEFAULT_BRANCH>` — Default branch name (e.g. `main`). Only takes effect with `--auto-init`
|
||||
* `--default-branch <DEFAULT_BRANCH>` — Default branch name (for example `main`). Only takes effect with `--auto-init`
|
||||
* `--org <ORG>` — Create under this organisation instead of your own namespace
|
||||
* `--auto-init` — Seed an initial commit (README) so the repo is non-empty and can be cloned immediately. Omit to create a bare repo you push into
|
||||
|
||||
|
|
@ -1059,7 +1059,7 @@ Triage lint queries (unassigned / no-reviewer / stale-branches / assignments / u
|
|||
* `no-reviewer` — List PRs with no formally requested reviewer
|
||||
* `stale-branches` — List remote branches with no commits in N days, each with its merge outcome (skips branches that are heads of open PRs)
|
||||
* `assignments` — Group open issues + PRs by assignee
|
||||
* `unlabeled` — List issues/PRs with no exclusive scoped label in `--scope` (e.g. `--scope type` flags items missing any `type/*` label). Generic — the scope is whatever the repo's label taxonomy actually uses, nothing hardcoded here
|
||||
* `unlabeled` — List issues/PRs with no exclusive scoped label in `--scope` (for example `--scope type` flags items missing any `type/*` label). Generic — the scope is whatever the repo's label taxonomy actually uses, nothing hardcoded here
|
||||
|
||||
|
||||
|
||||
|
|
@ -1132,13 +1132,13 @@ Group open issues + PRs by assignee
|
|||
|
||||
## `hive-forge lint unlabeled`
|
||||
|
||||
List issues/PRs with no exclusive scoped label in `--scope` (e.g. `--scope type` flags items missing any `type/*` label). Generic — the scope is whatever the repo's label taxonomy actually uses, nothing hardcoded here
|
||||
List issues/PRs with no exclusive scoped label in `--scope` (for example `--scope type` flags items missing any `type/*` label). Generic — the scope is whatever the repo's label taxonomy actually uses, nothing hardcoded here
|
||||
|
||||
**Usage:** `hive-forge lint unlabeled [OPTIONS] --scope <SCOPE>`
|
||||
|
||||
###### **Options:**
|
||||
|
||||
* `--scope <SCOPE>` — Label scope to check for — the part of a scoped label's name before the `/` (e.g. `type` for `type/bug`, `type/feature`). Required: this command has no built-in notion of a repo's label taxonomy, so there's no sane default to fall back to
|
||||
* `--scope <SCOPE>` — Label scope to check for — the part of a scoped label's name before the `/` (for example `type` for `type/bug`, `type/feature`). Required: this command has no built-in notion of a repo's label taxonomy, so there's no sane default to fall back to
|
||||
* `--type <TYPE>` — Filter by item kind
|
||||
|
||||
Default value: `all`
|
||||
|
|
@ -1322,7 +1322,7 @@ Download an attachment by UUID or URL. Saves to a temp file and prints the path
|
|||
|
||||
###### **Options:**
|
||||
|
||||
* `-o`, `--output <OUTPUT>` — Output path. Defaults to `/tmp/forge-attachment-<uuid>`. Pass `-` to write raw bytes to stdout (e.g. for piping to an image viewer)
|
||||
* `-o`, `--output <OUTPUT>` — Output path. Defaults to `/tmp/forge-attachment-<uuid>`. Pass `-` to write raw bytes to stdout (for example for piping to an image viewer)
|
||||
|
||||
|
||||
|
||||
|
|
@ -1334,7 +1334,7 @@ Download a CI Actions artifact from a run (`<name> --run <n>`). Saves a zip, or
|
|||
|
||||
###### **Arguments:**
|
||||
|
||||
* `<NAME>` — Artifact name, as shown on the run page (e.g. `pr1ma-paper-pdf`)
|
||||
* `<NAME>` — Artifact name, as shown on the run page (for example `pr1ma-paper-pdf`)
|
||||
|
||||
###### **Options:**
|
||||
|
||||
|
|
@ -1387,7 +1387,7 @@ List CI Actions runs, newest first (`--workflow`, `--branch`, `--limit`, `--page
|
|||
|
||||
###### **Options:**
|
||||
|
||||
* `--workflow <WORKFLOW>` — Only runs of this workflow file (e.g. `ci.yml`)
|
||||
* `--workflow <WORKFLOW>` — Only runs of this workflow file (for example `ci.yml`)
|
||||
* `--branch <BRANCH>` — Only runs on this ref. A branch name (`main`, `damocles/foo`) or a PR (`#N`) is qualified for you; a `refs/…` value is used as given. An all-digit value is read as a PR number — to filter a branch literally named that, pass `refs/heads/<name>`
|
||||
* `--limit <LIMIT>` — How many runs to print (default 20)
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ markdown-docs > docs/tools/forge-cli.md`.
|
|||
**Kind-namespaced commands (preferred):** issue/PR operations are grouped
|
||||
under `issue` and `pr` parent commands — `hive-forge pr close 42`,
|
||||
`hive-forge issue create --title …`, `hive-forge pr status --pr 42`. The
|
||||
`pr <verb>` / `issue <verb>` forms validate the number's kind (e.g. `pr close`
|
||||
`pr <verb>` / `issue <verb>` forms validate the number's kind (for example `pr close`
|
||||
refuses an issue number, which the old generic `close` couldn't). Run
|
||||
`hive-forge pr --help` / `hive-forge issue --help` for the full subcommand
|
||||
list (show/create/edit/status/merge/reviews/commits/diff/view/comment/
|
||||
|
|
@ -141,7 +141,7 @@ distinct output shape — pick by what you need:
|
|||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| The full human view of one item — title, body, **and** every comment in order | `view <n>` | prose dump; **marks the thread read** (clears the read-before-comment guard). Top-level `view` auto-detects issue-or-PR by number; scoped `issue view <n>` / `pr view <n>` do the same when you already know the kind |
|
||||
| Just the structured metadata of one item (state, labels, assignees, head sha…) | `issue <n>` / `pr <n>` | JSON object |
|
||||
| Only the comments (skip the body), e.g. to catch up a long thread; for PRs, review bodies (approve/request-changes/comment summaries) are merged in too | `comments <n>` [`--tail N`] | comment + review-body list; **marks read** |
|
||||
| Only the comments (skip the body), for example to catch up a long thread; for PRs, review bodies (approve/request-changes/comment summaries) are merged in too | `comments <n>` [`--tail N`] | comment + review-body list; **marks read** |
|
||||
| One specific comment by its id | `comment-show <id>` | single comment |
|
||||
| The audit trail — closes, label/assignee changes, commit refs, merges (no comment bodies) | `timeline <n>` | event list |
|
||||
| The code change | `diff <n>` | unified diff |
|
||||
|
|
@ -257,7 +257,7 @@ to discover valid label names before triaging or to audit the label set.
|
|||
## Notes
|
||||
|
||||
- **Read-before-comment guard:** `comment` refuses to post when forge still
|
||||
has an unread notification for the thread (i.e. someone commented since you
|
||||
has an unread notification for the thread (that is someone commented since you
|
||||
last read it). This prevents accidentally replying to old activity without
|
||||
seeing the new context. Read the thread with `hive-forge view <n>` or
|
||||
`hive-forge comments <n>` (which mark the notification read and clear the
|
||||
|
|
|
|||
|
|
@ -209,7 +209,7 @@ Promote a matrix user to homeserver admin
|
|||
|
||||
###### **Arguments:**
|
||||
|
||||
* `<NAME>` — Matrix localpart of the user to promote (e.g. `argus`)
|
||||
* `<NAME>` — Matrix localpart of the user to promote (for example `argus`)
|
||||
|
||||
|
||||
|
||||
|
|
@ -223,7 +223,7 @@ Persists the new password so a later `create-user` can re-login.
|
|||
|
||||
###### **Arguments:**
|
||||
|
||||
* `<NAME>` — Matrix localpart of the account to reset (e.g. `argus`)
|
||||
* `<NAME>` — Matrix localpart of the account to reset (for example `argus`)
|
||||
|
||||
|
||||
|
||||
|
|
@ -360,7 +360,7 @@ Everything here targets a single named agent (`hivectl agent foo restart`, `hive
|
|||
|
||||
###### **Arguments:**
|
||||
|
||||
* `<NAME>` — Agent name (e.g. `damocles`, `iris`)
|
||||
* `<NAME>` — Agent name (for example `damocles`, `iris`)
|
||||
|
||||
|
||||
|
||||
|
|
@ -487,8 +487,8 @@ Replaces the agent's whole override entry rather than merging into it: any limit
|
|||
|
||||
###### **Options:**
|
||||
|
||||
* `--cpu-quota <CPU_QUOTA>` — systemd `CPUQuota=` value, e.g. `400%` (100% = one full core)
|
||||
* `--memory-max <MEMORY_MAX>` — systemd `MemoryMax=` value, e.g. `8G`, `50%`, or `infinity`
|
||||
* `--cpu-quota <CPU_QUOTA>` — systemd `CPUQuota=` value, for example `400%` (100% = one full core)
|
||||
* `--memory-max <MEMORY_MAX>` — systemd `MemoryMax=` value, for example `8G`, `50%`, or `infinity`
|
||||
* `--reset` — Drop all overrides — the agent returns to the hive-wide defaults. Required to clear limits, so that a `set-limits` with a forgotten value can't silently reset the agent
|
||||
|
||||
|
||||
|
|
@ -753,7 +753,7 @@ Generate this hive's WireGuard key (if absent) and print its public key plus the
|
|||
|
||||
###### **Options:**
|
||||
|
||||
* `--address <ADDRESS>` — This hive's mesh address (e.g. `10.42.0.1/32`) to bake into the printed snippet. Omit to get a placeholder you fill in
|
||||
* `--address <ADDRESS>` — This hive's mesh address (for example `10.42.0.1/32`) to bake into the printed snippet. Omit to get a placeholder you fill in
|
||||
|
||||
|
||||
|
||||
|
|
@ -770,8 +770,8 @@ Print the nix to add a peer hive to the mesh
|
|||
###### **Options:**
|
||||
|
||||
* `--pubkey <PUBKEY>` — Peer's WireGuard public key (from its `hivectl wg init`)
|
||||
* `--address <ADDRESS>` — Peer's mesh address (e.g. `10.42.0.2/32`)
|
||||
* `--endpoint <ENDPOINT>` — Peer's `host:port` endpoint (omit for a peer that only dials out, e.g. one behind NAT — it must set an endpoint pointing back here)
|
||||
* `--address <ADDRESS>` — Peer's mesh address (for example `10.42.0.2/32`)
|
||||
* `--endpoint <ENDPOINT>` — Peer's `host:port` endpoint (omit for a peer that only dials out, for example one behind NAT — it must set an endpoint pointing back here)
|
||||
|
||||
|
||||
|
||||
|
|
@ -793,7 +793,7 @@ Prints the nix a peer operator pastes into their swarm config to trust and reach
|
|||
|
||||
###### **Options:**
|
||||
|
||||
* `--wg-address <WG_ADDRESS>` — This hive's WireGuard mesh address (e.g. `10.42.0.1/32`), emitted as `wireguardAddress`. Omit when not running the mesh
|
||||
* `--wg-address <WG_ADDRESS>` — This hive's WireGuard mesh address (for example `10.42.0.1/32`), emitted as `wireguardAddress`. Omit when not running the mesh
|
||||
* `--wg-endpoint <WG_ENDPOINT>` — This hive's public WireGuard endpoint (`host:port`), emitted as `wireguardEndpoint`. Omit when peers dial in / no mesh
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -236,7 +236,7 @@ Bare `choom` starts a fresh blank session. `--resume <value>` passes
|
|||
through as `claude --resume <value>` to rejoin a prior session by its
|
||||
session id — the flag name deliberately matches the claude flag it maps
|
||||
to. (choom never uses claude's `--continue`: that's a bare flag that
|
||||
takes no argument and resumes the cwd's _latest_ session, i.e. the
|
||||
takes no argument and resumes the cwd's _latest_ session, that is the
|
||||
harness's; a value after it would be consumed as the first prompt,
|
||||
silently poking the live harness session.) A value is required when the
|
||||
flag is given. Either way choom never collides with the harness's live
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
Two tool groups govern agent lifecycle management and config changes.
|
||||
Both are scoped to **direct children only** (topology-enforced: the
|
||||
server rejects any name that's not a direct child of the calling
|
||||
agent per `topology.json`). Privileged agents (e.g. ruth) may operate
|
||||
agent per `topology.json`). Privileged agents (for example ruth) may operate
|
||||
on any sub-agent — the topology scope applies to all others.
|
||||
|
||||
## `lifecycle` tool group
|
||||
|
|
@ -60,7 +60,7 @@ Fails if a proposed config repo for `name` already exists.
|
|||
### `request_update_meta_inputs(inputs?, description?)`
|
||||
|
||||
Queue an approval to run `nix flake update [inputs...]` on the meta
|
||||
flake. Pass specific input names (e.g. `["bitburner-agent"]`) or omit
|
||||
flake. Pass specific input names (for example `["bitburner-agent"]`) or omit
|
||||
/ pass `[]` for all inputs. Returns immediately; the lock update runs
|
||||
on operator approval.
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ room you haven't read yet.
|
|||
`user_id` and return its room id **without sending anything**.
|
||||
Use the returned id with room-based tools (`send_message`,
|
||||
`send_file`, …) to deliver into a DM when `send_dm`'s body
|
||||
parameter is inconvenient (e.g. for file attachments)
|
||||
parameter is inconvenient (for example for file attachments)
|
||||
- `send_reply(room, event_id, body)` — threaded reply to a specific
|
||||
event
|
||||
- `send_reaction(room, event_id, key)` — react to a message with an
|
||||
|
|
@ -70,7 +70,7 @@ room you haven't read yet.
|
|||
## Multiple accounts
|
||||
|
||||
`hyperhive.matrixAccounts` (declared in `agent.nix`) gives an agent
|
||||
*additional* matrix identities beyond the hive-internal one — e.g. an
|
||||
*additional* matrix identities beyond the hive-internal one — for example an
|
||||
external-facing account alongside the internal one. Each entry is
|
||||
keyed by account name and specifies `tokenFile` (bearer token,
|
||||
provisioned out-of-band; basename must start with `matrix-token`),
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ Fetch recent journal lines for a sub-agent container. Useful for
|
|||
diagnosing MCP-registration failures, startup crashes, plugin install
|
||||
errors, or any harness issue you can't see from inside the container.
|
||||
|
||||
Pass the plain logical agent name (e.g. `"gui"`) — hive-c0re resolves
|
||||
Pass the plain logical agent name (for example `"gui"`) — hive-c0re resolves
|
||||
the machine name (`h-<name>`). `lines` defaults to 50, host-capped at 500.
|
||||
|
||||
## `read_host_journal` capability
|
||||
|
|
@ -76,17 +76,17 @@ Fetch recent lines from the **host** journal (requires
|
|||
outside your own container — infrastructure services, hive-c0re
|
||||
lifecycle events, or another container's boot log.
|
||||
|
||||
- `unit` — filter to a systemd unit (e.g. `hive-c0re.service`).
|
||||
- `unit` — filter to a systemd unit (for example `hive-c0re.service`).
|
||||
- `container` — nspawn machine name verbatim. Agent containers use
|
||||
the `h-<name>` prefix (e.g. `h-iris`); infrastructure containers
|
||||
use their full name (e.g. `hive-ci`, `hive-forge`, `hive-matrix`).
|
||||
the `h-<name>` prefix (for example `h-iris`); infrastructure containers
|
||||
use their full name (for example `hive-ci`, `hive-forge`, `hive-matrix`).
|
||||
Omit for the host journal. The gateway has no machine — its nginx
|
||||
runs on the host, so read it with `unit: nginx.service` and no
|
||||
`container`.
|
||||
- `lines` — how many lines to return (default 30, max 100).
|
||||
- `priority` — minimum syslog level (`emerg` … `debug`).
|
||||
- `grep` — regex matched against log message fields (`journalctl --grep`).
|
||||
- `since` / `until` — time bounds (e.g. `-1h`, `2024-01-01 12:00:00`).
|
||||
- `since` / `until` — time bounds (for example `-1h`, `2024-01-01 12:00:00`).
|
||||
|
||||
## See also
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ swarm-level operator CLI
|
|||
###### **Options:**
|
||||
|
||||
* `--authelia-bin <PATH>` — authelia binary used to hash passwords. The argon2 parameters must match the verifier's, so this has to be the *configured* package rather than whatever is on `PATH`
|
||||
* `--users-file <PATH>` — Host-side path of authelia's users database — i.e. the path inside the container, prefixed with the container's root.
|
||||
* `--users-file <PATH>` — Host-side path of authelia's users database — that is the path inside the container, prefixed with the container's root.
|
||||
|
||||
This is the only user store: it's read before every change and written in place, and `swarm-authelia-bridge` writes the same file.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue