Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
import { existsSync } from 'node:fs';
import { homedir } from 'node:os';
import { join, resolve } from 'node:path';
import { currentCliCommandName, OK_USER_HOME_AUTH_FILE } from '@inkeep/open-knowledge-core';
import { isHomeDir } from '@inkeep/open-knowledge-server';
import { Command } from 'commander';
import { getInvocationCwd } from '../project-anchor.ts';
import { accent, dim, error as errorColor, warning } from '../ui/colors.ts';
import { confirmDestructive } from '../ui/confirm.ts';
import {
buildDeinitPlan,
describeAttachedClients,
type RunRemovalDeps,
runRemoval,
} from './removal-plan.ts';
import {
formatRemovalOutcome,
formatRemovalPlan,
removalOutcomeToJson,
removalPlanToJson,
} from './removal-render.ts';
export interface DeinitOptions {
cwd?: string;
home?: string;
env?: NodeJS.ProcessEnv;
yes?: boolean;
dryRun?: boolean;
json?: boolean;
confirmStream?: NodeJS.ReadableStream;
probeClients?: (lockDir: string) => Promise<number | null>;
runRemovalDeps?: RunRemovalDeps;
}
export interface DeinitResult {
status: 'no-op' | 'dry-run' | 'cancelled' | 'done' | 'failed';
message: string;
exitCode: number;
}
export async function runDeinit(opts: DeinitOptions = {}): Promise<DeinitResult> {
const projectRoot = resolve(opts.cwd ?? process.cwd());
const home = opts.home ?? homedir();
if (isHomeDir(projectRoot, home)) {
return {
status: 'failed',
message:
`${errorColor('Refusing to deinit your home directory.')}\n` +
` ${projectRoot}/.ok is OpenKnowledge's user-global directory (global.yml, skills/,\n` +
` ${OK_USER_HOME_AUTH_FILE}), not a project. Removing it would delete your global settings and skills.\n` +
` To remove OpenKnowledge everywhere, use '${currentCliCommandName()} uninstall'.`,
exitCode: 64,
};
}
if (!existsSync(join(projectRoot, '.ok'))) {
return {
status: 'no-op',
message: dim(`No OpenKnowledge project found at ${projectRoot}. Nothing to remove.`),
exitCode: 0,
};
}
const plan = buildDeinitPlan(projectRoot, home);
const attached = await describeAttachedClients(plan, opts.probeClients);
const attachedBlock =
attached.length > 0 ? `\n\n${attached.map((l) => warning(l)).join('\n')}` : '';
if (opts.dryRun) {
return {
status: 'dry-run',
message: opts.json
? JSON.stringify(removalPlanToJson(plan, attached), null, 2)
: `${accent('Would remove (dry-run — no changes made):')}\n\n${formatRemovalPlan(plan)}${attachedBlock}`,
exitCode: 0,
};
}
if (opts.json && !opts.yes) {
return {
status: 'failed',
message: `${errorColor('Error:')} --json requires --yes (or --dry-run) so there is no interactive prompt.`,
exitCode: 1,
};
}
if (!opts.yes) {
process.stderr.write(
`${accent(`Remove OpenKnowledge from ${projectRoot}:`)}\n\n${formatRemovalPlan(plan)}${attachedBlock}\n\n`,
);
const confirmed = await confirmDestructive(
`${accent('Remove these?')} ${dim('[y/N] ')}`,
opts.confirmStream,
);
if (!confirmed) {
return { status: 'cancelled', message: dim('Cancelled.'), exitCode: 0 };
}
}
const outcome = await runRemoval(plan, {
env: opts.env ?? (opts.home === undefined ? process.env : {}),
...opts.runRemovalDeps,
});
return {
status: outcome.failed.length > 0 ? 'failed' : 'done',
message: opts.json
? JSON.stringify(removalOutcomeToJson('deinit', outcome, attached), null, 2)
: formatRemovalOutcome(outcome),
exitCode: outcome.failed.length > 0 ? 1 : 0,
};
}
export function deinitCommand(): Command {
return new Command('deinit')
.description(
`Remove OpenKnowledge from this project (its .ok/, editor MCP entries, git-exclude lines, shadow repo) while leaving your markdown content untouched. Re-run \`${currentCliCommandName()} start\` to re-scaffold.`,
)
.argument(
'[path]',
'Project directory, relative to where you run the command (defaults to the enclosing project)',
)
.option('-y, --yes', 'Skip the confirmation prompt')
.option('--dry-run', 'Print the removal plan and exit without changing anything')
.option('--json', 'Emit a machine-readable plan/outcome (requires --yes or --dry-run)')
.action(
async (
pathArg: string | undefined,
options: { yes?: boolean; dryRun?: boolean; json?: boolean },
) => {
const cwd = pathArg === undefined ? process.cwd() : resolve(getInvocationCwd(), pathArg);
if (pathArg !== undefined) {
process.stderr.write(`[ok] Deinit target: ${cwd}\n`);
}
const result = await runDeinit({
cwd,
yes: options.yes,
dryRun: options.dryRun,
json: options.json,
});
process.stdout.write(`${result.message}\n`);
if (result.exitCode !== 0) process.exitCode = result.exitCode;
},
);
}