Skip to content

docs(windows): the setup program is a real install route, so describe it (#1202) - #1212

Merged
gen16k merged 1 commit into
mainfrom
docs/1202-document-the-windows-setup-program
Sep 3, 2026
Merged

gen16k merged 1 commit into
mainfrom
docs/1202-document-the-windows-setup-program

Conversation

@gen16k

@gen16k gen16k commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

What this is about

WairedSetup-<version>-x64.exe is attached to every release and every edge
prerelease, and it is a full install path: it elevates, registers the service,
starts it, and turns on the Claude Code integration by default. docs.waired.ai
described one route — the iwr … | iex line — and until #1199 did not name the
setup program anywhere on the site.

Two things had already gone wrong because of that gap:

Fixes #1202
Refs #1181, #1199, waired-ai/waired#1312 (L96)

What the section says

One new section, ## Install with the setup program, between "Read the script
before running it" and "Skip the inference engine" — in the order a person
downloading it actually meets things:

  • where to get it, and why there is no latest/download/… shortcut (the
    filename carries the version);
  • Windows protected your PC and the way through it (More info → Run
    anyway
    ), and that the PowerShell line does not raise it — which is why the
    page still leads with that;
  • the permission prompt, for the reason already given above it on the page;
  • the wizard: it never asks where to install (-InstallDir is the PowerShell
    route's), and has one checkbox, under Claude Code integration:;
  • that it does not run waired init, so signing in is still ahead of you,
    plus the finish-page checkbox and the two Start Menu entries;
  • the log it always writes (SetupLogging=yes since installer/windows: the GUI installer does not report success when it installed nothing (#1181) #1199) — what you attach to
    a bug report;
  • in-place upgrade, and uninstall via Settings, including that
    %ProgramData%\waired is kept by default so a reinstall re-uses the device
    key;
  • the unattended switches, with exit 0 / exit 7, linking to the refusal
    section installer/windows: the GUI installer does not report success when it installed nothing (#1181) #1199 added.

The opening line moves from "Installing is one command." to "Installing is one
command — or a setup program you double-click", so the page does not contradict
its own new section.

The checkbox is described, not quoted. Its on-screen text still says the
integration "transparently falls back to the real Anthropic API", and #1198 is
retiring exactly that behaviour. Quoting it here would go stale the day that
lands; the repo rule is that a wording fix changes the product string and its
docs together, so this page does not pin a string that is already moving.

Also: the "What gets installed" table listed Waired as the only Start Menu
entry. Both installers create Waired and Waired (CLI)
(waired-setup.iss [Icons], install.ps1 New-StartMenuShortcuts), so the
row now says both.

Verification

  • Every fact checked against packaging/windows/waired-setup.iss
    (DisableDirPage=yes, SetupLogging=yes, the claudeproxy task and its
    group label, the finish-page description, exit 7 from PrepareToInstall, the
    uninstall prompt defaulting to No, UninstallSilent keeping state) and
    packaging/windows/README.md §"Code signing (deferred)" for the SmartScreen
    wording.
  • npm run i18n:check: 32 pairs, all in sync; the ja mirror keeps the same
    headings and fenced blocks.
  • astro build was not run locally (no node_modules in this checkout); the
    docs-site build job on this PR is the check.

Not in scope

Screenshots of the wizard, and a page of its own. If the setup program becomes
a route we recommend rather than tolerate, that is the moment for both — and it
is gated on signing (waired#759), which is also what would remove the
SmartScreen paragraph.

🤖 Generated with Claude Code

https://claude.ai/code/session_0172JQqxQSWDFbQauMDuCbJ2

… it (#1202)

`WairedSetup-<version>-x64.exe` is attached to every release and every
edge prerelease, and it is a full install path: it elevates, registers
the service, starts it, and turns on the Claude Code integration by
default. docs.waired.ai described one route, the `iwr … | iex` line, and
until #1199 did not name the setup program anywhere.

The gap was not only cosmetic. packaging/windows/ sat outside
docs-surface-guard's surface list until #1199 added it, so the GUI
installer's behaviour could change with no docs page obliged to keep up
— which is how getting-started/update.mdx came to promise a fresh-install
behaviour only install.ps1 had. The release notes have also been telling
people to "see SmartScreen note in docs" for a note that was not there.

The new section covers what a person who downloads it actually meets, in
order: no `latest/download/…` shortcut because the filename carries the
version; "Windows protected your PC" and the way through it, which is
why this page still leads with the PowerShell line; the permission
prompt; a wizard that does not ask where to install and has one
checkbox; that it does not run `waired init`, so signing in is still
ahead of you; the log it always writes; in-place upgrade and uninstall,
including that the state directory is kept by default; and the
unattended switches with exit 0 / exit 7.

The checkbox is described rather than quoted: its on-screen text is
being rewritten by the auto-route retirement in flight, and a verbatim
quote here would go stale the day that lands.

Also widen the "What gets installed" Start Menu row: both installers
create **Waired** and **Waired (CLI)**, and the table listed one.

Fixes #1202
Refs #1181, #1199, waired-ai/waired#1312

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0172JQqxQSWDFbQauMDuCbJ2
Signed-off-by: gen16k <gen16k@users.noreply.github.com>
@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown

📘 Docs preview — the preview channel for this PR has been deleted now that it is closed.

@gen16k
gen16k merged commit 09273a9 into main Sep 3, 2026
20 checks passed
@gen16k
gen16k deleted the docs/1202-document-the-windows-setup-program branch September 3, 2026 18:48
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.

docs: the Windows setup program (WairedSetup) is shipped on every release and documented nowhere

1 participant