docs(install): explain saved status line choice
This commit is contained in:
1 parent
ee19c64beb
commit
3fcc2aa709
2 files changed
+9
-17
No files matched your search
@@ -30,7 +30,7 @@ Bash:
|
||||
## Quickstart
|
||||
|
||||
With the [requirements](#requirements) installed, clone the repository, build it, then install it.
|
||||
Stop if any command fails. Installation asks for the shell, client, CLI update, Flashbang, Qwen retrieval, and extension choices.
|
||||
Stop if any command fails. Installation asks for the shell, client, Flashbang, status line, Qwen retrieval, and extension choices.
|
||||
|
||||
PowerShell:
|
||||
|
||||
@@ -54,7 +54,7 @@ For an already-installed configuration, use Quickupdate instead.
|
||||
|
||||
## Quickupdate
|
||||
|
||||
Run these commands from the repository root. Quick reuses the shell, client, CLI update, Flashbang, retrieval, and extension choices from the last
|
||||
Run these commands from the repository root. Quick reuses the shell, client, Flashbang, status line, retrieval, and extension choices from the last
|
||||
successful installation or update without opening selection menus. Stop if any command fails.
|
||||
|
||||
PowerShell:
|
||||
@@ -218,19 +218,11 @@ Local Codex `model`, `model_reasoning_effort`, `plugins`, and `marketplaces` set
|
||||
other local settings are not generally merged. Dry runs still rebuild `generated/`, but do not modify installation destinations.
|
||||
|
||||
Selecting Codex also installs shared skills to `.agents/skills`. An interactive extension list includes plugins and
|
||||
Codex skills; unchecked extensions are skipped on installation. Normal runs also ask whether to update
|
||||
the selected client CLIs, enable Flashbang, and enable Qwen3 semantic retrieval. These choices are saved for Quickupdate.
|
||||
Disabling retrieval on a later update removes its setup-owned runtime and index. Dry runs preview
|
||||
changes without updating CLIs, extensions, or retrieval. See [Plugins](docs/plugins.md) for client-specific behavior.
|
||||
|
||||
Install also always asks `Uninstall Codex/Claude/Both and reinstall via npm?` (default no), scoped to whatever client
|
||||
was selected. This choice is independent of the "update selected agent CLIs" choice above, is never saved, and is not
|
||||
asked again by Quickupdate or by the update script. Answering yes uninstalls and reinstalls, per selected client, the
|
||||
matching CLI (`@openai/codex` for Codex, `@anthropic-ai/claude-code` for Claude) through `npm uninstall -g`
|
||||
followed by `npm install -g <package>@latest`, when that CLI is currently found as a global npm package. When it is
|
||||
not (for example, installed through a native installer or another package manager), that prior installation is left
|
||||
in place with a warning, and only a fresh `npm install -g` is run alongside it. Codex is skipped with a warning while
|
||||
`codex.exe` is running. A dry run never asks this question and never previews it, since the choice is not persisted.
|
||||
Codex skills; unchecked extensions are skipped on installation. Normal install and update ask whether to enable
|
||||
Flashbang, apply the custom status line, and enable Qwen3 semantic retrieval. Choices are saved for Quickupdate.
|
||||
The status line defaults to enabled to preserve existing behavior. Disabling it removes the custom client setting and,
|
||||
for Claude, the setup-owned status line script. Disabling retrieval on update removes its setup-owned runtime and index.
|
||||
Dry runs preview changes without updating extensions or retrieval. See [Plugins](docs/plugins.md) for client-specific behavior.
|
||||
|
||||
## Update Script
|
||||
|
||||
@@ -249,7 +241,7 @@ Bash:
|
||||
```
|
||||
|
||||
It accepts the same `-DryRun`/`--dry-run`, `-Client`/`--client`, and `-Shell`/`--shell` parameters as the
|
||||
installer, re-syncs every managed file, and lets you revise the CLI update, Flashbang, retrieval, and extension choices.
|
||||
installer, re-syncs every managed file, and lets you revise the status line, Flashbang, retrieval, and extension choices.
|
||||
Selected extensions are installed or updated. Deselection removes only extensions recorded as installed by this
|
||||
setup; pre-existing or manually installed extensions are retained. Quickupdate reuses the saved choices.
|
||||
|
||||
|
||||
+1
-1
@@ -18,7 +18,7 @@ On Windows, installation and update repair the known Caveman 1.0.0 hook launcher
|
||||
|
||||
[QMD](https://github.com/tobi/qmd) requires Node.js 22 or newer and `npm`. Selecting it installs `@tobilu/qmd` globally. Claude receives QMD's official `qmd@qmd` plugin; Codex can use the `qmd` CLI. Deselecting QMD removes setup-owned integrations and uninstalls the global package when the Codex-owned QMD record is removed.
|
||||
|
||||
Normal installation and update also ask whether to update the selected client CLIs, enable Flashbang, and enable the optional Qwen3-Embedding-0.6B semantic retrieval layer. Retrieval uses a per-user virtual environment and index and is invoked through the installed `server.py search` CLI, disabled by default. Quickupdate reuses the saved shell, client, CLI update, Flashbang, retrieval, and extension choices without opening menus. Disabling retrieval removes its setup-owned runtime and index. Only successful runs save selections; dry runs do not update CLIs, extensions, or retrieval.
|
||||
Normal installation and update ask whether to enable Flashbang, apply the custom status line, and enable the optional Qwen3-Embedding-0.6B semantic retrieval layer. Retrieval uses a per-user virtual environment and index and is invoked through the installed `server.py search` CLI, disabled by default. Quickupdate reuses the saved shell, client, status line, Flashbang, retrieval, and extension choices without opening menus. Disabling the status line removes its custom setting and setup-owned Claude script; disabling retrieval removes its setup-owned runtime and index. Only successful runs save selections; dry runs do not update extensions or retrieval. Install and update do not modify the Codex or Claude CLI installations.
|
||||
|
||||
The `server.py search`/`rebuild` CLI transparently reuses a background daemon (spawned automatically on first use per `--data-dir`) that keeps the embedding and reranking models loaded in memory, so only the first query after a cold start or an idle period pays the model-loading cost; every call falls back to loading the models directly in-process if the daemon cannot be reached or started. The daemon exits on its own after 30 minutes of inactivity. Indexing skips files larger than 512 KB and, per repository, stops after 2000 indexable files by default; set `SEMANTIC_RETRIEVAL_MAX_FILES` to raise that cap for larger monorepos. When the cap is reached, the CLI prints an explicit warning to stderr rather than silently omitting files.
|
||||
|
||||
|
||||
Reference in new issue
Block a user