类型定义

Hive-Mind 导出的完整 TypeScript 类型。

技能相关

SkillMeta

轻量级技能索引条目（阶段 1: 发现）。

interface SkillMeta {
  name: string;
  description: string;
  path: string;
  tags?: string[];
  xHive?: XHiveConfig;
}

SkillContent

完整技能内容（阶段 2: 激活）。

interface SkillContent extends SkillMeta {
  body: string;
  frontmatter: SkillFrontmatter;
  scripts: ScriptFile[];
  references: string[];
  assets: string[];
  linkedFiles: string[];
}

字段	说明
body	SKILL.md 的 markdown 正文（LLM 指令）
frontmatter	解析后的 frontmatter 字段
scripts	scripts/ 目录下发现的脚本文件
references	references/ 目录下发现的参考文档路径
assets	assets/ 目录下发现的静态资源路径
linkedFiles	body 中 markdown 链接指向的本地文件的绝对路径（自动提取）

SkillFrontmatter

interface SkillFrontmatter {
  name: string;
  description: string;
  compatibility?: string;
  'allowed-tools'?: string;
  metadata?: Record<string, unknown>;
  license?: string;
  'x-hive'?: Record<string, unknown>;
  [key: string]: unknown;
}

ScriptFile

interface ScriptFile {
  relativePath: string;   // e.g. "scripts/format.sh"
  absolutePath: string;
  extension: string;      // e.g. "sh", "py"
}

x-hive 扩展

XHiveConfig

interface XHiveConfig {
  agent?: boolean;
  maxSteps?: number;
  scripts?: XHiveScriptsConfig;
  models?: XHiveModelsConfig;
  workspace?: string;
}

interface XHiveScriptsConfig {
  approval?: boolean;
  timeout?: number;
  runtimes?: string[];
}

interface XHiveModelsConfig {
  preferred?: string;
  fallback?: string;
}

执行相关

RunOptions / RunResult

interface RunOptions {
  message: string;
  model?: string;
  skills?: string[];
  systemPrompt?: string;
  maxTokens?: number;
}

interface RunResult {
  text: string;
  activatedSkills: string[];
  toolCalls: ToolCallRecord[];
  usage?: {
    promptTokens: number;
    completionTokens: number;
    totalTokens: number;
  };
}

StreamOptions

interface StreamOptions extends RunOptions {
  onToolCall?: (toolName: string, args: Record<string, unknown>) => void;
  onScriptOutput?: (output: ScriptOutput) => void;
}

ToolCallRecord

interface ToolCallRecord {
  toolName: string;
  args: Record<string, unknown>;
  result: unknown;
}

脚本执行

ScriptOutput

interface ScriptOutput {
  exitCode: number;
  stdout: string;
  stderr: string;
}

RuntimeInfo / RuntimeStatus

interface RuntimeInfo {
  name: string;
  command: string;
  version: string;
  available: boolean;
}

interface RuntimeStatus {
  [runtime: string]: RuntimeInfo & {
    tools?: Record<string, boolean>;
  };
}

安全

SecurityLevel

type SecurityLevel = 'basic' | 'strict' | 'sandbox';

SandboxPermissions

interface SandboxPermissions {
  fs?: { read?: string[]; write?: string[] };
  net?: boolean;
  env?: string[];
  childProcess?: boolean;
}

Logger

interface Logger {
  debug(message: string, ...args: unknown[]): void;
  info(message: string, ...args: unknown[]): void;
  warn(message: string, ...args: unknown[]): void;
  error(message: string, ...args: unknown[]): void;
}