mirror of
https://github.com/baketnk/frame-yap.git
synced 2026-10-06 03:00:04 +02:00
installer: attended curl|sh flow prompts on the terminal and offers model/runtime steps
- A bare terminal invocation reads answers from the real terminal (/dev/tty when stdin is the curl pipe); piped data is never used as an answer and nothing prompts without a controlling terminal. - After the install choices it asks y/n separately for the speech model download and the pip runtime install, runs the chosen steps in order and stops at the first failure; equivalent flag commands are printed. - Opens with a one-line note that the user can Ctrl+C and read the script. - Drops the OpenVR autolaunch and --without-model questions from attended mode; the KDE desktop entry is the launch path. Flags are unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
e5b998eb6c
commit
e6cb07e8b8
5 files changed
+206
-50
No files matched your search
@@ -20,8 +20,9 @@ a separately provisioned compatible CPU Python environment and pinned weights.
|
||||
## OpenVR identity
|
||||
|
||||
`local.frameyap.overlay` is a string OpenVR application key, **not** a Steam
|
||||
store AppID. The installer creates a manifest/desktop launcher user-locally but
|
||||
does not register/launch the app by default. Explicit `frameyap --register
|
||||
store AppID. The installer creates a manifest and a desktop entry user-locally; the
|
||||
desktop entry (read by KDE's menu) is the intended launch path, and the app
|
||||
is not registered with SteamVR or launched by default. Explicit `frameyap --register
|
||||
/absolute/manifest/path` uses the OpenVR registration API; registration alone
|
||||
did not reveal a launcher in the first checked dashboard menu. On one Frame the
|
||||
user opened the panel from the **Non-Steam** section and quit; shortcut discovery
|
||||
@@ -57,8 +58,10 @@ already be available for registration; never start/restart it for installation.
|
||||
authorized runtime/model can be set in `paths.conf`.
|
||||
- **Noninteractive**: supply flags and `--yes` for network/model consent.
|
||||
`--print-plan` is read-only; `--json` provides structured results/errors and
|
||||
progress events for a model download. No prompt reads stdin in a pipe. An
|
||||
empty TTY invocation offers a local menu and prints equivalent flags.
|
||||
progress events for a model download. No prompt reads answers from a pipe.
|
||||
A bare terminal invocation, including `curl … | sh`, prompts on the real
|
||||
terminal (`/dev/tty`), asks y/n separately for the model and runtime
|
||||
downloads, and prints the equivalent flag commands.
|
||||
|
||||
Installation is user-local under XDG data/config paths with a managed launcher,
|
||||
retained rollback, SHA-256/path validation, foreign-file refusal and a lock
|
||||
|
||||
+13
-5
@@ -86,7 +86,7 @@ sh install.sh --archive /path/to/frameyap-VERSION-linux-aarch64.tar.gz \
|
||||
After an actual vetted release exists, use a real numeric version (for example,
|
||||
`sh install.sh --mode binary --version 0.1.202609241627 --yes`); the installer
|
||||
will retrieve tag `v0.1.202609241627` and its versioned checksum; no `latest` or moving-branch
|
||||
lookup. A pipe invocation is supported, never prompts on stdin, and must also
|
||||
lookup. A pipe invocation is supported, never reads answers from the pipe, and must also
|
||||
pin a real published tag. **There is no functional public download command yet.**
|
||||
|
||||
`--without-model` omits any model files in the selected archive, never deletes
|
||||
@@ -139,9 +139,17 @@ compiler, CMake, SDK, SDL3, Wayland/scanner, libxcb, FreeType, Vulkan developmen
|
||||
files and producer-supplied
|
||||
licenses; it still does not install Python ASR packages. `--print-plan` performs
|
||||
a read-only plan, `--json` gives machine-readable results/errors (model installs
|
||||
also stream file events), and `--yes` authorizes network downloads. Bare TTY
|
||||
invocation can guide choices and prints equivalent flags; non-TTY runs require
|
||||
explicit arguments and never prompt. `--autolaunch`/`--no-autolaunch` are explicit
|
||||
also stream file events), and `--yes` authorizes network downloads.
|
||||
A bare invocation with a terminal on stdout (including `curl … | sh`) runs
|
||||
the attended flow: it first notes that the user can press Ctrl+C and read the
|
||||
script, asks for the install choices, then separately asks y/n before the
|
||||
speech-model download (about 180 MB) and the pip runtime install, and runs the
|
||||
chosen steps in order, stopping at the first failure. Answers come from the real
|
||||
terminal (stdin if it is one, else `/dev/tty`); piped data is never read as an
|
||||
answer, and with no controlling terminal nothing prompts. It prints the
|
||||
equivalent flag commands for automation. Attended mode does not offer OpenVR
|
||||
registration: the desktop entry is the launch path.
|
||||
Runs with flags, or without a terminal, never prompt. `--autolaunch`/`--no-autolaunch` are explicit
|
||||
OpenVR registration choices, off by default; do not pass either during an inert
|
||||
install if a running SteamVR session must remain untouched.
|
||||
|
||||
@@ -188,7 +196,7 @@ Install root: `$XDG_DATA_HOME/frameyap` (default `~/.local/share/frameyap`);
|
||||
launcher: `~/.local/bin/frameyap`; desktop entry:
|
||||
`$XDG_DATA_HOME/applications/frameyap.desktop` (default
|
||||
`~/.local/share/applications/frameyap.desktop`). The desktop entry points to the
|
||||
user-local launcher; the installer never edits Steam's library or registers a
|
||||
user-local launcher and is the intended launch path (KDE's menu reads it); the installer never edits Steam's library or registers a
|
||||
Steam shortcut. Install/upgrade creates or checks `$XDG_CONFIG_HOME/frameyap/config.json`
|
||||
(default `~/.config/frameyap/config.json`), filling missing properties or repairing
|
||||
invalid JSON/values while preserving valid customization. Before each repair it
|
||||
|
||||
Reference in new issue
Block a user