hof - 高阶框架

一个统一数据模型、模式、代码生成和任务引擎的工具。

hof 是一款你可以 添加 到工作流中的 CLI 工具。

• 基于 CUE
• 确定性和代理式代码生成
• 可以演进并用于代码生成的数据模型
• 基于 cue/flow 的任务引擎
• 代理服务器和 VS Code 扩展

核心功能
代码生成	数据 + 模板 = _ (任何内容)，与技术无关
数据建模	定义、检查点和比较数据模型
任务引擎	可扩展的任务和 DAG 工作流引擎
CUE 命令	核心 def、eval、export 和 vet 命令
创建者	从任何仓库启动和入门套件
模块	CUE 模块依赖管理
TUI	Hof 和 CUE 的终端界面
聊天	结合 LLM 和 Hof 代码生成，以获得更好、可扩展的结果

hof 使用 CUE 来提升开发体验和实现。 我们认为 CUE 是一种非常适合用于定义模式、配置以及编写任何声明性内容的语言， 并且它是事实来源。它拥有良好的理论基础，并且来自那些为我们带来容器、Go 和 Kubernetes 的团队。

了解更多关于 CUE 的信息：cuelang.org | cuetorials.com

文档

请访问 docs.hofstadter.io 以了解更多信息。

在 入门 部分，你将体验一次 hof 的之旅。 在 演练 部分，你将学习如何构建和使用生成器。

加入我们或提问：

• Discord（推荐）：https://discord.com/invite/BXwX7n6B8w
• Slack：https://hofstadter-io.slack.com

我们也会使用 GitHub 的问题和讨论区。选择你觉得最方便的方式即可！

安装

你可以在我们的 GitHub 发布页面找到 最新下载。 这是推荐的方法。

如果你已经安装了 hof，可以使用 hof update --version vX.Y.Z 来安装特定版本。

# Homebrew
brew install hofstadter-io/tap/hof

# Shell 补全（bash、zsh、fish、power-shell）
echo ". <(hof completion bash)" >> $HOME/.profile
source $HOME/.profile

# 查看帮助文本或版本信息以验证安装
hof --help
hof version

项目结构

项目结构简要概述如下：

• ci/: 持续集成脚本。
• cmd/hof/: hof CLI 的主入口。
• docs/: 文档网站的源代码。
• flow/: hof flow 和任务引擎的源代码。
• lib/: hof 各子命令的核心逻辑。
• test/: hof 子命令的测试脚本和测试数据。

开发

构建 hof 二进制文件：

make build

运行测试套件：

make test

在本地运行文档网站：

make docs-serve

贡献与社区

我们非常欢迎贡献，并且社区正在不断壮大。开始参与的最佳方式是：

1. 加入我们的 Discord
2. 阅读 贡献指南
3. 寻找一个可以参与的问题。我们很乐意为你提供指导。
4. 改善文档。

当你准备好贡献时，请先 fork 仓库，然后提交 pull request。 我们采用标准的 PR 和评审流程。此外，我们还使用多种标签来帮助组织问题和 PR。

接口

hof 提供两种接口：

1. CLI - 非常适合脚本和自动化
2. TUI - 非常适合探索和设计

CLI

hof - 高阶框架

  更多信息请访问 https://docs.hofstadter.io

用法：
  hof [flags] [command] [args]

主要命令：
  chat                  与 AI 共同创作（alpha）
  create                从任何 git 仓库创建入门套件或蓝图
  datamodel             管理、比较和迁移你的数据模型
  def                   打印整合后的 CUE 定义
  eval                  评估并打印 CUE 配置
  export                将数据导出为标准格式
  flow                  运行由 CUE 驱动的工作流和任务
  fmt                   格式化任何代码并管理格式化工具
  gen                   基于 CUE 的代码生成
  mod                   CUE 模块依赖管理
  tui                   Hof 和 CUE 的终端界面
  vet                   使用 CUE 验证数据

