mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-10 08:05:14 +02:00
* 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
275 lines
8.7 KiB
TypeScript
275 lines
8.7 KiB
TypeScript
import { Command, InvalidArgumentError } from '@commander-js/extra-typings';
|
|
import type { KtxCliDeps, KtxCliIo, KtxCliPackageInfo } from './cli-runtime.js';
|
|
import { registerAgentCommands } from './commands/agent-commands.js';
|
|
import { registerConnectionCommands } from './commands/connection-commands.js';
|
|
import { registerWikiCommands } from './commands/knowledge-commands.js';
|
|
import { registerPublicIngestCommands } from './commands/public-ingest-commands.js';
|
|
import { registerRuntimeCommands } from './commands/runtime-commands.js';
|
|
import { registerServeCommands } from './commands/serve-commands.js';
|
|
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';
|
|
import { findNearestKtxProjectDir, resolveKtxProjectDir } from './project-resolver.js';
|
|
import { profileMark, profileSpan } from './startup-profile.js';
|
|
|
|
profileMark('module:cli-program');
|
|
|
|
export interface KtxCliCommandContext {
|
|
io: KtxCliIo;
|
|
deps: KtxCliDeps;
|
|
packageInfo: KtxCliPackageInfo;
|
|
setExitCode: (code: number) => void;
|
|
runInit: (args: { projectDir: string; projectName?: string; force: boolean }, io: KtxCliIo) => Promise<number>;
|
|
writeDebug?: (command: string, commandContext: CommandWithGlobalOptions) => void;
|
|
}
|
|
|
|
export interface OutputModeOptions {
|
|
plain?: boolean;
|
|
json?: boolean;
|
|
viz?: boolean;
|
|
input?: boolean;
|
|
}
|
|
|
|
interface KtxCommanderProgramOptions {
|
|
runInit: (args: { projectDir: string; projectName?: string; force: boolean }, io: KtxCliIo) => Promise<number>;
|
|
}
|
|
|
|
type CommanderExitLike = { exitCode: number; code: string; message: string };
|
|
|
|
interface KtxGlobalOptionValues {
|
|
projectDir?: string;
|
|
debug?: boolean;
|
|
}
|
|
|
|
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),
|
|
};
|
|
}
|
|
|
|
function optionsWithGlobals(command: CommandWithGlobalOptions): KtxGlobalOptionValues {
|
|
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,
|
|
};
|
|
}
|
|
|
|
export function resolveCommandProjectDir(command: CommandWithGlobalOptions): string {
|
|
return resolveKtxProjectDir({ explicitProjectDir: optionsWithGlobals(command).projectDir });
|
|
}
|
|
|
|
export function resolveCommandProjectDirOverride(command: CommandWithGlobalOptions): string | undefined {
|
|
return optionsWithGlobals(command).projectDir ?? process.env.KTX_PROJECT_DIR;
|
|
}
|
|
|
|
function createBaseProgram(info: KtxCliPackageInfo, io: KtxCliIo): Command {
|
|
return new Command()
|
|
.name('ktx')
|
|
.description('Standalone KTX developer CLI')
|
|
.option('--project-dir <path>', 'KTX project directory (default: KTX_PROJECT_DIR, nearest ktx.yaml, or cwd)')
|
|
.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 diagnostics, scans, adapter commands, and mapping tools.\n',
|
|
)
|
|
.showHelpAfterError()
|
|
.exitOverride()
|
|
.configureOutput({
|
|
writeOut: (chunk) => io.stdout.write(chunk),
|
|
writeErr: (chunk) => io.stderr.write(chunk),
|
|
outputError: (chunk, write) => write(chunk),
|
|
});
|
|
}
|
|
|
|
function writeDebug(io: KtxCliIo, commandContext: CommandWithGlobalOptions, command: string): void {
|
|
const global = optionsWithGlobals(commandContext);
|
|
if (global.debug !== true) {
|
|
return;
|
|
}
|
|
io.stderr.write(`[debug] projectDir=${resolveCommandProjectDir(commandContext)}\n`);
|
|
io.stderr.write(`[debug] dispatch=${command}\n`);
|
|
}
|
|
|
|
function formatCliError(error: unknown): string {
|
|
return error instanceof Error ? error.message : String(error);
|
|
}
|
|
|
|
async function runBareInteractiveCommand(
|
|
program: Command,
|
|
io: KtxCliIo,
|
|
context: KtxCliCommandContext,
|
|
): Promise<number> {
|
|
const nearestProjectDir = findNearestKtxProjectDir(process.cwd());
|
|
const envProjectDir = process.env.KTX_PROJECT_DIR;
|
|
const runner = context.deps.setup ?? (await import('./setup.js')).runKtxSetup;
|
|
|
|
if (!nearestProjectDir && !envProjectDir) {
|
|
return await runner(
|
|
{
|
|
command: 'run',
|
|
projectDir: resolveKtxProjectDir(),
|
|
mode: 'auto',
|
|
agents: false,
|
|
agentScope: 'project',
|
|
agentInstallMode: 'cli',
|
|
skipAgents: false,
|
|
inputMode: 'auto',
|
|
yes: false,
|
|
cliVersion: context.packageInfo.version,
|
|
skipLlm: false,
|
|
skipEmbeddings: false,
|
|
databaseSchemas: [],
|
|
skipDatabases: false,
|
|
skipSources: false,
|
|
},
|
|
io,
|
|
);
|
|
}
|
|
|
|
program.outputHelp();
|
|
return 0;
|
|
}
|
|
|
|
export async function runCommanderKtxCli(
|
|
argv: string[],
|
|
io: KtxCliIo,
|
|
deps: KtxCliDeps,
|
|
info: KtxCliPackageInfo,
|
|
options: KtxCommanderProgramOptions,
|
|
): Promise<number> {
|
|
profileMark('commander:entry');
|
|
let exitCode = 0;
|
|
const program = createBaseProgram(info, io);
|
|
profileMark('commander:base-program');
|
|
const context: KtxCliCommandContext = {
|
|
io,
|
|
deps,
|
|
packageInfo: info,
|
|
setExitCode: (code: number) => {
|
|
exitCode = code;
|
|
},
|
|
runInit: options.runInit,
|
|
writeDebug: (command: string, commandContext: CommandWithGlobalOptions) => {
|
|
writeDebug(io, commandContext, command);
|
|
},
|
|
};
|
|
|
|
registerSetupCommands(program, context);
|
|
profileMark('commander:register-setup');
|
|
|
|
registerConnectionCommands(program, context);
|
|
profileMark('commander:register-connection');
|
|
|
|
registerPublicIngestCommands(program, context);
|
|
profileMark('commander:register-public-ingest');
|
|
|
|
registerWikiCommands(program, context);
|
|
profileMark('commander:register-wiki');
|
|
|
|
registerSlCommands(program, context);
|
|
profileMark('commander:register-sl');
|
|
|
|
registerRuntimeCommands(program, context);
|
|
profileMark('commander:register-runtime');
|
|
|
|
registerServeCommands(program, context);
|
|
profileMark('commander:register-serve');
|
|
|
|
registerStatusCommands(program, context);
|
|
profileMark('commander:register-status');
|
|
|
|
registerAgentCommands(program, context);
|
|
profileMark('commander:register-agent');
|
|
|
|
registerDevCommands(program, context);
|
|
profileMark('commander:register-dev');
|
|
|
|
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;
|
|
}
|