Skip to content

docs(images): regenerate the init, up and doctor transcripts for the egress and endpoint changes - #529

Merged
edgehero merged 1 commit into
mainfrom
docs/images-503
Oct 2, 2026
Merged

edgehero merged 1 commit into
mainfrom
docs/images-503

Conversation

@edgehero

@edgehero edgehero commented Oct 2, 2026

Copy link
Copy Markdown
Owner

The init, up and doctor transcripts in the README were stale after #508 and #503. This regenerates them from the current CLI.

What changed per image

cli-init.svg: init now also reports model-endpoints.json and model-endpoints.conf.

cli-up.svg: the same two init lines. The egress proxy docker run now carries the third mount -v ./model-endpoints.conf:/etc/pi-dispatch/model-endpoints.conf:ro,z and --add-host host.docker.internal:host-gateway. The job image step reads as before after #525. The doctor checks are still folded into one counted line (25 checks: 23 ok, 2 warnings, no failures), followed by the ready verdict and the summary.

cli-doctor.svg: the third egress probe from #508 ("Egress policy refuses plain HTTP to a listed host off port 80"), the Valkey listener line, PI_LOGS_DIR and PI_SETTINGS_FILE in the service settings line, Docker Engine 29.1.3, and the jobs dir line for a dir the worker has not created yet. The second warning is now the gh login warning, because the capture host has no gh login (see the scenario below). The proxy health line is gone: a proxy started by up has no healthcheck, so doctor has nothing to report there.

The README cache busters for these three images move to ?v=2026-10-02. The up and doctor alt texts now name what the images show.

Unchanged: cli-service-windows.svg (the nssm render did not change in this round), the panel SVGs (no admin renderer changed in #513 to #527) and the PNG screenshots.

The renderer

The script that drew the 2.0.0 images lived in a scratch folder and was lost. It is rebuilt as launch/transcript-svg.mjs, with no dependencies. Given the text of the four 2.0.0 CLI SVGs, it reproduces each of them byte for byte. It wraps at 118 columns, or with --fit sizes the window to the longest line (init). --fold-doctor folds the doctor checks inside up into one counted line. A new section at the end of launch/demo.md lists the scenario, the sed that replaces the home path, and the render commands.

Scenario

Real output of this branch's CLI, captured on a Linux host with Docker Engine 29.1.3, as a throwaway account with uid 1000, in an empty folder. That account's home is replaced by ~ in the captured text. Nothing else was edited.

  • init and up ran in empty folders. For up, the account had a pi login holding a dummy Anthropic key, so the folded doctor ends ready.
  • doctor ran in the same folder after up. The pi login was removed and a dummy ANTHROPIC_API_KEY was set in .env. A github label trigger was added with flow fix and a skills dir holding one skill. gh is not logged in, so its warning shows.
  • No real credential was used anywhere.

Two lines contain an em dash ("both survive a reboot" in doctor, "already logged into pi? leave it blank" in up). Both are the CLI's own text, kept as printed.

Checks

Full suite in the CI posture: 5493 pass, 0 fail. The revision row check passes. No spec change.

…egress and endpoint changes

The three CLI transcripts were stale after the #508 and #503 round. init
now also writes model-endpoints.json and model-endpoints.conf. up starts
the egress proxy with a third mount for model-endpoints.conf and with
--add-host host.docker.internal:host-gateway. doctor has a third egress
probe, the plain HTTP refusal off port 80 (#508), and a Valkey listener
line.

Each transcript is real output of this tree's CLI, run on a Linux Docker
Engine 29.1.3 host as a throwaway account (uid 1000), in an empty folder,
with the home of that account shown as ~ (the sed is in launch/demo.md),
so the folder reads ~/pi-work. The key is a dummy and gh is not logged in, so
doctor shows the gh warning in place of the old scopes warning. In up the
25 doctor checks fold into one counted line (23 ok, 2 warnings, no
failures), as before.

The renderer that drew the old images was lost with a scratch folder. It
now lives in launch/transcript-svg.mjs. Fed the text of the 2.0.0 images
it gives them back byte for byte. launch/demo.md says how to capture and
render each image. cli-service-windows.svg is unchanged: the nssm render
did not change in this round. The panel images are unchanged too: no
admin renderer changed in #513 to #527.

The README cache busters for the three images move to 2026-10-02, and
the up and doctor alt texts name what the images now show.

No spec change: docs and maintainer tooling only. Spec IDs UNCHANGED,
checked: REQ-DEPLOYMENT-BOOTSTRAP and INT-EGRESS-POLICY-CONTRACT,
which these transcripts show, are not touched.

Signed-off-by: Rob Boerman <robboerman@live.nl>
@edgehero
edgehero merged commit caeb445 into main Oct 2, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant