hof - the higher order framework

A tool that unifies data models, schemas, code generation, and a task engine.

hof is a CLI tool you add to your workflow.

• Foundation in CUE
• Deterministic and Agentic code generation
• Data models that can evolve and be input to code generation
• Task engine based on cue/flow
• Agent servers and VS Code extension

hof uses CUE to power the DX and implementation. We believe CUE is a great language for specifying schemas, configuration, and generally for writing anything declarative or this is a source of truth. It has good theory and comes from the same people that brought us containers, Go, and Kubernetes.

Learn more about CUE: cuelang.org | cuetorials.com

Documentation

Please see docs.hofstadter.io to learn more.

The getting-started section will take you on a tour of hof. The the-walkthrough section shows you how to build and use a generator.

Join us or ask questions on

• Discord (preferred): https://discord.com/invite/BXwX7n6B8w
• Slack: https://hofstadter-io.slack.com

We also use GitHub issues and discussions. Use which every is easiest for you!

Installation

You can find the latest downloads on our GitHub releases page. This is the preferred method.

If you already have hof, install a specific version with hof update --version vX.Y.Z.

# Homebrew
brew install hofstadter-io/tap/hof

# Shell Completions (bash, zsh, fish, power-shell)
echo ". <(hof completion bash)" >> $HOME/.profile
source $HOME/.profile

# Show the help text or version info to verify installation
hof --help
hof version

Project Structure

A brief overview of the project structure:

• ci/: Continuous integration scripts.
• cmd/hof/: The main entrypoint for the hof CLI.
• docs/: The source code for the documentation website.
• flow/: The source for hof flow and the task engine.
• lib/: Core logic for hof's various subcommands.
• test/: Testscripts and testdata for hof's subcommands.

Development

To build the hof binary:

make build

To run the test suite:

make test

To run the docs website locally:

make docs-serve

Contributing & Community

We are happy to accept contributions and have a growing community. The best ways to get started are

1. Joining our Discord
2. Reading The Contributing Guild
3. Finding an issue to work on. We are happy to guide you.
4. Improving the documentation.

When you are ready to contribute, please fork the repo and submit a pull request. We use a standard PR and review process. We also have a number of labels to help organize issues and PRs.

Interfaces

There are two interfaces to hof

1. a CLI - great for scripting and automation
2. a TUI - great for exploring and designing

cli

hof - the higher order framework

  Learn more at https://docs.hofstadter.io

Usage:
  hof [flags] [command] [args]

Main commands:
  chat                  co-create with AI (alpha)
  create                starter kits or blueprints from any git repo
  datamodel             manage, diff, and migrate your data models
  def                   print consolidated CUE definitions
  eval                  evaluate and print CUE configuration
  export                output data in a standard format
  flow                  run workflows and tasks powered by CUE
  fmt                   format any code and manage the formatters
  gen                   CUE powered code generation
  mod                   CUE module dependency management
  tui                   a terminal interface to Hof and CUE
  vet                   validate data with CUE

Additional commands:
  help                  help about any command
  update                check for new versions and run self-updates
  version               print detailed version information
  completion            generate completion helpers for your terminal
  feedback              open an issue or discussion on GitHub

Flags:
  -E, --all-errors           print all available errors
  -h, --help                 help for hof
  -i, --ignore-errors        turn off output and assume defaults at prompts
  -D, --include-data         auto include all data files found with cue files
  -V, --inject-env           inject all ENV VARs as default tag vars
  -I, --input stringArray    extra data to unify into the root value
  -p, --package string       the Cue package context to use during execution
  -l, --path stringArray     CUE expression for single path component when placing data files
  -q, --quiet                turn off output and assume defaults at prompts
  -d, --schema stringArray   expression to select schema to apply to data files
      --stats                print generator statistics
  -0, --stdin-empty          A flag that ensure stdin is zero and does not block
  -t, --tags stringArray     @tags() to be injected into CUE code
  -v, --verbosity int        set the verbosity of output
      --with-context         add extra context for data files, usable in the -l/path flag

Use "hof [command] --help / -h" for more information about a command.

tui

The hof tui is a terminal based interface to Hof's features. It has a built in help system and documentation. The following YouTube video provides a tour.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.