# dsh-settings-search > Instant search for the DSH (Cordis) settings panel โ€” quickly locate settings pages and general settings items. [![npm version](https://img.shields.io/npm/v/@objectivex666/dsh-settings-search)](https://www.npmjs.com/package/@objectivex666/dsh-settings-search) [![license](https://img.shields.io/npm/l/@objectivex666/dsh-settings-search)](./LICENSE) [![node](https://img.shields.io/node/v/@objectivex666/dsh-settings-search)](https://nodejs.org) [![Awesome DSH Plugin](https://awesome-dsh-plugin.com/badge.svg)](https://awesome-dsh-plugin.com) [![Listed on dsh-plugin.org](https://dsh-plugin.org/badges/listed.svg)](https://dsh-plugin.org/plugins/objectivex666/dsh-settings-search) **English** ยท [ไธญๆ–‡](./README.md) --- ## Features - ๐Ÿ” **Live search** โ€” a search box in the settings panel filters every registered settings page (`settings.section`) and general item (`settings.general.item`) as you type. - ๐Ÿงฉ **Three search styles** โ€” choose the classic sidebar, window top bar, or popup search page. The choice is saved in the current browser. - โŒจ๏ธ **Search shortcut (v1.10.0)** โ€” focus the search box with `Ctrl+F` or `โŒ˜F` inside the settings panel. You can enable or disable it from the "Settings Search" page; disabling keeps the browser's default find behavior. - ๐Ÿค **Import DSH model config (v1.9.0)** โ€” import the Base URL and model name from DSH's current default model in the AI config section. For credential safety, the API key is never imported. - ๐ŸŽฏ **First-run onboarding (v1.9.0)** โ€” a welcome modal appears only the first time the settings panel opens after installation. It introduces the four search styles, pinyin/intent/AI hints, click-to-jump, and auto-indexing; there are no "Don't show again" or manual reopen buttons. - ๐Ÿ“‚ **In-page option search (v1.2.0)** โ€” search beyond pages and reach the specific options inside them: Plugins-page tabs (`settings.plugins.tab`), Web UI plugin cards (`web-ui.plugin.item`), general rows, and more, each shown with a "page โ€บ option" breadcrumb. - ๐Ÿ”ค **Pinyin association search (v1.5.0)** โ€” type initials (`sz`) or full pinyin (`shezhi`) to surface Chinese settings items; navigate with `โ†‘`/`โ†“`, confirm with `Enter`, dismiss with `Esc`, and matched text is highlighted. - ๐Ÿง  **Intent search (v1.6.0)** โ€” describe the goal in Chinese (e.g. ใ€Œๅคชไบฎไบ†ใ€ "too bright", ใ€Œๅญ—ๅคชๅฐใ€ "text too small") to surface matching settings without knowing their names, shown in a "You may want" group. - ๐Ÿค– **AI-assisted search** โ€” when nothing matches locally, your OpenAI-compatible, Anthropic, or local Ollama model understands your search intent and suggests settings. Off by default; configure it on the plugin's settings page. Ollama needs no API key. - ๐Ÿงพ **Logging & export (v1.7.0)** โ€” records key plugin actions, searches, and AI requests; export, copy, or clear them from the plugin's settings page for troubleshooting. API keys are never logged. - ๐Ÿงญ **Click-to-jump** โ€” selecting a result clicks the matching left-nav entry to open its section; for tab options it also opens the tab and flashes the target row. A manual-path hint appears if automatic navigation is not possible. - ๐ŸŒฑ **Auto-index on startup (v1.8.0)** โ€” the first time the settings panel opens, the plugin automatically visits every settings section, silently reads in-page options (e.g. "Enable Workshop card") into the search index, then restores your current section, so all section options are searchable without having to open each page manually. A "Importing section optionsโ€ฆ" hint shows under the search box and clears when done. - ๐Ÿ›  **Built-in settings page (v1.4.0)** โ€” a "Settings Search" page in the left navigation shows the current version and checks npm for a newer release on demand; when one exists it hands you a copy-ready `dsh plugin update` command. - ๐Ÿงญ **View release notes (v1.7.1)** โ€” the "Settings Search" page has a "View changelog" button next to "Check for updates"; it fetches the GitHub release notes and shows them inline, opening the release page if fetching fails. - ๐ŸŒ **i18n** โ€” built-in Chinese/English dictionaries that follow the DSH localization system and are easy to extend. - ๐ŸŽจ **Theme-aware** โ€” styled entirely with CSS variables, automatically following the DSH theme (light/dark). - โšก **Reactive** โ€” subscribes to settings entries being added, removed, or changed, and refreshes results automatically. --- ## Installation (command line) This plugin is a standard **DSH profile bundle**: once installed it wires itself into the settings panel โ€” no manual edits to any DSH configuration file. ### Prerequisites - **DeepSeek Harness (DSH)** โ€” any release that ships the web UI (`dsh web`). - **Node.js** >= 18 (LTS recommended). ### From npm (recommended) ```bash dsh plugin --profile web add @objectivex666/dsh-settings-search ``` ### From GitHub ```bash dsh plugin --profile web add github:objectivex666/dsh-settings-search ``` ### From a local checkout (development) ```bash dsh plugin --profile web add /path/to/dsh-settings-search ``` After installing, **restart DSH** (`dsh web`); the search box appears at the top of the settings panel. To uninstall: `dsh plugin --profile web remove @objectivex666/dsh-settings-search`. > For a non-`web` profile, replace `--profile web` with your profile name. --- ## Manual wiring (when not using the command line) Add the package to your profile's dependencies and declare it as a bundle layer (`dsh plugin add` does both for you): ```yaml # your profile's cordis.patch.yml (or pass it via --patch) - insert: - id: settings-search name: '@objectivex666/dsh-settings-search' ``` The package ships its own `cordis.patch.yml` (that exact content), which `dsh plugin add` applies automatically. --- ## Local Ollama (v1.11.0) Enable "AI-assisted search" on the Settings Search page and select "Ollama (local)" as the API type: - **Base URL**: defaults to `http://127.0.0.1:11434`; custom ports are supported. Accepts the root URL, `/api`, `/api/chat`, or `/v1`. - **Model**: enter the full name, including its tag, of an installed model. Use `ollama list` to see installed models. - **API key**: not required. Ollama requests never send an existing cloud API key. Save the configuration and use "Test API" to check connectivity. Ollama requests allow 120 seconds for cold starts; cancelling a search aborts the request. The plugin does not install or start Ollama, or download models. Prepare a running Ollama service and model yourself. Requests originate in the browser, so "local" means the browser's device, not a remote DSH server. For connection failures, check the service URL. For cross-origin failures, add the exact DSH page origin (for example `http://127.0.0.1:3080`) to Ollama's `OLLAMA_ORIGINS` and restart Ollama. Avoid unnecessary wildcard origins. Non-local URLs still require HTTPS. --- ## Package layout ``` lib/index.js Host half (no-op โ€” makes the package a valid Cordis plugin row) lib/client.js Browser half (search UI, __ModuleLoader__ format) cordis.patch.yml Composition patch: inserts the settings-search plugin row scripts/check.mjs Structural self-checks (npm test) scripts/ai.test.mjs Mock AI regression tests (no model execution) ``` ## Development ```bash npm test # structural checks and mocked Ollama / OpenAI / Anthropic regression tests ``` > Historical note: up to v1.1 the repo shipped `dsh-settings-search.js` (an > in-session `cordis_define` dynamic-plugin source). Because keeping it in > sync with the shipping package kept drifting silently, it was removed in > v1.4.1; retrieve it from git history (tag `v1.4.0`) if you need a reference. ## Feedback & contributions Issues are welcome โ€” please report bugs, suggest features, or ask questions in [GitHub Issues](https://github.com/objectivex666/dsh-settings-search/issues). Pull requests are equally welcome via [GitHub Pull Requests](https://github.com/objectivex666/dsh-settings-search/pulls). When submitting an issue, please include as much of the following as possible so we can locate and reproduce it: - **Problem description**: what you expected vs. what actually happened. - **Reproduction steps**: a step-by-step walkthrough, including the triggering keywords and the settings page involved. - **Logs**: export the recent search/runtime logs from the plugin's "Logging & export" page and paste them (API keys are never logged, so it is safe to share); include any console errors as well. - **Environment**: DSH version, Node.js version, plugin version (shown on the "Settings Search" page), OS, and browser. - **Screenshots / screen recording**: helpful for UI-related issues. ## Changelog & releases Every version bump keeps git tags and GitHub Releases in sync, with a bilingual body that lists both new features and fixes: - Update [CHANGELOG.md](./CHANGELOG.md) (Chinese) and [CHANGELOG.en.md](./CHANGELOG.en.md) (English), each with `### โœจ Features` and `### ๐Ÿ› Fixes` sections. - Bump the version in `package.json` and the README, then tag and push as `vX.Y.Z`; GitHub Actions publishes to npm (`npm-publish.yml`) and creates a bilingual GitHub Release (`release.yml`). - Preview the release body locally: `node scripts/release.mjs --version ` - Tag and publish for real: `node scripts/release.mjs --version --publish` (requires `gh` CLI, logged in) > Without `--publish` the script only validates and prints the release body; it does not create a tag, push, or release.