steam-backlog-enforcer/DOCS-web-install.md
Krzysztof kuhy Rudnicki c9ae0bf0b1 Install by target, dry run and Valve Proton
The install job takes optional target (AppID, URL or name), dry_run
and valve_proton params. The target is resolved inside the games
allowed today (allowed_games plus approved exceptions) and refused
otherwise; the installer only gets the checked --appid. Dry run runs
the installer's --dry-run alone, so it is safe while a game runs. The
no-target picker now offers not-installed approved exceptions too.

Todo: 6ee260a4
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WzxdWZCxnNWLtpVwFLVk9w
2026-11-22 20:46:31 +01:00

30 lines
1.7 KiB
Markdown

# `install` job params and result
Part of the web control API ([DOCS-web-control-api.md](DOCS-web-control-api.md));
the TS mirror of the result is `InstallResultData` in `web/src/api/contract.ts`.
All three params are optional (`_command_params.PARAMS["install"]`):
- `target` (string): an AppID, a Steam URL (`…/app/<id>/…`) or a name, as
the installer's own `TARGET` argument. The job resolves it, never the
installer: inside the games allowed today, which are `allowed_games(state)`
plus the approved exceptions (named from the owned records). AppIDs and URLs
are parsed locally; names match exact title first, then substring (case
ignored), with no Steam search. Several matches → a `choice` prompt; no
match, or an id outside that set → the job fails (`locked`) and no
installer runs. The installer only ever gets the checked `--appid`.
Without `target`, the job offers every allowed game not yet fully
installed, approved exceptions included (`choice` when more than one).
- `dry_run` (bool): runs only `steam_installer.cli --appid <id> --dry-run`
and relays its report as `log` lines. No manifest is queued, Steam is not
closed, there is no `steam://` fallback, so it is allowed while a game runs.
An installer failure fails the job (`op_failed`).
- `valve_proton` (bool): passes `--valve-proton` to the installer.
The result `data` is `InstallResultData` `{app_id, dry_run,
fast_install_skipped}` once a game was chosen (else the assignment). The
installer closes Steam, so a real install while a game runs skips the fast
path (`_fast_install._refusal`) and Steam's own download starts:
`fast_install_skipped` is then `"game_running"`, and the UI paints the
`result.game-running` mark on the result (`result.dry-run` for a dry run).