mirror of
https://github.com/AutoMaker-Org/automaker.git
synced 2026-02-03 08:53:36 +00:00
Merge main into massive-terminal-upgrade
Resolves merge conflicts: - apps/server/src/routes/terminal/common.ts: Keep randomBytes import, use @automaker/utils for createLogger - apps/ui/eslint.config.mjs: Use main's explicit globals list with XMLHttpRequest and MediaQueryListEvent additions - apps/ui/src/components/views/terminal-view.tsx: Keep our terminal improvements (killAllSessions, beforeunload, better error handling) - apps/ui/src/config/terminal-themes.ts: Keep our search highlight colors for all themes - apps/ui/src/store/app-store.ts: Keep our terminal settings persistence improvements (merge function) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
135
libs/model-resolver/README.md
Normal file
135
libs/model-resolver/README.md
Normal file
@@ -0,0 +1,135 @@
|
||||
# @automaker/model-resolver
|
||||
|
||||
Claude model resolution and mapping utilities.
|
||||
|
||||
## Overview
|
||||
|
||||
This package handles Claude model resolution, converting user-friendly aliases to actual Claude model identifiers and providing default model configurations.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @automaker/model-resolver
|
||||
```
|
||||
|
||||
## Exports
|
||||
|
||||
### Model Resolution
|
||||
|
||||
Convert model aliases to full model identifiers.
|
||||
|
||||
```typescript
|
||||
import { resolveModelString, DEFAULT_MODELS } from '@automaker/model-resolver';
|
||||
import { CLAUDE_MODEL_MAP } from '@automaker/types';
|
||||
|
||||
// Resolve model string
|
||||
const model = resolveModelString('sonnet');
|
||||
// Returns: 'claude-sonnet-4-20250514'
|
||||
|
||||
const model2 = resolveModelString('haiku');
|
||||
// Returns: 'claude-haiku-4-5'
|
||||
|
||||
const model3 = resolveModelString('opus');
|
||||
// Returns: 'claude-opus-4-5-20251101'
|
||||
|
||||
// Use with custom default
|
||||
const model4 = resolveModelString(undefined, 'claude-sonnet-4-20250514');
|
||||
// Returns: 'claude-sonnet-4-20250514' (default)
|
||||
|
||||
// Direct model ID passthrough
|
||||
const model5 = resolveModelString('claude-opus-4-5-20251101');
|
||||
// Returns: 'claude-opus-4-5-20251101' (unchanged)
|
||||
```
|
||||
|
||||
### Get Effective Model
|
||||
|
||||
Get the actual model that will be used.
|
||||
|
||||
```typescript
|
||||
import { getEffectiveModel } from '@automaker/model-resolver';
|
||||
|
||||
// Get effective model with fallback chain
|
||||
const model = getEffectiveModel({
|
||||
requestedModel: 'sonnet',
|
||||
featureModel: undefined,
|
||||
defaultModel: 'claude-sonnet-4-20250514',
|
||||
});
|
||||
```
|
||||
|
||||
### Model Constants
|
||||
|
||||
Access model mappings and defaults.
|
||||
|
||||
```typescript
|
||||
import { DEFAULT_MODELS } from '@automaker/model-resolver';
|
||||
import { CLAUDE_MODEL_MAP } from '@automaker/types';
|
||||
|
||||
// Default models for different contexts
|
||||
console.log(DEFAULT_MODELS.claude); // 'claude-sonnet-4-20250514'
|
||||
console.log(DEFAULT_MODELS.autoMode); // 'claude-sonnet-4-20250514'
|
||||
console.log(DEFAULT_MODELS.chat); // 'claude-sonnet-4-20250514'
|
||||
|
||||
// Model alias mappings
|
||||
console.log(CLAUDE_MODEL_MAP.haiku); // 'claude-haiku-4-5'
|
||||
console.log(CLAUDE_MODEL_MAP.sonnet); // 'claude-sonnet-4-20250514'
|
||||
console.log(CLAUDE_MODEL_MAP.opus); // 'claude-opus-4-5-20251101'
|
||||
```
|
||||
|
||||
## Usage Example
|
||||
|
||||
```typescript
|
||||
import { resolveModelString, DEFAULT_MODELS } from '@automaker/model-resolver';
|
||||
import type { Feature } from '@automaker/types';
|
||||
|
||||
function prepareFeatureExecution(feature: Feature) {
|
||||
// Resolve model from feature or use default
|
||||
const model = resolveModelString(feature.model, DEFAULT_MODELS.autoMode);
|
||||
|
||||
console.log(`Executing feature with model: ${model}`);
|
||||
|
||||
return {
|
||||
featureId: feature.id,
|
||||
model,
|
||||
// ... other options
|
||||
};
|
||||
}
|
||||
|
||||
// Example usage
|
||||
const feature: Feature = {
|
||||
id: 'auth-feature',
|
||||
category: 'backend',
|
||||
description: 'Add authentication',
|
||||
model: 'opus', // User-friendly alias
|
||||
};
|
||||
|
||||
prepareFeatureExecution(feature);
|
||||
// Output: Executing feature with model: claude-opus-4-5-20251101
|
||||
```
|
||||
|
||||
## Supported Models
|
||||
|
||||
### Current Model Aliases
|
||||
|
||||
- `haiku` → `claude-haiku-4-5`
|
||||
- `sonnet` → `claude-sonnet-4-20250514`
|
||||
- `opus` → `claude-opus-4-5-20251101`
|
||||
|
||||
### Model Selection Guide
|
||||
|
||||
- **Haiku**: Fast responses, simple tasks, lower cost
|
||||
- **Sonnet**: Balanced performance, most tasks (recommended default)
|
||||
- **Opus**: Maximum capability, complex reasoning, highest cost
|
||||
|
||||
## Dependencies
|
||||
|
||||
- `@automaker/types` - Model type definitions and constants
|
||||
|
||||
## Used By
|
||||
|
||||
- `@automaker/server` - Feature execution, agent chat, enhancement
|
||||
|
||||
## Notes
|
||||
|
||||
- Model strings that don't match aliases are passed through unchanged
|
||||
- This allows direct use of specific model versions like `claude-sonnet-4-20250514`
|
||||
- Always falls back to a sensible default if no model is specified
|
||||
Reference in New Issue
Block a user