diff --git a/README.md b/README.md index 44dc44f..15a6daf 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ into shell-specific packages that can be inspected before they are installed. ## Capability check -Check required tools, versions, repository files, and (by default) client/network access before setup. The command exits with an error when a requirement is missing. Use `--skip-external` or `-SkipExternal` only for an offline repository-only check. +Check the selected shell's minimum version and required Python and `jq` tools before setup. The command exits with an error when a requirement is missing. PowerShell: @@ -113,6 +113,8 @@ Install and update also rebuild internally; the explicit build above lets you ch - User-level plugin installation for Ponytail, i-have-adhd, Superpowers, Context7, Caveman, Humanizer, Impeccable, and Anthropic Frontend Design, with an interactive extension toggle during both install and update. Only extensions installed and recorded by this setup can be removed through deselection. +- Optional local semantic retrieval for both clients using Qwen3-Embedding-0.6B, disabled by default and removable + through the install/update choice. ## Architecture @@ -143,10 +145,8 @@ generated/ - PowerShell 5.1 or newer; PowerShell 7 is supported as well. - Bash 4.3 or newer, with standard utilities such as `awk`, `sed`, and `sha256sum`. - Python 3.11 or newer for configuration validation and task-state hooks/helpers (`python` for PowerShell scripts, `python3` for Bash scripts). -- Git for marketplace installation and branch display. External Codex skills are downloaded from their manifest sources. - `jq` for Claude's Bash status line; without it, that status line produces no output. -- The Codex and Claude Code CLIs for the clients that should be installed or diagnosed. -- Network access for plugin installation and updates. +- Python `venv` and `pip` when the optional semantic retrieval layer is enabled. The Bash scripts do not require PowerShell. The PowerShell scripts remain compatible with PowerShell 5.1; PowerShell 7 can also run them. @@ -215,8 +215,9 @@ not generally merged. Dry runs still rebuild `generated/`, but do not modify ins 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 and enable Flashbang. These choices are saved for Quickupdate. Dry runs preview changes -without updating CLIs or extensions. See [Plugins](docs/plugins.md) for client-specific behavior. +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, index, and MCP registrations. Dry runs preview +changes without updating CLIs, extensions, or retrieval. See [Plugins](docs/plugins.md) for client-specific behavior. ## Update diff --git a/docs/plugins.md b/docs/plugins.md index 2a277e9..22d2c5f 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -12,7 +12,7 @@ Codex's local `plugins` and `marketplaces` tables survive configuration synchron Codex receives Caveman through its native plugin adapter. Humanizer, Impeccable, and Anthropic Frontend Design are downloaded as skill payloads from the GitHub sources in the manifest, without running upstream installers. All three appear in the extension selector for Codex. Ownership is recorded in `~/.my-ai-configuration/extensions.json`. Skill files are tracked by hash; modified or foreign files are retained with a warning. Existing installations from before ownership tracking are not automatically adopted. -Normal installation and update also ask whether to update the selected client CLIs and enable Flashbang. Quickupdate reuses the saved shell, client, CLI update, Flashbang, and extension choices without opening menus. Only successful runs save selections; dry runs do not update CLIs or extensions. +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 is shared by Codex and Claude through a local MCP server, uses a per-user virtual environment and index, and is 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, index, and MCP registrations. Only successful runs save selections; dry runs do not update CLIs, extensions, or retrieval. Plugin installation requires the corresponding client CLI, network access, and any authentication required by the plugin. Context7 may open an OAuth flow. Codex or plugin hooks may require a trust review in `/hooks`. The scripts never install plugins during a build or doctor run and never install them when `--dry-run` or `-DryRun` is used.