cli.ts•4.92 kB
/**
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ToolPluginSubCommandsSchema } from '@genkit-ai/tools-common/plugin';
import {
RunCommandEvent,
logger,
notifyAnalyticsIfFirstRun,
record,
} from '@genkit-ai/tools-common/utils';
import { Command, program } from 'commander';
import { config } from './commands/config';
import { evalExtractData } from './commands/eval-extract-data';
import { evalFlow } from './commands/eval-flow';
import { evalRun } from './commands/eval-run';
import { flowBatchRun } from './commands/flow-batch-run';
import { flowRun } from './commands/flow-run';
import { initAiTools } from './commands/init-ai-tools/index';
import { mcp } from './commands/mcp';
import { getPluginCommands, getPluginSubCommand } from './commands/plugins';
import {
SERVER_HARNESS_COMMAND,
serverHarness,
} from './commands/server-harness';
import { start } from './commands/start';
import { uiStart } from './commands/ui-start';
import { uiStop } from './commands/ui-stop';
import { detectCLIRuntime } from './utils/runtime-detector.js';
import { showUpdateNotification } from './utils/updates';
import { version } from './utils/version';
/**
* All commands need to be directly registered in this list.
*
* To add a new command to the CLI, create a file under src/commands that
* exports a Command constant, then add it to the list below
*/
const commands: Command[] = [
uiStart,
uiStop,
flowRun,
flowBatchRun,
evalExtractData,
evalRun,
evalFlow,
initAiTools,
config,
start,
mcp,
];
/** Main entry point for CLI. */
export async function startCLI(): Promise<void> {
program
.name('genkit')
.description('Genkit CLI')
.version(version)
.option('--no-update-notification', 'Do not show update notification')
.option(
'--non-interactive',
'Run in non-interactive mode. All interactions will use the default choice.'
)
.hook('preAction', async (command, actionCommand) => {
// For now only record known command names, to avoid tools plugins causing
// arbitrary text to get recorded. Once we launch tools plugins, we'll have
// to give this more thought
const commandNames = commands.map((c) => c.name());
let commandName: string;
if (commandNames.includes(actionCommand.name())) {
commandName = actionCommand.name();
} else if (
actionCommand.parent &&
commandNames.includes(actionCommand.parent.name())
) {
commandName = actionCommand.parent.name();
} else {
commandName = 'unknown';
}
if (
!process.argv.includes('--non-interactive') &&
commandName !== 'config'
) {
await notifyAnalyticsIfFirstRun();
}
const { isCompiledBinary } = detectCLIRuntime();
await record(
new RunCommandEvent(commandName, isCompiledBinary ? 'binary' : 'node')
);
});
// Check for updates and show notification if available,
// unless --no-update-notification is set
// Run this synchronously to ensure it shows before command execution
const hasNoUpdateNotification = process.argv.includes(
'--no-update-notification'
);
if (!hasNoUpdateNotification) {
try {
await showUpdateNotification();
} catch (e) {
logger.debug('Failed to show update notification', e);
// Silently ignore errors - update notifications shouldn't break the CLI
}
}
// When running as a spawned UI server process, argv[1] will be '__server-harness'
// instead of a normal command. This allows the same binary to serve both CLI and server roles.
if (process.argv[2] === SERVER_HARNESS_COMMAND) {
program.addCommand(serverHarness);
}
for (const command of commands) program.addCommand(command);
for (const command of await getPluginCommands()) program.addCommand(command);
for (const cmd of ToolPluginSubCommandsSchema.keyof().options) {
const command = await getPluginSubCommand(cmd);
if (command) {
program.addCommand(command);
}
}
program.addCommand(
new Command('help').action(() => {
logger.info(program.help());
})
);
// Handle unknown commands.
program.on('command:*', (operands) => {
logger.error(`error: unknown command '${operands[0]}'`);
logger.info(program.help());
process.exit(1);
});
await program.parseAsync();
}