其他命令：
  help                  关于任何命令的帮助
  update                检查新版本并自动更新
  version               打印详细的版本信息
  completion            为你的终端生成补全助手
  feedback              在 GitHub 上打开问题或讨论

标志位：
  -E, --all-errors           打印所有可用错误
  -h, --help                 hof 的帮助
  -i, --ignore-errors        关闭输出并在提示时假定默认值
  -D, --include-data         自动包含所有与 cue 文件一起找到的数据文件
  -V, --inject-env           将所有 ENV VAR 注入为默认标签变量
  -I, --input stringArray    额外的数据，用于统一到根值中
  -p, --package string       执行时使用的 Cue 包上下文
  -l, --path stringArray     CUE 表达式，用于放置数据文件时指定单个路径组件
  -q, --quiet                关闭输出并在提示时假定默认值
  -d, --schema stringArray   表达式，用于选择应用于数据文件的模式
      --stats                打印生成器统计信息
  -0, --stdin-empty          确保 stdin 为空且不阻塞的标志
  -t, --tags stringArray     要注入 CUE 代码中的 @tags()
  -v, --verbosity int        设置输出的详细程度
      --with-context         为数据文件添加额外的上下文，可用于 -l/path 标志

使用 "hof [command] --help / -h" 以获取有关某个命令的更多信息。

TUI

hof tui 是一个基于终端的 Hof 功能界面。 它内置了帮助系统和文档。以下 YouTube 视频提供了概览。

许可证

本项目采用 Apache 2.0 许可证。详情请参阅 LICENSE 文件。

Hof 快速上手指南

Hof 是一个基于 CUE 语言的高阶框架工具，旨在统一数据模型、模式定义、代码生成及任务引擎。它通过确定性的代码生成和灵活的数据建模能力，帮助开发者构建可扩展的工程体系。

环境准备

• 操作系统：支持 macOS、Linux 及 Windows（WSL 推荐）。
• 前置依赖：无需额外依赖，Hof 二进制文件已包含运行所需的所有组件。
• 网络要求：首次安装需访问 GitHub 或 Homebrew 源；国内用户若遇连接问题，可配置代理或使用镜像加速。

安装步骤

方法一：Homebrew（macOS/Linux 推荐）

brew install hofstadter-io/tap/hof

安装完成后，配置 Shell 自动补全（以 bash 为例）：

echo ". <(hof completion bash)" >> $HOME/.profile
source $HOME/.profile

方法二：手动下载（通用）

访问 GitHub Releases 下载对应平台的最新二进制文件，解压后将 hof 可执行文件移至 $PATH 目录中。

验证安装

hof --help
hof version

若输出版本信息及帮助文档，则安装成功。

基本使用

1. 初始化项目与数据模型

使用 datamodel 命令定义和管理数据模型：

mkdir my-project && cd my-project
hof datamodel init

编辑生成的 .cue 文件定义你的数据结构，例如 model.cue：

User: {
	name: string
	age: int
	email?: string
}

2. 验证与评估模型

使用 vet 验证数据是否符合模型，或使用 eval 查看合并后的配置：

# 验证数据文件 data.cue 是否符合模型
hof vet model.cue data.cue

# 评估并输出最终配置
hof eval model.cue data.cue

3. 代码生成

结合模板与数据模型生成任意语言的代码（技术栈无关）：

hof gen --template ./templates/go-server.cue --input data.cue --output ./gen

注：你需要预先编写符合 CUE 语法的模板文件。

4. 运行工作流任务

利用内置的任务引擎执行 DAG 工作流：

hof flow run ./flow/task.cue

5. 使用终端界面（TUI）

启动交互式终端界面探索项目结构与功能：

hof tui

该界面提供可视化导航、文档查阅及实时反馈，适合初学者熟悉 Hof 的核心概念。

---

更多详细教程请参考官方文档：docs.hofstadter.io
加入社区交流：Discord