feat(miyo): add customizable vault name setting (#2311)

* feat(miyo): add customizable vault name setting for Miyo indexing

Allows users to set a custom vault name that Miyo uses as the source ID
for indexing, instead of the auto-detected vault path. When changed while
Miyo is enabled, clears the old index and triggers a full re-index under
the new name. Includes guidance for remote/multi-device setups to use a
consistent vault name across devices.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix(miyo): compare resolved source IDs before clearing index on vault name change

Avoids unnecessary index clear and full re-index when the user types the
auto-detected vault path (the value that the blank field resolves to),
since the effective Miyo source ID is unchanged in that case.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix(miyo): prevent applying an empty vault name

The Apply button is hidden when the input is blank, and the handler
guards against an empty string, so users cannot accidentally clear
the vault name and submit it.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix(miyo): allow clearing vault name to restore auto-detected vault path

An empty vault name is valid — it falls back to the auto-detected vault
path as the Miyo source ID. Removes the empty-string guard so users can
clear a previously set name and revert to the default behaviour.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: wenzhengjiang

src/constants.ts

@@ -966,6 +966,7 @@ export const DEFAULT_SETTINGS: CopilotSettings = {
   selfHostUrl: "",
   selfHostApiKey: "",
   miyoServerUrl: "",
+  miyoVaultName: "",
   selfHostSearchProvider: "firecrawl",
   firecrawlApiKey: "",
   perplexityApiKey: "",

src/miyo/miyoUtils.ts

@@ -1,4 +1,4 @@
-import { CopilotSettings } from "@/settings/model";
+import { CopilotSettings, getSettings } from "@/settings/model";
 import { App, FileSystemAdapter } from "obsidian";
 
 /**
@@ -15,10 +15,36 @@ export function getMiyoCustomUrl(settings: CopilotSettings): string {
 /**
  * Resolve the Miyo source id for the current vault.
  *
+ * Uses the user-configured vault name when set, otherwise falls back to the
+ * vault filesystem path or vault name.
+ *
  * @param app - Obsidian application instance.
- * @returns Vault folder path when available, otherwise vault name.
+ * @returns Custom vault name when configured, vault folder path when available, otherwise vault name.
  */
 export function getMiyoSourceId(app: App): string {
+  const customName = (getSettings().miyoVaultName || "").trim();
+  if (customName) {
+    return customName;
+  }
+  const vaultPath = getVaultBasePath(app);
+  if (vaultPath) {
+    return vaultPath;
+  }
+  return app.vault.getName();
+}
+
+/**
+ * Resolve the Miyo source id that would apply if a given vault name override were saved.
+ *
+ * @param app - Obsidian application instance.
+ * @param vaultNameOverride - The vault name value to use (empty string = auto-detect).
+ * @returns Resolved source id string.
+ */
+export function resolveMiyoSourceId(app: App, vaultNameOverride: string): string {
+  const trimmed = vaultNameOverride.trim();
+  if (trimmed) {
+    return trimmed;
+  }
   const vaultPath = getVaultBasePath(app);
   if (vaultPath) {
     return vaultPath;

src/settings/model.ts

@@ -141,6 +141,8 @@ export interface CopilotSettings {
   selfHostApiKey: string;
   /** Custom Miyo server URL, e.g. "http://192.168.1.10:8742" (empty = use local service discovery) */
   miyoServerUrl: string;
+  /** Custom vault name for Miyo indexing (overrides auto-detected vault path/name) */
+  miyoVaultName: string;
   /** Which provider to use for self-host web search */
   selfHostSearchProvider: "firecrawl" | "perplexity";
   /** Firecrawl API key for self-host web search */
@@ -416,6 +418,11 @@ export function sanitizeSettings(settings: CopilotSettings): CopilotSettings {
     sanitizedSettings.enableMiyo = DEFAULT_SETTINGS.enableMiyo;
   }
 
+  // Ensure miyoVaultName has a default value
+  if (typeof sanitizedSettings.miyoVaultName !== "string") {
+    sanitizedSettings.miyoVaultName = DEFAULT_SETTINGS.miyoVaultName;
+  }
+
   // Ensure selfHostSearchProvider is a valid value
   const validSearchProviders = ["firecrawl", "perplexity"] as const;
   if (

src/settings/v2/components/CopilotPlusSettings.tsx

@@ -1,20 +1,28 @@
 import { ConfirmModal } from "@/components/modals/ConfirmModal";
 import { Badge } from "@/components/ui/badge";
 import { HelpTooltip } from "@/components/ui/help-tooltip";
+import { Input } from "@/components/ui/input";
 import { SettingItem } from "@/components/ui/setting-item";
 import { DEFAULT_SETTINGS } from "@/constants";
+import { logWarn } from "@/logger";
 import { MiyoClient } from "@/miyo/MiyoClient";
-import { getMiyoCustomUrl } from "@/miyo/miyoUtils";
+import { getMiyoCustomUrl, resolveMiyoSourceId } from "@/miyo/miyoUtils";
 import { useIsSelfHostEligible, validateSelfHostMode } from "@/plusUtils";
 import { updateSetting, useSettingsValue } from "@/settings/model";
 import { Notice } from "obsidian";
-import React, { useState } from "react";
+import React, { useEffect, useState } from "react";
 import { ToolSettingsSection } from "./ToolSettingsSection";
 
 export const CopilotPlusSettings: React.FC = () => {
   const settings = useSettingsValue();
   const [isValidatingSelfHost, setIsValidatingSelfHost] = useState(false);
   const isSelfHostEligible = useIsSelfHostEligible();
+  const [pendingVaultName, setPendingVaultName] = useState(settings.miyoVaultName || "");
+
+  // Keep local input in sync if settings change externally (e.g. settings reset)
+  useEffect(() => {
+    setPendingVaultName(settings.miyoVaultName || "");
+  }, [settings.miyoVaultName]);
 
   /**
    * Toggle self-host mode and handle validation requirements.
@@ -91,6 +99,60 @@ export const CopilotPlusSettings: React.FC = () => {
     ).open();
   };
 
+  /**
+   * Apply a vault name change for Miyo. When Miyo is enabled and the name actually changed,
+   * shows a confirmation modal warning that the existing Miyo index will be deleted and a
+   * full re-index will be triggered under the new name.
+   */
+  const handleVaultNameApply = async () => {
+    const newName = pendingVaultName.trim();
+    const oldName = (settings.miyoVaultName || "").trim();
+    if (newName === oldName) return;
+
+    // Compare resolved source IDs — if the user typed the auto-detected value
+    // (e.g. the vault path), the effective Miyo namespace is unchanged and we
+    // must not clear the existing index or trigger an unnecessary re-index.
+    const oldSourceId = resolveMiyoSourceId(app, oldName);
+    const newSourceId = resolveMiyoSourceId(app, newName);
+
+    if (!settings.enableMiyo || newSourceId === oldSourceId) {
+      // Miyo is off, or the effective source ID hasn't changed — save silently.
+      updateSetting("miyoVaultName", newName);
+      return;
+    }
+    const confirmChange = async () => {
+      try {
+        const miyoClient = new MiyoClient();
+        const baseUrl = await miyoClient.resolveBaseUrl(getMiyoCustomUrl(settings));
+        await miyoClient.clearIndex(baseUrl, oldSourceId);
+      } catch (e) {
+        logWarn("Failed to clear Miyo index for old vault name", e);
+      }
+
+      updateSetting("miyoVaultName", newName);
+
+      const VectorStoreManager = (await import("@/search/vectorStoreManager")).default;
+      await VectorStoreManager.getInstance().indexVaultToVectorStore(false, {
+        userInitiated: true,
+      });
+    };
+
+    const cancelChange = () => {
+      // Reset input back to the saved value if user cancels
+      setPendingVaultName(oldName);
+    };
+
+    new ConfirmModal(
+      app,
+      confirmChange,
+      `Changing the vault name will delete the existing Miyo index for "${oldSourceId || "(auto-detected)"}" and trigger a full re-index under the new name. This cannot be undone. Continue?`,
+      "Change Vault Name",
+      "Change & Re-index",
+      "Cancel",
+      cancelChange
+    ).open();
+  };
+
   return (
     <div className="tw-flex tw-flex-col tw-gap-4">
       <section className="tw-flex tw-flex-col tw-gap-4">
@@ -228,6 +290,40 @@ export const CopilotPlusSettings: React.FC = () => {
                     placeholder="http://127.0.0.1:8742"
                   />
 
+                  <SettingItem
+                    type="custom"
+                    title="Vault Name"
+                    description={
+                      <span>
+                        This is how Miyo identifies and remembers your vault&apos;s index — think of
+                        it as the unique label for all your indexed notes. Leave blank to use the
+                        auto-detected vault path. <strong>Set this before enabling Miyo.</strong> If
+                        you access Miyo from multiple devices or a remote server, use the same vault
+                        name on every device so they all share the same index.
+                      </span>
+                    }
+                  >
+                    <div className="tw-flex tw-items-center tw-gap-2">
+                      <Input
+                        value={pendingVaultName}
+                        onChange={(e) => setPendingVaultName(e.target.value)}
+                        onKeyDown={(e) => {
+                          if (e.key === "Enter") handleVaultNameApply();
+                        }}
+                        placeholder="Default: vault path"
+                        className="tw-w-full sm:tw-w-[200px]"
+                      />
+                      {pendingVaultName.trim() !== (settings.miyoVaultName || "").trim() && (
+                        <button
+                          onClick={handleVaultNameApply}
+                          className="tw-rounded-md tw-bg-interactive-accent tw-px-3 tw-py-1.5 tw-text-sm tw-font-medium tw-text-on-accent hover:tw-bg-interactive-accent-hover"
+                        >
+                          Apply
+                        </button>
+                      )}
+                    </div>
+                  </SettingItem>
+
                   <SettingItem
                     type="switch"
                     title="Enable Miyo"