@cfxdevkit/llm-tools

pnpm run llm:changeset
pnpm run llm:release
pnpm run llm:ci-cd
pnpm run llm:docs-pipeline

pnpm run llm:docs-upkeep -- --quick
pnpm run llm:docs-upkeep -- --docs-only --quick
pnpm run llm:docs-upkeep -- --scope docs/architecture --max-folders 1
pnpm run llm:docs-upkeep -- --quick --write --yes --max-folders 3

export type LlmWorker = 'llm' | 'deterministic';
export type LlmCommandName = (typeof llmCommands)[number]['name'];
export interface LlmCommandDefinition {
  name: LlmCommandName;
  description: string;
  worker: LlmWorker;
}
export declare const llmCommands: readonly [
  { name: 'llm:commit'; description: 'Run hardened commit pipeline with hotspot checks'; worker: 'deterministic' },
  { name: 'llm:docs-upkeep'; description: 'Delegate documentation upkeep to LLM'; worker: 'llm' },
  { name: 'llm:test-audit'; description: 'Audit test coverage of changed code'; worker: 'llm' },
  { name: 'llm:health'; description: 'Summarize repo health and automation gaps'; worker: 'llm' },
  { name: 'llm:validation'; description: 'Select minimal validation commands'; worker: 'llm' },
  { name: 'llm:changeset'; description: 'Generate or update Changesets'; worker: 'llm' },
  { name: 'llm:release'; description: 'Prepare and execute release'; worker: 'llm' },
  { name: 'llm:ci-cd'; description: 'Validate and update CI/CD workflows'; worker: 'llm' },
  { name: 'llm:docs-pipeline'; description: 'Build and deploy docs artifacts'; worker: 'llm' },
  { name: 'llm:all'; description: 'Run all repo upkeep agents'; worker: 'llm' },
  { name: 'llm:review'; description: 'Run LLM review agent'; worker: 'llm' }
];
export declare function findLlmCommand(name: string): LlmCommandDefinition | undefined;
export declare function runCli(): Promise<void>;
export declare const llmToolingNamespace: {
  name: string;
  description: string;
  usage: string;
};

import { findLlmCommand, llmCommands, runCli } from '@cfxdevkit/llm-tools';
 
// Find a command definition by name
const commitCmd = findLlmCommand('llm:commit');
// => { name: 'llm:commit', description: 'Run hardened commit pipeline with hotspot checks', worker: 'deterministic' }
 
// List all available commands
console.log(llmCommands);
 
// Run the CLI (typically invoked via `pnpm run llm:*`)
runCli();

import { findLlmCommand, llmCommands, LlmCommandDefinition, LlmCommandName, LlmWorker, llmToolingNamespace, runCli } from '@cfxdevkit/llm-tools';
 
// Example usage of the `findLlmCommand` function
const command = findLlmCommand('chat');
console.log(command); // Output: 'chat'
 
// Example usage of the `llmCommands` array
const commands = llmCommands;
console.log(commands); // Output: ['chat', 'generate', 'analyze']
 
// Example usage of the `LlmCommandDefinition` interface
const definition = new LlmCommandDefinition('chat', 'Chat with a model', 'chat');
console.log(definition); // Output: LlmCommandDefinition { name: 'chat', description: 'Chat with a model', usage: 'chat' }
 
// Example usage of the `LlmCommandName` enum
const name = LlmCommandName.chat;
console.log(name); // Output: chat
 
// Example usage of the `LlmWorker` class
const worker = new LlmWorker();
console.log(worker); // Output: LlmWorker { name: 'chat', description: 'Chat with a model', usage: 'chat' }
 
// Example usage of the `llmToolingNamespace` namespace
const namespace = llmToolingNamespace;
console.log(namespace); // Output: llmToolingNamespace { name: 'chat', description: 'Chat with a model', usage: 'chat' }
 
// Example usage of the `runCli` function
runCli();

// Locates a specific LLM command by its identifier.
// Returns the command name if found, otherwise `undefined`.
export { findLlmCommand }
 
// A collection of all available LLM command names.
// Contains the identifiers for supported LLM operations.
export { llmCommands }
 
// Defines the structure and metadata for an LLM command.
// Used to register or describe LLM commands with name, description, and usage.
export { LlmCommandDefinition }
 
// Enumeration of valid LLM command identifiers.
// Provides type-safe access to supported command names.
export { LlmCommandName }
 
// Orchestrates the execution of LLM-based tasks.
// Wraps command metadata and provides execution logic for LLM workflows.
export { LlmWorker }
 
// Provides a grouped namespace for LLM tooling utilities.
// Exposes shared utilities and configuration for LLM automation.
export { llmToolingNamespace }
 
// Starts the command-line interface for LLM automation.
// Parses CLI arguments and dispatches to the appropriate LLM command handler.
export { runCli }