Skip to content

fix(cli): clarify index update guidance #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
srobinson merged 1 commit into from
Jul 21, 2026
Merged

fix(cli): clarify index update guidance #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 25 additions & 9 deletions src/cli/error-handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import {
import {
type ConfigError,
type EmbeddingError,
type IndexCorruptedError,
isMdmError,
type MdmError,
} from '../errors/index.js'
Expand Down Expand Up @@ -116,6 +117,29 @@ const formatConfigError = (e: ConfigError): FormattedError => {
}
}

const formatIndexReadError = (e: IndexCorruptedError): FormattedError => {
if (e.reason === 'VersionMismatch') {
return {
code: e.code,
message: 'Index update required',
details: e.details,
suggestions: ["Run 'mdm index' to rebuild it with this version of mdm"],
exitCode: EXIT_CODE.USER_ERROR,
}
}

return {
code: e.code,
message: 'Index cannot be read',
details: e.details ?? `Reason: ${e.reason}`,
suggestions: [
'Keep the current index for recovery and use a fresh MDM_HOME',
"Run 'mdm index <source-path>' to rebuild from source",
],
exitCode: EXIT_CODE.USER_ERROR,
}
}

// ============================================================================
// Error Formatter
// ============================================================================
Expand Down Expand Up @@ -245,15 +269,7 @@ export const formatError = (error: MdmError): FormattedError =>
suggestions: ["Run 'mdm index' first to build the index"] as const,
exitCode: EXIT_CODE.USER_ERROR,
}),
IndexCorruptedError: (e) => ({
code: e.code,
message: 'Index is corrupted',
details: e.details ?? `Corruption reason: ${e.reason}`,
suggestions: [
"Delete the .mdm folder and run 'mdm index' again",
] as const,
exitCode: EXIT_CODE.USER_ERROR,
}),
IndexCorruptedError: (e) => formatIndexReadError(e),
IndexBuildError: (e) => ({
code: e.code,
message: `Failed to build index for: ${e.path}`,
Expand Down