ktx/packages/cli/src/cli-program.ts

386 lines
12 KiB
TypeScript
Raw Normal View History

2026-05-10 23:12:26 +02:00
import { Command, InvalidArgumentError } from '@commander-js/extra-typings';
2026-05-10 23:51:24 +02:00
import type { KtxCliDeps, KtxCliIo, KtxCliPackageInfo } from './cli-runtime.js';
2026-05-10 23:12:26 +02:00
import { registerConnectionCommands } from './commands/connection-commands.js';
import { registerIngestCommands } from './commands/ingest-commands.js';
2026-05-10 23:12:26 +02:00
import { registerWikiCommands } from './commands/knowledge-commands.js';
import { registerScanCommands } from './commands/scan-commands.js';
2026-05-10 23:12:26 +02:00
import { registerSetupCommands } from './commands/setup-commands.js';
import { registerSlCommands } from './commands/sl-commands.js';
import { registerStatusCommands } from './commands/status-commands.js';
import { registerDevCommands } from './dev.js';
2026-05-10 23:51:24 +02:00
import { findNearestKtxProjectDir, resolveKtxProjectDir } from './project-resolver.js';
2026-05-10 23:12:26 +02:00
import { profileMark, profileSpan } from './startup-profile.js';
profileMark('module:cli-program');
2026-05-10 23:51:24 +02:00
export interface KtxCliCommandContext {
io: KtxCliIo;
deps: KtxCliDeps;
feat: npm-managed Python runtime for @kaelio/ktx (#7) * docs: add npm managed python runtime design * build: add bundled python runtime wheel builder * build: make local embedding dependencies optional * build: bundle python runtime wheel in cli artifacts * build: track bundled python runtime release artifact * test: verify bundled python runtime wheel * docs: add plan for bundled python runtime wheel * test: cover managed python runtime lifecycle * feat: add managed python runtime installer * feat: add runtime command runner * feat: expose runtime management commands * test: verify managed python runtime commands * docs: add plan for managed python runtime installer * feat: add managed python command helper * feat: use managed runtime for sl query compute * feat: route sl query managed runtime policy * docs: add plan for managed runtime sl query integration * feat: add managed runtime daemon metadata * feat: manage python daemon lifecycle * feat: add runtime daemon start stop commands * fix: verify managed runtime daemon lifecycle * docs: add plan for managed runtime daemon lifecycle * feat: add managed local embeddings config marker * feat: add managed local embeddings daemon helper * feat: use managed runtime for local embedding setup * feat: pass managed runtime policy through setup * docs: add plan for managed local embeddings runtime * feat: read CLI package metadata dynamically * feat: assemble public kaelio ktx npm package * feat: release one public kaelio ktx npm artifact * test: cover public kaelio ktx package invocations * chore: verify public kaelio ktx package artifacts * docs: add plan for public kaelio ktx npm package * test: verify managed runtime in public package smoke * test: finalize managed runtime release smoke * docs: add plan for managed runtime release smoke * test: specify local embeddings release smoke * feat: add local embeddings runtime smoke * chore: register local embeddings smoke * fix: verify local embeddings smoke * fix: restore artifact smoke python env helper * docs: add plan for managed local embeddings release smoke * refactor: share managed runtime install policy parsing * feat: use managed runtime for agent semantic queries * feat: use managed runtime for MCP semantic compute * docs: add plan for managed agent and MCP semantic runtime * feat(cli): add managed daemon HTTP helpers * feat(cli): route local adapters through managed daemon * feat(cli): use managed daemon for ingest helpers * feat(cli): pass managed daemon options to scan * feat(context): pass MCP ingest pull config options * feat(cli): pass managed daemon options to serve ingest * test: verify managed local ingest daemon runtime * docs: add plan for managed local ingest daemon runtime * docs: align managed runtime examples * docs: add plan for managed runtime docs cleanup * test: cover published package runtime smoke commands * test: validate published package smoke outputs * docs: add plan for published package runtime smoke * build: stamp public npm package version * release: add npm public release policy * release: add guarded npm publish script * release: document public npm release handoff * docs: add plan for public npm release handoff * test: cover managed runtime prune in package smoke * docs: document managed runtime prune * docs: add plan for managed runtime prune smoke and docs * chore: encode uv runtime prerequisite policy * fix: clarify missing uv runtime error * docs: document uv runtime prerequisite * docs: add plan for uv runtime prerequisite contract * refactor: limit release artifacts to public package runtime * chore: align release policy with bundled runtime wheel * docs: describe single public runtime artifact surface * test: verify single public runtime artifact contract * docs: add plan for single public runtime artifact cleanup * fix: align local embeddings smoke with public version * docs: add plan for local embeddings smoke public version * release: soft-launch as @kaelio/ktx@0.1.0-rc.0 on next tag Publish target moves to the pre-release version 0.1.0-rc.0 under the next dist-tag so npm install @kaelio/ktx (which resolves to latest) does not pick up the soft-launch build. Users opt in via @kaelio/ktx@next. * Fix release script boundary checks * Remove PostHog from public package bundle
2026-05-11 15:50:34 +02:00
packageInfo: KtxCliPackageInfo;
2026-05-10 23:12:26 +02:00
setExitCode: (code: number) => void;
2026-05-10 23:51:24 +02:00
runInit: (args: { projectDir: string; projectName?: string; force: boolean }, io: KtxCliIo) => Promise<number>;
2026-05-10 23:12:26 +02:00
writeDebug?: (command: string, commandContext: CommandWithGlobalOptions) => void;
}
export interface OutputModeOptions {
plain?: boolean;
json?: boolean;
viz?: boolean;
input?: boolean;
}
2026-05-10 23:51:24 +02:00
interface KtxCommanderProgramOptions {
runInit: (args: { projectDir: string; projectName?: string; force: boolean }, io: KtxCliIo) => Promise<number>;
2026-05-10 23:12:26 +02:00
}
export interface BuildKtxProgramOptions {
io: KtxCliIo;
deps: KtxCliDeps;
packageInfo: KtxCliPackageInfo;
runInit: (args: { projectDir: string; projectName?: string; force: boolean }, io: KtxCliIo) => Promise<number>;
setExitCode?: (code: number) => void;
}
2026-05-10 23:12:26 +02:00
type CommanderExitLike = { exitCode: number; code: string; message: string };
2026-05-10 23:51:24 +02:00
interface KtxGlobalOptionValues {
2026-05-10 23:12:26 +02:00
projectDir?: string;
debug?: boolean;
}
2026-05-12 15:04:01 +02:00
type CommandPathNode = CommandWithGlobalOptions & {
name: () => string;
parent?: CommandPathNode | null;
};
const PROJECT_AWARE_ROOT_COMMANDS = new Set(['setup', 'connection', 'ingest', 'wiki', 'sl', 'status', 'scan']);
2026-05-12 15:04:01 +02:00
2026-05-10 23:12:26 +02:00
export interface CommandWithGlobalOptions {
opts: () => object;
optsWithGlobals?: () => object;
}
function isCommanderExit(error: unknown): error is CommanderExitLike {
return (
typeof error === 'object' &&
error !== null &&
'exitCode' in error &&
typeof (error as { exitCode: unknown }).exitCode === 'number' &&
'code' in error &&
typeof (error as { code: unknown }).code === 'string'
);
}
export function collectOption(value: string, previous: string[] = []): string[] {
return [...previous, value];
}
export function parsePositiveIntegerOption(value: string): number {
const parsed = Number(value);
if (!Number.isInteger(parsed) || parsed < 1) {
throw new InvalidArgumentError('must be a positive integer');
}
return parsed;
}
export function parseNonNegativeIntegerOption(value: string): number {
const parsed = Number(value);
if (!Number.isInteger(parsed) || parsed < 0) {
throw new InvalidArgumentError('must be a non-negative integer');
}
return parsed;
}
export function parseBooleanStringOption(value: string): boolean {
if (value === 'true') {
return true;
}
if (value === 'false') {
return false;
}
throw new InvalidArgumentError('must be true or false');
}
export function parseSafeConnectionIdOption(value: string): string {
if (!/^[a-zA-Z0-9][a-zA-Z0-9_-]*$/.test(value)) {
throw new InvalidArgumentError(`Unsafe connection id: ${value}`);
}
return value;
}
export function parseNonEmptyAssignmentOption(value: string): { key: string; value: string } {
const separatorIndex = value.indexOf('=');
if (separatorIndex <= 0 || separatorIndex === value.length - 1) {
throw new InvalidArgumentError('must be a non-empty <key>=<value> assignment');
}
return {
key: value.slice(0, separatorIndex),
value: value.slice(separatorIndex + 1),
};
}
2026-05-10 23:51:24 +02:00
function optionsWithGlobals(command: CommandWithGlobalOptions): KtxGlobalOptionValues {
2026-05-10 23:12:26 +02:00
const options = command.optsWithGlobals ? command.optsWithGlobals() : command.opts();
const values = options as { projectDir?: unknown; debug?: unknown };
return {
projectDir: typeof values.projectDir === 'string' ? values.projectDir : undefined,
debug: typeof values.debug === 'boolean' ? values.debug : undefined,
};
}
2026-05-12 15:04:01 +02:00
function commandOptions(command: CommandWithGlobalOptions): Record<string, unknown> {
return (command.optsWithGlobals ? command.optsWithGlobals() : command.opts()) as Record<string, unknown>;
}
function commandPath(command: CommandPathNode): string[] {
const path: string[] = [];
let current: CommandPathNode | null | undefined = command;
while (current) {
path.unshift(current.name());
current = current.parent;
}
return path;
}
function isProjectAwareCommand(path: string[]): boolean {
if (path.includes('__complete')) {
return false;
}
const rootCommand = path[1];
if (rootCommand === 'dev') {
return path[2] !== undefined && path[2] !== 'runtime';
2026-05-12 15:04:01 +02:00
}
return rootCommand !== undefined && PROJECT_AWARE_ROOT_COMMANDS.has(rootCommand);
}
function shouldSuppressProjectDirLine(path: string[], options: Record<string, unknown>): boolean {
2026-05-12 23:51:46 +02:00
const commandPathKey = path.join(' ');
if (commandPathKey === 'ktx dev init') {
return true;
}
2026-05-13 09:16:35 -07:00
if (commandPathKey === 'ktx setup') {
return true;
}
2026-05-12 23:51:46 +02:00
if (
commandPathKey === 'ktx status' &&
typeof options.projectDir !== 'string' &&
process.env.KTX_PROJECT_DIR === undefined &&
!findNearestKtxProjectDir(process.cwd())
) {
2026-05-12 15:04:01 +02:00
return true;
}
if (options.viz === true) {
return true;
}
if (commandPathKey === 'ktx ingest watch') {
return options.json !== true && options.plain !== true;
}
const demoIndex = path.indexOf('demo');
if (demoIndex >= 0) {
const demoCommand = path[demoIndex + 1];
return (
options.json !== true &&
options.plain !== true &&
(demoCommand === undefined || demoCommand === 'replay' || demoCommand === 'ingest')
);
}
return false;
}
function shouldPrintProjectDir(command: CommandPathNode): boolean {
const path = commandPath(command);
if (!isProjectAwareCommand(path)) {
return false;
}
const options = commandOptions(command);
if (options.json === true || options.output === 'json' || options.format === 'json') {
return false;
}
return !shouldSuppressProjectDirLine(path, options);
}
2026-05-10 23:12:26 +02:00
export function resolveCommandProjectDir(command: CommandWithGlobalOptions): string {
2026-05-10 23:51:24 +02:00
return resolveKtxProjectDir({ explicitProjectDir: optionsWithGlobals(command).projectDir });
2026-05-10 23:12:26 +02:00
}
export function resolveCommandProjectDirOverride(command: CommandWithGlobalOptions): string | undefined {
2026-05-10 23:51:24 +02:00
return optionsWithGlobals(command).projectDir ?? process.env.KTX_PROJECT_DIR;
2026-05-10 23:12:26 +02:00
}
2026-05-10 23:51:24 +02:00
function createBaseProgram(info: KtxCliPackageInfo, io: KtxCliIo): Command {
2026-05-10 23:12:26 +02:00
return new Command()
2026-05-10 23:51:24 +02:00
.name('ktx')
.description('KTX data agent context layer CLI')
2026-05-10 23:51:24 +02:00
.option('--project-dir <path>', 'KTX project directory (default: KTX_PROJECT_DIR, nearest ktx.yaml, or cwd)')
2026-05-10 23:12:26 +02:00
.option('--debug', 'Enable diagnostic logging to stderr')
.version(`${info.name} ${info.version}`, '-v, --version', 'Show CLI version')
.helpOption('-h, --help', 'Show this help text')
.configureHelp({ showGlobalOptions: true })
.addHelpText(
'after',
'\nAdvanced:\n ktx dev Low-level project initialization and runtime management.\n',
2026-05-10 23:12:26 +02:00
)
.showHelpAfterError()
.exitOverride()
.configureOutput({
writeOut: (chunk) => io.stdout.write(chunk),
writeErr: (chunk) => io.stderr.write(chunk),
outputError: (chunk, write) => write(chunk),
});
}
2026-05-10 23:51:24 +02:00
function writeDebug(io: KtxCliIo, commandContext: CommandWithGlobalOptions, command: string): void {
2026-05-10 23:12:26 +02:00
const global = optionsWithGlobals(commandContext);
if (global.debug !== true) {
return;
}
io.stderr.write(`[debug] projectDir=${resolveCommandProjectDir(commandContext)}\n`);
io.stderr.write(`[debug] dispatch=${command}\n`);
}
2026-05-12 15:04:01 +02:00
function writeProjectDir(io: KtxCliIo, commandContext: CommandPathNode): void {
if (!shouldPrintProjectDir(commandContext)) {
return;
}
io.stderr.write(`Project: ${resolveCommandProjectDir(commandContext)}\n`);
}
2026-05-10 23:12:26 +02:00
function formatCliError(error: unknown): string {
return error instanceof Error ? error.message : String(error);
}
async function runBareInteractiveCommand(
program: Command,
2026-05-10 23:51:24 +02:00
io: KtxCliIo,
context: KtxCliCommandContext,
2026-05-10 23:12:26 +02:00
): Promise<number> {
2026-05-10 23:51:24 +02:00
const nearestProjectDir = findNearestKtxProjectDir(process.cwd());
const envProjectDir = process.env.KTX_PROJECT_DIR;
const runner = context.deps.setup ?? (await import('./setup.js')).runKtxSetup;
2026-05-10 23:12:26 +02:00
if (!nearestProjectDir && !envProjectDir) {
return await runner(
{
command: 'run',
2026-05-10 23:51:24 +02:00
projectDir: resolveKtxProjectDir(),
2026-05-10 23:12:26 +02:00
mode: 'auto',
agents: false,
agentScope: 'project',
skipAgents: false,
inputMode: 'auto',
yes: false,
feat: npm-managed Python runtime for @kaelio/ktx (#7) * docs: add npm managed python runtime design * build: add bundled python runtime wheel builder * build: make local embedding dependencies optional * build: bundle python runtime wheel in cli artifacts * build: track bundled python runtime release artifact * test: verify bundled python runtime wheel * docs: add plan for bundled python runtime wheel * test: cover managed python runtime lifecycle * feat: add managed python runtime installer * feat: add runtime command runner * feat: expose runtime management commands * test: verify managed python runtime commands * docs: add plan for managed python runtime installer * feat: add managed python command helper * feat: use managed runtime for sl query compute * feat: route sl query managed runtime policy * docs: add plan for managed runtime sl query integration * feat: add managed runtime daemon metadata * feat: manage python daemon lifecycle * feat: add runtime daemon start stop commands * fix: verify managed runtime daemon lifecycle * docs: add plan for managed runtime daemon lifecycle * feat: add managed local embeddings config marker * feat: add managed local embeddings daemon helper * feat: use managed runtime for local embedding setup * feat: pass managed runtime policy through setup * docs: add plan for managed local embeddings runtime * feat: read CLI package metadata dynamically * feat: assemble public kaelio ktx npm package * feat: release one public kaelio ktx npm artifact * test: cover public kaelio ktx package invocations * chore: verify public kaelio ktx package artifacts * docs: add plan for public kaelio ktx npm package * test: verify managed runtime in public package smoke * test: finalize managed runtime release smoke * docs: add plan for managed runtime release smoke * test: specify local embeddings release smoke * feat: add local embeddings runtime smoke * chore: register local embeddings smoke * fix: verify local embeddings smoke * fix: restore artifact smoke python env helper * docs: add plan for managed local embeddings release smoke * refactor: share managed runtime install policy parsing * feat: use managed runtime for agent semantic queries * feat: use managed runtime for MCP semantic compute * docs: add plan for managed agent and MCP semantic runtime * feat(cli): add managed daemon HTTP helpers * feat(cli): route local adapters through managed daemon * feat(cli): use managed daemon for ingest helpers * feat(cli): pass managed daemon options to scan * feat(context): pass MCP ingest pull config options * feat(cli): pass managed daemon options to serve ingest * test: verify managed local ingest daemon runtime * docs: add plan for managed local ingest daemon runtime * docs: align managed runtime examples * docs: add plan for managed runtime docs cleanup * test: cover published package runtime smoke commands * test: validate published package smoke outputs * docs: add plan for published package runtime smoke * build: stamp public npm package version * release: add npm public release policy * release: add guarded npm publish script * release: document public npm release handoff * docs: add plan for public npm release handoff * test: cover managed runtime prune in package smoke * docs: document managed runtime prune * docs: add plan for managed runtime prune smoke and docs * chore: encode uv runtime prerequisite policy * fix: clarify missing uv runtime error * docs: document uv runtime prerequisite * docs: add plan for uv runtime prerequisite contract * refactor: limit release artifacts to public package runtime * chore: align release policy with bundled runtime wheel * docs: describe single public runtime artifact surface * test: verify single public runtime artifact contract * docs: add plan for single public runtime artifact cleanup * fix: align local embeddings smoke with public version * docs: add plan for local embeddings smoke public version * release: soft-launch as @kaelio/ktx@0.1.0-rc.0 on next tag Publish target moves to the pre-release version 0.1.0-rc.0 under the next dist-tag so npm install @kaelio/ktx (which resolves to latest) does not pick up the soft-launch build. Users opt in via @kaelio/ktx@next. * Fix release script boundary checks * Remove PostHog from public package bundle
2026-05-11 15:50:34 +02:00
cliVersion: context.packageInfo.version,
2026-05-10 23:12:26 +02:00
skipLlm: false,
skipEmbeddings: false,
databaseSchemas: [],
skipDatabases: false,
skipSources: false,
},
io,
);
}
program.outputHelp();
return 0;
}
export function buildKtxProgram(options: BuildKtxProgramOptions): Command {
const program = createBaseProgram(options.packageInfo, options.io);
program.hook('preAction', (_thisCommand, actionCommand) => {
writeProjectDir(options.io, actionCommand as CommandPathNode);
});
const context: KtxCliCommandContext = {
io: options.io,
deps: options.deps,
packageInfo: options.packageInfo,
setExitCode: options.setExitCode ?? (() => {}),
runInit: options.runInit,
writeDebug: (command: string, commandContext: CommandWithGlobalOptions) => {
writeDebug(options.io, commandContext, command);
},
};
registerSetupCommands(program, context);
registerConnectionCommands(program, context);
registerIngestCommands(program, context, {
runIngestWithProgress: async (ingestArgs, ingestIo, ingestDeps, defaultRunIngest) =>
await (ingestDeps.ingest ?? defaultRunIngest)(ingestArgs, ingestIo),
});
registerScanCommands(program, context);
registerWikiCommands(program, context);
registerSlCommands(program, context);
registerStatusCommands(program, context);
registerDevCommands(program, context);
return program;
}
2026-05-10 23:51:24 +02:00
export async function runCommanderKtxCli(
2026-05-10 23:12:26 +02:00
argv: string[],
2026-05-10 23:51:24 +02:00
io: KtxCliIo,
deps: KtxCliDeps,
info: KtxCliPackageInfo,
options: KtxCommanderProgramOptions,
2026-05-10 23:12:26 +02:00
): Promise<number> {
profileMark('commander:entry');
let exitCode = 0;
const program = buildKtxProgram({
io,
deps,
packageInfo: info,
runInit: options.runInit,
setExitCode: (code: number) => {
exitCode = code;
},
2026-05-12 15:04:01 +02:00
});
profileMark('commander:program-built');
2026-05-10 23:51:24 +02:00
const context: KtxCliCommandContext = {
2026-05-10 23:12:26 +02:00
io,
deps,
feat: npm-managed Python runtime for @kaelio/ktx (#7) * docs: add npm managed python runtime design * build: add bundled python runtime wheel builder * build: make local embedding dependencies optional * build: bundle python runtime wheel in cli artifacts * build: track bundled python runtime release artifact * test: verify bundled python runtime wheel * docs: add plan for bundled python runtime wheel * test: cover managed python runtime lifecycle * feat: add managed python runtime installer * feat: add runtime command runner * feat: expose runtime management commands * test: verify managed python runtime commands * docs: add plan for managed python runtime installer * feat: add managed python command helper * feat: use managed runtime for sl query compute * feat: route sl query managed runtime policy * docs: add plan for managed runtime sl query integration * feat: add managed runtime daemon metadata * feat: manage python daemon lifecycle * feat: add runtime daemon start stop commands * fix: verify managed runtime daemon lifecycle * docs: add plan for managed runtime daemon lifecycle * feat: add managed local embeddings config marker * feat: add managed local embeddings daemon helper * feat: use managed runtime for local embedding setup * feat: pass managed runtime policy through setup * docs: add plan for managed local embeddings runtime * feat: read CLI package metadata dynamically * feat: assemble public kaelio ktx npm package * feat: release one public kaelio ktx npm artifact * test: cover public kaelio ktx package invocations * chore: verify public kaelio ktx package artifacts * docs: add plan for public kaelio ktx npm package * test: verify managed runtime in public package smoke * test: finalize managed runtime release smoke * docs: add plan for managed runtime release smoke * test: specify local embeddings release smoke * feat: add local embeddings runtime smoke * chore: register local embeddings smoke * fix: verify local embeddings smoke * fix: restore artifact smoke python env helper * docs: add plan for managed local embeddings release smoke * refactor: share managed runtime install policy parsing * feat: use managed runtime for agent semantic queries * feat: use managed runtime for MCP semantic compute * docs: add plan for managed agent and MCP semantic runtime * feat(cli): add managed daemon HTTP helpers * feat(cli): route local adapters through managed daemon * feat(cli): use managed daemon for ingest helpers * feat(cli): pass managed daemon options to scan * feat(context): pass MCP ingest pull config options * feat(cli): pass managed daemon options to serve ingest * test: verify managed local ingest daemon runtime * docs: add plan for managed local ingest daemon runtime * docs: align managed runtime examples * docs: add plan for managed runtime docs cleanup * test: cover published package runtime smoke commands * test: validate published package smoke outputs * docs: add plan for published package runtime smoke * build: stamp public npm package version * release: add npm public release policy * release: add guarded npm publish script * release: document public npm release handoff * docs: add plan for public npm release handoff * test: cover managed runtime prune in package smoke * docs: document managed runtime prune * docs: add plan for managed runtime prune smoke and docs * chore: encode uv runtime prerequisite policy * fix: clarify missing uv runtime error * docs: document uv runtime prerequisite * docs: add plan for uv runtime prerequisite contract * refactor: limit release artifacts to public package runtime * chore: align release policy with bundled runtime wheel * docs: describe single public runtime artifact surface * test: verify single public runtime artifact contract * docs: add plan for single public runtime artifact cleanup * fix: align local embeddings smoke with public version * docs: add plan for local embeddings smoke public version * release: soft-launch as @kaelio/ktx@0.1.0-rc.0 on next tag Publish target moves to the pre-release version 0.1.0-rc.0 under the next dist-tag so npm install @kaelio/ktx (which resolves to latest) does not pick up the soft-launch build. Users opt in via @kaelio/ktx@next. * Fix release script boundary checks * Remove PostHog from public package bundle
2026-05-11 15:50:34 +02:00
packageInfo: info,
2026-05-10 23:12:26 +02:00
setExitCode: (code: number) => {
exitCode = code;
},
runInit: options.runInit,
writeDebug: (command: string, commandContext: CommandWithGlobalOptions) => {
writeDebug(io, commandContext, command);
},
};
if (argv.length === 0) {
if (io.stdout.isTTY === true) {
try {
return await runBareInteractiveCommand(program, io, context);
} catch (error) {
io.stderr.write(`${formatCliError(error)}\n`);
return 1;
}
}
program.outputHelp();
return 0;
}
try {
await profileSpan('commander:parseAsync', () => program.parseAsync(argv, { from: 'user' }));
} catch (error) {
if (isCommanderExit(error)) {
return error.exitCode === 0 ? 0 : 1;
}
io.stderr.write(`${formatCliError(error)}\n`);
return 1;
}
return exitCode;
}