Base AI plugin package for Fusion Framework CLI
npm install @equinor/fusion-framework-cli-plugin-ai-base> [!DANGER]
> ⚠️ INTERNAL USE ONLY
> This package provides shared utilities and options for AI CLI plugins within Equinor's Fusion Framework ecosystem. External consumers should use the higher-level AI CLI plugins instead.
Provides common functionality for AI CLI plugins to avoid code duplication:
- Shared AI command options (model, temperature, tokens, etc.)
- Fusion Framework setup with AI module configuration
- Configuration file loading and validation
- Type definitions for AI options and configuration
Used by:
- @equinor/fusion-framework-cli-plugin-ai-chat
- @equinor/fusion-framework-cli-plugin-ai-search
- @equinor/fusion-framework-cli-plugin-ai-index
Changes here affect all consuming plugins, so coordinate updates carefully.
For monorepo packages:
``json`
{
"dependencies": {
"@equinor/fusion-framework-cli-plugin-ai-base": "workspace:*"
}
}
`typescript
// Import AI options from command-options export
import { withOptions, type AiOptions, AiOptionsSchema } from '@equinor/fusion-framework-cli-plugin-ai-base/command-options';
// Import framework utilities from main export
import { setupFramework, registerAiPlugin, loadFusionAIConfig } from '@equinor/fusion-framework-cli-plugin-ai-base';
// Or import everything from main export
import {
setupFramework,
registerAiPlugin,
loadFusionAIConfig,
type FrameworkInstance,
type FusionAIConfig
} from '@equinor/fusion-framework-cli-plugin-ai-base';
`
- ./command-options - AI command options, validation schemas, and option helperswithOptions
- - Function to add AI options to a Commander commandoptions
- - Default export containing all option definitionsAiOptionsSchema
- - Zod schema for validating AI optionsAiOptionsType
- - Type inferred from the schemaAiOptions
- - TypeScript interface for AI options.
- - Main export containing:setupFramework
- - Initialize and configure Fusion Framework with AI moduleregisterAiPlugin
- - Register AI plugin commands with CLI programloadFusionAIConfig
- - Load Fusion AI configuration from fileconfigureFusionAI
- - Configuration factory functionFrameworkInstance
- - Type for initialized framework instanceFusionAIConfig
- - Base configuration interfaceLoadFusionAIConfigOptions
- - Options for loading configuration
- Build: pnpm build` (type checking only, no bundling needed)
- Changesets should be created for versioning and changelog tracking
- Breaking changes affect all consuming plugins, so coordinate updates carefully